Skip to content

Commit

Permalink
V251t omaster (#742)
Browse files Browse the repository at this point in the history
* change to 2.5.0

* change to 2.5.0

* Delete header.html

* Update README.md

* Update README.md

* fix format

* fix () punctuation

* Update 2.deploy-dashboard.md

* Update ex-ug-page-overview.md

* Update ex-ug-deploy.md

* Update ex-ug-deploy.md

* upgrade nebula graph to 250 (#677)

* the package name is Schrodinger

* Fix punctuation issues (#678)

* update eco tools and metrics (#680)

* commit id

* commit id

* Update README.md

* Update README.md

* Update mkdocs.yml (#682)

* Delete ex-ug-terms.md

* repair links (#681)

* update

* repair-links (#683)

* Update ex-ug-parameter.md (#684)

* Update 1.query-performance-metrics.md

* proofread

* proofread

* Update st-ug-connect.md

* update metrics formats (#685)

* Update 2.graph-modeling.md

* Update st-ug-explore.md

* Update 3.system-design.md

* Update st-ug-crud-tag.md

* Update st-ug-crud-edge-type.md

* Update st-ug-crud-index.md

* Create st-ug-crud-index.md

* Update st-ug-crud-index.md

* Update st-ug-open-in-explore.md

* update

* Update st-ug-visualize-subgraph.md

* Update st-ug-faq.md

* Update 2.deploy-dashboard.md

* Update 2.deploy-dashboard.md

* proofread 2

* Update 2.deploy-dashboard.md

* Create 2.deploy-dashboard.md

* Update ex-ug-page-overview.md

* Update 3.graph-config.md

* Update ex-ug-page-overview.md

* Fix titles (#687)

* Update upgrade-nebula-from-200-to-250.md

* Update upgrade-nebula-from-200-to-250.md

* Update upgrade-nebula-from-200-to-250.md

* Update upgrade-nebula-from-200-to-250.md

* Update ex-ug-connect.md

* Update ex-ug-page-overview.md

* Update 6.list.md

* Update 3.deploy-listener.md

* Update 1.search-with-text-based-index.md

* fix

* Update 4.job-statements.md

* math

* Update 2.match.md (#688)

* update (#689)

* Update st-ug-console.md

* Update source_install-nebula-graph-by-rpm-or-deb.md

* Update source_connect-to-nebula-graph.md

* Update source_manage-service.md

* Update 3.deploy-nebula-graph-with-docker-compose.md

* Update upgrade-nebula-graph-to-250.md

* Update (#691)

* update

* update

* Upgrade dashboard (#692)

* Delete search.html (#676)

* upgrade dashboard

Co-authored-by: min.wu <[email protected]>

* Upgrade vid (#693)

* Delete search.html (#676)

* Update 3.vid.md

Co-authored-by: min.wu <[email protected]>

* Update 3.vid.md

* Update source_connect-to-nebula-graph.md

* Update 5.lookup.md

* Update mkdocs.yml

* Create 6.delete-tag.md

* Update mkdocs.yml

* Update 4.storage-service.md

* Update ex-ug-what-is-explorer.md

* Update ex-ug-deploy.md

* Update mkdocs.yml

* Update mkdocs.yml

* Update requirements.txt

* Update mkdocs.yml

* Update mkdocs.yml

* Cherrypick 250 (#723)

* add cn doc (#708)

* add cn doc

* concat and show meta leader

* Update 13.concat.md

Co-authored-by: 朱晓青 <[email protected]>

* ldap and improve query by tag index (#711)

* ldap and improve query by tag index

* Update improve-query-by-tag-index.md

* Update 4.ldap.md

Co-authored-by: cooper-lzy <[email protected]>

* Add day mode and night mode (#732)

* Update mkdocs.yml

* Update use-importer.md

* Update 1.search-with-text-based-index.md (#741)

fixed CREATE FULLTEXT

* Update README.md

* Update deploy.yml

* Update mkdocs.yml

* Update deploy.yml

* Update deploy.yml

* Update README.md

* Update releasenote.md

* update master

Co-authored-by: foesa <[email protected]>
Co-authored-by: [email protected] <[email protected]>
Co-authored-by: randomJoe211 <[email protected]>
Co-authored-by: cooper-lzy <[email protected]>
Co-authored-by: Wey Gu <[email protected]>
  • Loading branch information
6 people authored Sep 23, 2021
1 parent 5135b62 commit e6062f9
Show file tree
Hide file tree
Showing 21 changed files with 65 additions and 209 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ jobs:
- name: Git Config
run: git config user.name whitewum && git config user.email [email protected]

- name: mike list delete
- name: Mike Deploy
run: |
mike list
Expand Down
17 changes: 7 additions & 10 deletions docs-2.0/1.introduction/3.vid.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,19 +48,16 @@ VIDs can be generated via applications. Here are some tips:

The data type of VIDs must be defined when you [create the graph space](../3.ngql-guide/9.space-statements/1.create-space.md). Once defined, it cannot be modified.

<!--
## "查询起始点"(`start vid`)与全局扫描
## Query `start vid` and global scan

绝大多数情况下,Nebula Graph 的查询语句(`MATCH`, `GO`, `LOOKUP`)的执行计划,必须要通过一定方式找到查询起始点的 VID (`start vid`)。
In most cases, the execution plan of query statements in Nebula Graph (`MATCH`, `GO`, and `LOOKUP`) must query the `start vid` in a certain way.

定位 `start vid` 只有两种方式:
There are only two ways to locate `start vid`:

1. 例如 `GO FROM "player100" OVER` 是在语句中显式的指明 `start vid` "player100";
1. For example, `GO FROM "player100" OVER` explicitly indicates in the statement that `start vid` is "player100".

2. 例如, `LOOKUP ON player WHERE player.name == "Tony Parker"` 或者 `MATCH (v:player {name:"Tony Parker"}) `,是通过属性 `player.name` 的索引来定位到 `start vid`
2. For example, `LOOKUP ON player WHERE player.name == "Tony Parker"` or `MATCH (v:player {name:"Tony Parker"})` locates `start vid` by the index of the property `player.name`.

!!! Caution "You cannot perform a global scan without `start vid`"

!!! caution 不能在没有 `start vid` 情况下进行全局扫描;
例如 `match (n) return n;` 会返回错误,因为此时无法定位到 `start vid`;这是一个全局扫描,因此被禁止。
-->
For example, `match (n) return n;` returns an error because `start vid` cannot be located at this time. As a global scan, it is forbidden.
6 changes: 5 additions & 1 deletion docs-2.0/20.appendix/0.FAQ.md
Original file line number Diff line number Diff line change
Expand Up @@ -255,7 +255,11 @@ Nebula Graph uses [glog](https://github.com/google/glog) to print logs. `glog` c

### "How to check the Nebula Graph version?"

If the service is running, run the command `SHOW HOSTS META` in `nebula-console`. See [SHOW HOSTS](../3.ngql-guide/7.general-query-statements/6.show/6.show-hosts.md).
If the service is running: run command `SHOW HOSTS META` in `nebula-console`. See [SHOW HOSTS](../3.ngql-guide/7.general-query-statements/6.show/6.show-hosts.md).

If the service is not running:

Different installation methods make the method of checking the version different. The instructions are as follows:

If the service is not running, run the command `./<binary_name> --version` to get the version and the Git commit IDs of the Nebula Graph binary files. For example:

Expand Down
69 changes: 2 additions & 67 deletions docs-2.0/20.appendix/releasenote.md
Original file line number Diff line number Diff line change
@@ -1,72 +1,7 @@
# Nebula Graph {{ nebula.release }} release notes

## Feature

- Support management of session. [#280](https://github.com/vesoft-inc/nebula-graph/pull/280)
- Support terminate the slow queries, know issue: there is a delay in querying and terminating the query due to the implementation. [#1152](https://github.com/vesoft-inc/nebula-graph/pull/1152)
- Enhance the ability to extract the indices from expressions for the `LOOKUP` statement. [#1188](https://github.com/vesoft-inc/nebula-graph/pull/1188)
- Supports configuring machine memory watermarks to alleviate OOM issues to some extent. [1067](https://github.com/vesoft-inc/nebula-graph/pull/1067)
- Support filter the edges in the `FindPath` statement. [#1091](https://github.com/vesoft-inc/nebula-graph/pull/1091)
- Support return structure of a graph without properties in the `Subgraph` statement.[#1134](https://github.com/vesoft-inc/nebula-graph/pull/1134)
- Improve the usage of the `timestamp` function. [#515](https://github.com/vesoft-inc/nebula-common/pull/515)
- Support for querying the version of each service. [#944](https://github.com/vesoft-inc/nebula-graph/pull/944)
- `Index` and `TTL` can be supported together. [#382](https://github.com/vesoft-inc/nebula-storage/pull/382)
- Support the creation of full-text indexes on specified properties. [#460](https://github.com/vesoft-inc/nebula-storage/pull/460)
- Support make comment when create space or schema. [#895](https://github.com/vesoft-inc/nebula-graph/pull/895)
- Support for full-text index rebuild. [#1123](https://github.com/vesoft-inc/nebula-graph/pull/1123)

## Enhancement

- The Listener interface is optimized to support full data acquisition. [#465](https://github.com/vesoft-inc/nebula-storage/pull/465), [#484](https://github.com/vesoft-inc/nebula-storage/pull/484)
- The leader table of the meta is reorganized. [#439](https://github.com/vesoft-inc/nebula-storage/pull/439)
- Add a DiskManager to check disk capacity. [#461](https://github.com/vesoft-inc/nebula-storage/pull/461)
- Improve heartbeat of raft to avoid leader change. [#438](https://github.com/vesoft-inc/nebula-storage/pull/438)
- Support concurrently go/fetch/lookup in storage. [#503](https://github.com/vesoft-inc/nebula-storage/pull/503)
- Enhanced for the `EXISTS` function to the `MAP`. [#973](https://github.com/vesoft-inc/nebula-graph/pull/973)
- Enforce the use of aggregate functions, such as `COUNT(v)+AVG(v)`. [#968](https://github.com/vesoft-inc/nebula-graph/pull/968)

## Bug fix

- Fixed multiple statement execution problems caused by permissions. [#1165](https://github.com/vesoft-inc/nebula-graph/pull/1165)
- Fixed unwinding causing no results. [#1018](https://github.com/vesoft-inc/nebula-graph/pull/1018)
- Fixed crash problems caused by aggregation functions in some scenarios. [#1015](https://github.com/vesoft-inc/nebula-graph/pull/1015)
- Fixed index matching problems with `OR` expressions. [#1005](https://github.com/vesoft-inc/nebula-graph/pull/1005)
- Fixed case sensitivity of functions. [#927](https://github.com/vesoft-inc/nebula-graph/issues/927)
- Fixed issue where query index creation information was not checked for Tag/Edge type. [#933](https://github.com/vesoft-inc/nebula-graph/pull/933)
- Fixed a bug in the `Substring` function. [#491](https://github.com/vesoft-inc/nebula-common/pull/491)
- Fixed meta not returning leader change correctly. [#423](https://github.com/vesoft-inc/nebula-storage/pull/423)
- Fixed an issue with `LIMIT`, `ORDER`, `GROUP` statements using variables. [#1314](https://github.com/vesoft-inc/nebula-graph/pull/1314)
- Fixed issue with the `db_dump` tool printing VID of the `int` type. [#533](https://github.com/vesoft-inc/nebula-storage/pull/533)
- Fixed the issue that `FAILE` is still displayed after the `Balance` task is recovered. [#528](https://github.com/vesoft-inc/nebula-storage/pull/528)

## Changes & Known issues

- A little bit grammar change of Subgraph.

```ngql
# Add the WITH PROP keyword to the output property in {{ nebula.release }}.
GET SUBGRAPH WITH PROP FROM <vids>
# The original syntax will only output the graph structure without properties.
GET SUBGRAPH FROM <vids>#
```
- We must use the symbol `$-.` in `ORDER BY`. But in earlier releases, there is no need.
```ngql
# We must use the symbol `$-.` in `ORDER BY` in {{ nebula.release }}.
nebula> LOOKUP ON player \
YIELD player.age As playerage \
| GROUP BY $-.playerage \
YIELD $-.playerage as age, count(*) AS number \
| ORDER BY $-.number DESC, $-.age DESC;
# There is no need to use the symbol `$-.` in earlier releases.
nebula> LOOKUP ON player \
YIELD player.age As playerage \
| GROUP BY $-.playerage \
YIELD $-.playerage as age, count(*) AS number \
| ORDER BY number DESC, age DESC;
```
- Fixed the performance reduction problems caused by the sessions will update at the next upload period when use space. [#1355](https://github.com/vesoft-inc/nebula-graph/pull/1355)

For the known bug/issue in {{ nebula.release }}, see [issues](https://github.com/vesoft-inc/nebula-graph/issues).
- Fixed the performance problems of k8s caused by processing logic of the remote address in connection requests. [#615](https://github.com/vesoft-inc/nebula-common/pull/615)
2 changes: 1 addition & 1 deletion docs-2.0/3.ngql-guide/10.tag-statements/6.delete-tag.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

!!! enterpriseonly

This feature is supported by the Enterprise Edition only.
This feature is only available in the Enterprise Edition.

A vertex can have one or more tags.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ A natural language search interprets the search string as a phrase in natural hu
### Create full-text indexes

```ngql
CREATE {TAG | EDGE} INDEX <index_name> ON {<tag_name> | <edge_name>} ([<prop_name_list>]);
CREATE FULLTEXT {TAG | EDGE} INDEX <index_name> ON {<tag_name> | <edge_name>} ([<prop_name_list>]);
```

### Show full-text indexes
Expand Down
2 changes: 1 addition & 1 deletion docs-2.0/8.service-tuning/3.system-design.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Nebula Graph {{ nebula.release }} supports horizontal scaling.

+ Metad does not support horizontal scaling.

Vertical scaling usually has higher hardware costs and relatively simple operations. Nebula Graph {{nebula.release}} can also be scaled vertically.
Vertical scaling usually has higher hardware costs, but relatively simple operations. Nebula Graph {{nebula.release}} can also be scaled vertically.

## Data transmission and optimization

Expand Down
1 change: 1 addition & 0 deletions docs-2.0/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,3 +66,4 @@ This manual has over 80 compatibilities and corresponding tips.
## Modify errors

This Nebula Graph manual is written in the Markdown language. Users can click the pencil sign on the upper right side of each document title and modify errors.
-->
2 changes: 1 addition & 1 deletion docs-2.0/nebula-dashboard/1.what-is-dashboard.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Dashboard monitors:

- The information of clusters, including the information of services, partitions, configurations, and long-term tasks.

Features of the enterprise package (TODO: planning)
- Features of the enterprise package (TODO: planning)

!!! enterpriseonly

Expand Down
14 changes: 7 additions & 7 deletions docs-2.0/nebula-dashboard/2.deploy-dashboard.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ The correspondence between the Dashboard release and the Nebula Graph release is

|Dashboard|Nebula Graph|
|:---|:---|
|{{dashboard.release}}|2.5.0, 2.0.1|
|{{dashboard.release}}|2.x|

## Port

Expand All @@ -26,12 +26,11 @@ The deployment of Dashboard occupies the following ports:

## Download Dashboard

Download the configuration files for the deployment.
Download the tar package as needed, and it is recommended to select the latest version.

| Dashboard tar-package | Nebula Graph version |
| Dashboard package | Nebula Graph version |
| :----- | :----- |
| [nebula-graph-dashboard-{{ dashboard.release }}.x86_64.tar.gz](https://oss-cdn.nebula-graph.io/nebula-graph-dashboard/{{ dashboard.release }}/nebula-graph-dashboard-{{ dashboard.release }}.x86_64.tar.gz) | 2.5.0 |

| [nebula-graph-dashboard-{{ dashboard.release }}.x86_64.tar.gz](https://oss-cdn.nebula-graph.com.cn/nebula-graph-dashboard/{{ dashboard.release }}/nebula-graph-dashboard-{{ dashboard.release }}.x86_64.tar.gz) | v{{nebula.release}} |

## Service

Expand All @@ -58,7 +57,7 @@ The above five services should be deployed as follows.
To start the service, run the following statement in `node-exporter`:

```bash
$ nohup ./node-exporter --web.listen-address=:9100 &
$ nohup ./node-exporter --web.listen-address=":9100" &
```

After the service is started, you can enter `<IP>:9100` in the browser to check whether the service is started normally.
Expand Down Expand Up @@ -106,7 +105,7 @@ After the service is started, you can enter `<IP>:9100` in the browser to check
2. Run the following statement to start the service:

```bash
$ nohup ./nebula-stats-exporter --bare-metal --bare-metal-config=./config.yaml &
$ nohup ./nebula-stats-exporter --listen-address=":9200" --bare-metal --bare-metal-config=./config.yaml &
```

After the service is started, you can enter `<IP>:9200` in the browser to check whether the service is started normally.
Expand All @@ -128,6 +127,7 @@ After the service is started, you can enter `<IP>:9200` in the browser to check
static_configs:
- targets: [
'192.168.xx.100:9200', # The IP address and port of the nebula-stats-exporter service.
'192.168.xx.101:9200'
]
- job_name: 'node-exporter'
static_configs:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@ Nebula Explorer (Explorer in short) is a browser-based visualization tool. It is
!!! enterpriseonly

Explorer is only available in the enterprise version.

!!! Note

You can also try some functions online in [Explorer](https://explorer.nebula-graph.io/).

!!! Note

Expand Down Expand Up @@ -33,4 +37,4 @@ Explorer has these features:

Authentication is not enabled in Nebula Graph by default. Users can log into Studio with the `root` account and any password.

When Nebula Graph enables authentication, users can only sign into Studio with the specified account. For more information, see [Authentication](../../7.data-security/1.authentication/1.authentication.md).
When Nebula Graph enables authentication, users can only sign into Studio with the specified account. For more information, see [Authentication](../../7.data-security/1.authentication/1.authentication.md).
16 changes: 7 additions & 9 deletions docs-2.0/nebula-studio/manage-schema/st-ug-crud-edge-type.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Operate edge types

After a graph space is created in Nebula Graph, you can create edge types. With Studio, you can choose to use the **Console** page or the **Schema** page to create, retrieve, update, or delete edge types. This article only introduces how to use the **Schema** page to operate edge types in a graph space.
After a graph space is created in Nebula Graph, you can create edge types. With Studio, you can choose to use the **Console** page or the **Schema** page to create, retrieve, update, or delete edge types. This topic introduces how to use the **Schema** page to operate edge types in a graph space only.

## Studio version

Expand Down Expand Up @@ -28,27 +28,25 @@ To create an edge type on the **Schema** page, follow these steps:

5. On the **Create** page, do these settings:

a. **Name**: Specify an appropriate name for the edge type. In this example, `serve` is used.
- **Name**: Specify an appropriate name for the edge type. In this example, `serve` is used.

b. (Optional) If necessary, under the name, click the **Comment** to input content.
- (Optional) If necessary, under the name, click the **Comment** to input content.

c. (Optional) If necessary, in the upper left corner of the **Define Properties** panel, click the check box to expand the panel and do these settings:
- (Optional) If necessary, in the upper left corner of the **Define Properties** panel, click the check box to expand the panel and do these settings:

- To define a property: Enter a property name, a data type, and a default value.

- To add multiple properties: Click the **Add Property** button and define more properties.

- To cancel a defined property: Besides the **Defaults** column, click the button ![Icon of deletion](https://docs-cdn.nebula-graph.com.cn/nebula-studio-docs/st-ug-020.png "Cancel").
- To delete a defined property: Besides the **Defaults** column, click the button ![Icon of deletion](https://docs-cdn.nebula-graph.com.cn/nebula-studio-docs/st-ug-020.png "Cancel").

d. (Optional) If no index is set for the edge type, you can set the TTL configuration: In the upper left corner of the **Set TTL** panel, click the check box to expand the panel, and configure `TTL_COL` and `TTL_ DURATION`. For more information about both parameters, see [TTL configuration](../../3.ngql-guide/8.clauses-and-options/ttl-options.md "Click to go to Nebula Graph website").
- (Optional) If no index is set for the edge type, you can set the TTL configuration: In the upper left corner of the **Set TTL** panel, click the check box to expand the panel, and configure `TTL_COL` and `TTL_ DURATION`. For more information about both parameters, see [TTL configuration](../../3.ngql-guide/8.clauses-and-options/ttl-options.md "Click to go to Nebula Graph website").

6. When the preceding settings are completed, in the **Equivalent to the following nGQL statement** panel, you can see the nGQL statement equivalent to these settings.

![Define properties of the `action` edge type](../figs/st-ug-027-1.png "Define an edge type")

7. Confirm the settings and then click the **+ Create** button.

When the edge type is created successfully, the **Define Properties** panel shows all its properties on the list.
7. Confirm the settings and then click the **+ Create** button. When the edge type is created successfully, the **Define Properties** panel shows all its properties on the list.

## Edit an edge type

Expand Down
5 changes: 2 additions & 3 deletions docs-2.0/nebula-studio/manage-schema/st-ug-crud-index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Operate Indexes

You can create an index for a Tag and/or an Edge type. An index lets traversal start from vertices or edges with the same property and it can make a query more efficient. You can create two index types: Tag Index and Edge type Index. With Studio, you can use the **Console** page or the **Schema** page to create, retrieve, and delete indexes. This article introduces how to use the **Schema** page to operate an index.
You can create an index for a Tag and/or an Edge type. An index lets traversal start from vertices or edges with the same property and it can make a query more efficient. You can create two index types: Tag Index and Edge type Index. With Studio, you can use the **Console** page or the **Schema** page to create, retrieve, and delete indexes. This topic introduces how to use the **Schema** page to operate an index only.

!!! note

Expand Down Expand Up @@ -46,8 +46,7 @@ To create an index on the **Schema** page, follow these steps:

![A page for index creation](https://docs-cdn.nebula-graph.com.cn/nebula-studio-docs/st-ug-030.png "Create an index")

7. Confirm the settings and then click the **+ Create** button.
When an index is created, the index list shows the new index.
7. Confirm the settings and then click the **+ Create** button. When an index is created, the index list shows the new index.

## View indexes

Expand Down
Loading

0 comments on commit e6062f9

Please sign in to comment.