From aa5f136393b4ed80af7ad24d047382dab17faaaa Mon Sep 17 00:00:00 2001 From: foesa <35463247+foesa-yang@users.noreply.github.com> Date: Wed, 2 Nov 2022 14:27:04 +0800 Subject: [PATCH 01/89] Merge to v3.3.0 --- .github/workflows/deploy.yml | 9 +++-- docs-2.0/stylesheets/extra.css | 8 ++-- mkdocs.yml | 6 +-- overrides/partials/header.html | 74 ---------------------------------- 4 files changed, 12 insertions(+), 85 deletions(-) delete mode 100644 overrides/partials/header.html diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml index 59e16da6c14..7b66318b10d 100644 --- a/.github/workflows/deploy.yml +++ b/.github/workflows/deploy.yml @@ -3,7 +3,7 @@ on: push: branches: # Remember to add v before the following version number unless the version is master. - - master + - v3.3.0 jobs: deploy: @@ -25,12 +25,13 @@ jobs: - name: Git Config run: git config user.name whitewum && git config user.email min.wu@vesoft.com - - name: Mike Deploy master + - name: Mike Deploy 3.3.0 run: | - # mike delete master -p + # mike delete 3.3.0 -p git fetch origin gh-pages --depth=1 # fix mike's CI update mike list - mike deploy master -p --rebase + mike deploy v3.3.0 -p --rebase + mike set-default 3.2.1 -p --rebase mike list # - name: Deploy diff --git a/docs-2.0/stylesheets/extra.css b/docs-2.0/stylesheets/extra.css index 7680955d283..5581d5b2e38 100644 --- a/docs-2.0/stylesheets/extra.css +++ b/docs-2.0/stylesheets/extra.css @@ -4,14 +4,14 @@ /* nebula dark */ :root{ - --md-primary-fg-color:#a27e7e; /* Tar bar color*/ - --md-accent-fg-color: #FA8072; /* Selected color */ + --md-primary-fg-color:#6b2e38; /* Tar bar color*/ + --md-accent-fg-color: #f04949; /* Selected color */ } /* nebula light */ [data-md-color-scheme="nebula"]{ - --md-primary-fg-color: #FF0000; /* Tar bar color */ - --md-accent-fg-color: #49BDF0; /* Selected color */ + --md-primary-fg-color: #C65467; /* Tar bar color */ + --md-accent-fg-color: #bb7d7c; /* Selected color */ --md-code-fg-color: rgb(12, 21, 26); --md-code-bg-color: #eaebec; diff --git a/mkdocs.yml b/mkdocs.yml index ae1be0c43c5..1f779415773 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -9,7 +9,7 @@ repo_url: 'https://github.com/vesoft-inc/nebula-docs' copyright: Copyright © 2022 NebulaGraph # modify -edit_uri: 'edit/master/docs-2.0/' +edit_uri: 'edit/v3.3.0/docs-2.0/' theme: name: material @@ -60,7 +60,7 @@ markdown_extensions: # Plugins plugins: - - search # 这个是原有的 mkdocs 搜索插件， 如果想使用algolia搜索，请注释掉这个插件 + # - search # 这个是原有的 mkdocs 搜索插件， 如果想使用algolia搜索，请注释掉这个插件 - macros: include_dir: docs-2.0/reuse/ - git-revision-date-localized @@ -98,7 +98,7 @@ plugins: - with-pdf: copyright: 2022 Vesoft Inc. - cover_subtitle: master + cover_subtitle: 3.3.0 author: Min Wu, Yao Zhou, Cooper Liang, Foesa Yang, Abby Huang cover: true back_cover: true diff --git a/overrides/partials/header.html b/overrides/partials/header.html deleted file mode 100644 index adb60a1dc5d..00000000000 --- a/overrides/partials/header.html +++ /dev/null @@ -1,74 +0,0 @@ -
- -
From 712dc4350cb28620b4f32bf35ed824ff7b2bf32d Mon Sep 17 00:00:00 2001 From: foesa <35463247+foesa-yang@users.noreply.github.com> Date: Wed, 2 Nov 2022 15:33:22 +0800 Subject: [PATCH 02/89] Update deploy.yml --- .github/workflows/deploy.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml index 7b66318b10d..40dd8f93838 100644 --- a/.github/workflows/deploy.yml +++ b/.github/workflows/deploy.yml @@ -30,8 +30,8 @@ jobs: # mike delete 3.3.0 -p git fetch origin gh-pages --depth=1 # fix mike's CI update mike list - mike deploy v3.3.0 -p --rebase - mike set-default 3.2.1 -p --rebase + mike deploy 3.3.0 -p --rebase + mike set-default 3.3.0 -p --rebase mike list # - name: Deploy From 54e9f0a44d9d5f2180e58d6f2d074b7ca08b64fa Mon Sep 17 00:00:00 2001 From: foesa <35463247+foesa-yang@users.noreply.github.com> Date: Wed, 2 Nov 2022 16:23:50 +0800 Subject: [PATCH 03/89] Update deploy.yml --- .github/workflows/deploy.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml index 40dd8f93838..1cd11ee9f2e 100644 --- a/.github/workflows/deploy.yml +++ b/.github/workflows/deploy.yml @@ -30,6 +30,7 @@ jobs: # mike delete 3.3.0 -p git fetch origin gh-pages --depth=1 # fix mike's CI update mike list + mike delete v3.3.0 -p mike deploy 3.3.0 -p --rebase mike set-default 3.3.0 -p --rebase mike list From 0721ceccab75035bd04c463ee53ed0301f123d83 Mon Sep 17 00:00:00 2001 From: "abby.huang" <78209557+abby-cyber@users.noreply.github.com> Date: Wed, 2 Nov 2022 16:37:19 +0800 Subject: [PATCH 04/89] Update 0.FAQ.md (#1738) --- docs-2.0/20.appendix/0.FAQ.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs-2.0/20.appendix/0.FAQ.md b/docs-2.0/20.appendix/0.FAQ.md index ce656c8f9ff..eb8597e5209 100644 --- a/docs-2.0/20.appendix/0.FAQ.md +++ b/docs-2.0/20.appendix/0.FAQ.md @@ -166,7 +166,7 @@ The reason for this error may be that the amount of data to be queried is too la - When importing data, set [Compaction](../8.service-tuning/compaction.md) manually to make read faster. -- Extend the RPC connection timeout of the Graph service and the Storage service. Modify the value of `--storage_client_timeout_ms` in the `nebula-storaged.conf` file. This configuration is measured in milliseconds (ms). The default value is 60000ms. +- Extend the RPC connection timeout of the Graph service and the Storage service. Modify the value of `--storage_client_timeout_ms` in the `nebula-graphd.conf` file. This configuration is measured in milliseconds (ms). The default value is 60000ms. ### "How to resolve the error `MetaClient.cpp:65] Heartbeat failed, status:Wrong cluster!` in `nebula-storaged.INFO`, or `HBProcessor.cpp:54] Reject wrong cluster host "x.x.x.x":9771!` in `nebula-metad.INFO`?" From f7d61e8af13c19ce83340ca5a181e674fad6de40 Mon Sep 17 00:00:00 2001 From: foesa <35463247+foesa-yang@users.noreply.github.com> Date: Wed, 2 Nov 2022 17:10:17 +0800 Subject: [PATCH 05/89] Update deploy.yml --- .github/workflows/deploy.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml index 1cd11ee9f2e..40dd8f93838 100644 --- a/.github/workflows/deploy.yml +++ b/.github/workflows/deploy.yml @@ -30,7 +30,6 @@ jobs: # mike delete 3.3.0 -p git fetch origin gh-pages --depth=1 # fix mike's CI update mike list - mike delete v3.3.0 -p mike deploy 3.3.0 -p --rebase mike set-default 3.3.0 -p --rebase mike list From 85a12fc2d4846fc68e443d0cebe9b30a154af907 Mon Sep 17 00:00:00 2001 From: foesa <35463247+foesa-yang@users.noreply.github.com> Date: Wed, 2 Nov 2022 17:38:04 +0800 Subject: [PATCH 06/89] Update deploy.yml --- .github/workflows/deploy.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml index 40dd8f93838..75f7e618e53 100644 --- a/.github/workflows/deploy.yml +++ b/.github/workflows/deploy.yml @@ -29,7 +29,6 @@ jobs: run: | # mike delete 3.3.0 -p git fetch origin gh-pages --depth=1 # fix mike's CI update - mike list mike deploy 3.3.0 -p --rebase mike set-default 3.3.0 -p --rebase mike list From 122378146b6dfc7a10003c64274ba684d1ec377e Mon Sep 17 00:00:00 2001 From: cooper-lzy <78672629+cooper-lzy@users.noreply.github.com> Date: Thu, 3 Nov 2022 09:36:39 +0800 Subject: [PATCH 07/89] Update deploy.yml --- .github/workflows/deploy.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml index 75f7e618e53..a9df8333072 100644 --- a/.github/workflows/deploy.yml +++ b/.github/workflows/deploy.yml @@ -11,7 +11,7 @@ jobs: steps: - uses: actions/checkout@v2 with: - fetch-depth: 0 # fetch all commits/branches for gitversion + fetch-depth: 1 # fetch all commits/branches for gitversion - name: Setup Python uses: actions/setup-python@v1 From f578234a423cd64aef939c877628723d15419067 Mon Sep 17 00:00:00 2001 From: randomJoe211 <69501902+randomJoe211@users.noreply.github.com> Date: Thu, 3 Nov 2022 11:02:13 +0800 Subject: [PATCH 08/89] Fix favicon --- mkdocs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/mkdocs.yml b/mkdocs.yml index 1f779415773..04a5f925b54 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -15,7 +15,7 @@ theme: name: material custom_dir: overrides logo: 'https://cloud-cdn.nebula-graph.com.cn/vesoft-nebula-logo-white.png' - favicon: 'assets/images/favicon.ico' + favicon: 'https://docs-cdn.nebula-graph.com.cn/figures/favicon.ico' palette: - scheme: nebula toggle: From 72d146784a78bfbd45229e0c4f8d536e52719d90 Mon Sep 17 00:00:00 2001 From: Jerry Liang <8124783+nianiaJR@users.noreply.github.com> Date: Thu, 3 Nov 2022 11:11:42 +0800 Subject: [PATCH 09/89] fix: missing file causing doc search issue (#1740) --- overrides/partials/header.html | 74 ++++++++++++++++++++++++++++++++++ 1 file changed, 74 insertions(+) create mode 100644 overrides/partials/header.html diff --git a/overrides/partials/header.html b/overrides/partials/header.html new file mode 100644 index 00000000000..adb60a1dc5d --- /dev/null +++ b/overrides/partials/header.html @@ -0,0 +1,74 @@ +
+ +
From 8734534bef8383a573073bff5272404de83aae73 Mon Sep 17 00:00:00 2001 From: cooper-lzy <78672629+cooper-lzy@users.noreply.github.com> Date: Thu, 3 Nov 2022 13:56:56 +0800 Subject: [PATCH 10/89] Update 2.deploy-dashboard.md --- docs-2.0/nebula-dashboard/2.deploy-dashboard.md | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/docs-2.0/nebula-dashboard/2.deploy-dashboard.md b/docs-2.0/nebula-dashboard/2.deploy-dashboard.md index d2320fb5797..9067db78dc0 100644 --- a/docs-2.0/nebula-dashboard/2.deploy-dashboard.md +++ b/docs-2.0/nebula-dashboard/2.deploy-dashboard.md @@ -24,11 +24,7 @@ Before you deploy Dashboard, you must confirm that: ## Download Dashboard -Download the tar package as needed, and it is recommended to select the latest version. - -| Dashboard package | NebulaGraph version | -| :----- | :----- | -| [nebula-dashboard-{{ dashboard.release }}.x86_64.tar.gz](https://oss-cdn.nebula-graph.com.cn/nebula-graph-dashboard/{{ dashboard.release }}/nebula-dashboard-{{ dashboard.release }}.x86_64.tar.gz) | 2.5.x~3.1.0 | +Download the tar package[nebula-dashboard-{{ dashboard.release }}.x86_64.tar.gz](https://oss-cdn.nebula-graph.com.cn/nebula-graph-dashboard/{{ dashboard.release }}/nebula-dashboard-{{ dashboard.release }}.x86_64.tar.gz) as needed. ## Services From 4fc659ca2d765e09f83fb8238360e87b0cd563ec Mon Sep 17 00:00:00 2001 From: cooper-lzy <78672629+cooper-lzy@users.noreply.github.com> Date: Thu, 3 Nov 2022 13:57:48 +0800 Subject: [PATCH 11/89] Update 4.use-dashboard.md --- docs-2.0/nebula-dashboard/4.use-dashboard.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs-2.0/nebula-dashboard/4.use-dashboard.md b/docs-2.0/nebula-dashboard/4.use-dashboard.md index 9f7e00e26ef..fd03a4e9eb7 100644 --- a/docs-2.0/nebula-dashboard/4.use-dashboard.md +++ b/docs-2.0/nebula-dashboard/4.use-dashboard.md @@ -4,7 +4,7 @@ NebulaGraph Dashboard consists of three parts: Machine, Service, and Management. ## Overview -![Overview](https://docs-cdn.nebula-graph.com.cn/figures/overview1-220922-en.png) +![Overview](https://docs-cdn.nebula-graph.com.cn/figures/overview1-221103-en.png) ## Machine @@ -17,6 +17,7 @@ On this page, you can view the variation of CPU, Memory, Load, Disk, and Network - By default, the monitoring information page will not be updated automatically. You can set the update frequency of the monitoring information page globally or click the ![setup](https://docs-cdn.nebula-graph.com.cn/figures/refresh-220616.png) button to update the page manually. - To set a base line, click the ![setup](https://docs-cdn.nebula-graph.com.cn/figures/Setup.png) button. - To view the detailed monitoring information, click the ![watch](https://docs-cdn.nebula-graph.com.cn/figures/watch.png) button. In this example, select `Load` for details. The figure is as follows. + ![load](https://docs-cdn.nebula-graph.com.cn/figures/ds-load-220913-en.png) - You can set the monitoring time range, instance, update frequency and base line. @@ -39,6 +40,7 @@ On this page, you can view the information of Graph, Meta, and Storage services - By default, the monitoring information page will not be updated automatically. You can set the update frequency of the monitoring information page globally or click the ![setup](https://docs-cdn.nebula-graph.com.cn/figures/refresh-220616.png) button to update the page manually. - You can view the status of all the services in a cluster. - To view the detailed monitoring information, click the ![watch](https://docs-cdn.nebula-graph.com.cn/figures/watch.png) button. In this example, select `Graph` for details. The figure is as follows. + ![service](https://docs-cdn.nebula-graph.com.cn/figures/ds-graph-220913-en.png) - You can set the monitoring time range, instance, update frequency, period, aggregation and base line. From e18ad89a4dfc6058e6c9917d6354061c04889b60 Mon Sep 17 00:00:00 2001 From: cooper-lzy <78672629+cooper-lzy@users.noreply.github.com> Date: Thu, 3 Nov 2022 16:01:45 +0800 Subject: [PATCH 12/89] Update ex-ug-deploy.md --- docs-2.0/nebula-explorer/deploy-connect/ex-ug-deploy.md | 6 ------ 1 file changed, 6 deletions(-) diff --git a/docs-2.0/nebula-explorer/deploy-connect/ex-ug-deploy.md b/docs-2.0/nebula-explorer/deploy-connect/ex-ug-deploy.md index 2fcdfb86d98..a4bc76dbfdb 100644 --- a/docs-2.0/nebula-explorer/deploy-connect/ex-ug-deploy.md +++ b/docs-2.0/nebula-explorer/deploy-connect/ex-ug-deploy.md @@ -222,12 +222,6 @@ Dag Controller is a task scheduling tool that can schedule the jobs which type i The Dag Controller can perform complex graph computing with NebulaGraph Analytics. For example, the Dag Controller sends an algorithm request to NebulaGraph Analytics, which saves the result to NebulaGraph or HDFS. The Dag Controller then takes the result as input to the next algorithmic task to create a new task. -### Prerequisites - -- The [HDFS](https://hadoop.apache.org/docs/stable/hadoop-project-dist/hadoop-common/ClusterSetup.html) 2.2.x or later has been deployed. - -- The JDK 1.8 has been deployed. - ### Steps 1. Complete the SSH password-free configurations so that the Dag Controller machine can log directly into the NebulaGraph Analytics machines and all machines within the NebulaGraph Analytics cluster can connect directly to each other without passwords. From 7ff55793b0bbbe426d878d4b67703eb243174614 Mon Sep 17 00:00:00 2001 From: cooper-lzy <78672629+cooper-lzy@users.noreply.github.com> Date: Thu, 3 Nov 2022 16:02:08 +0800 Subject: [PATCH 13/89] Update nebula-analytics.md --- docs-2.0/graph-computing/nebula-analytics.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs-2.0/graph-computing/nebula-analytics.md b/docs-2.0/graph-computing/nebula-analytics.md index 3bc670f6e76..3b85b770d90 100644 --- a/docs-2.0/graph-computing/nebula-analytics.md +++ b/docs-2.0/graph-computing/nebula-analytics.md @@ -5,8 +5,13 @@ NebulaGraph Analytics is a high-performance graph computing framework tool that ## Prerequisites - The NebulaGraph Analytics installation package has been obtained. [Contact us](https://www.nebula-graph.io/contact) to apply. + - The [license](analytics-ent-license.md) is ready. +- The [HDFS](https://hadoop.apache.org/docs/stable/hadoop-project-dist/hadoop-common/ClusterSetup.html) 2.2.x or later has been deployed. + +- The JDK 1.8 has been deployed. + ## Scenarios You can import data from data sources as NebulaGraph clusters, CSV files on HDFS, or local CSV files into NebulaGraph Analytics and export the graph computation results to NebulaGraph clusters, CSV files on HDFS, or local CSV files from NebulaGraph Analytics. From 01797e329d6683668db1f15dcae3acc45c9dcd2e Mon Sep 17 00:00:00 2001 From: cooper-lzy <78672629+cooper-lzy@users.noreply.github.com> Date: Thu, 3 Nov 2022 17:36:42 +0800 Subject: [PATCH 14/89] Update ex-ug-connect.md --- docs-2.0/nebula-explorer/deploy-connect/ex-ug-connect.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs-2.0/nebula-explorer/deploy-connect/ex-ug-connect.md b/docs-2.0/nebula-explorer/deploy-connect/ex-ug-connect.md index 4e0332638ad..1611cd877c4 100644 --- a/docs-2.0/nebula-explorer/deploy-connect/ex-ug-connect.md +++ b/docs-2.0/nebula-explorer/deploy-connect/ex-ug-connect.md @@ -53,7 +53,8 @@ To connect Explorer to NebulaGraph, follow these steps: !!! note - When NebulaGraph and Explorer are deployed on the same machine, you must enter the IP address of the machine, but not `127.0.0.1` or `localhost`, in the **Host** field. + - When NebulaGraph and Explorer are deployed on the same machine, you must enter the IP address of the machine, but not `127.0.0.1` or `localhost`, in the **Host** field. + - When connecting a NebulaGraph database on a new tab, The new session will overwrite the sessions of the old TAB. If you need to log in to multiple NebulaGraph databases at the same time, you can use different browsers or non-trace mode. - **Username** and **Password**: Fill in the log in account according to the [authentication settings](../../7.data-security/1.authentication/1.authentication.md) of NebulaGraph. From d8919d64f00bc3223ad8bf4240652fb9d62bbc37 Mon Sep 17 00:00:00 2001 From: cooper-lzy <78672629+cooper-lzy@users.noreply.github.com> Date: Thu, 3 Nov 2022 17:42:36 +0800 Subject: [PATCH 15/89] Update nebula-analytics.md --- docs-2.0/graph-computing/nebula-analytics.md | 23 ++++++++++++++++---- 1 file changed, 19 insertions(+), 4 deletions(-) diff --git a/docs-2.0/graph-computing/nebula-analytics.md b/docs-2.0/graph-computing/nebula-analytics.md index 3b85b770d90..1871b11b523 100644 --- a/docs-2.0/graph-computing/nebula-analytics.md +++ b/docs-2.0/graph-computing/nebula-analytics.md @@ -62,13 +62,28 @@ NebulaGraph Analytics supports the following graph algorithms. ## Install NebulaGraph Analytics -1. When installing a cluster of multiple NebulaGraph Analytics on multiple nodes, you need to install NebulaGraph Analytics to the same path and set up SSH-free login between nodes. +1. Install the NebulaGraph Analytics. - ```bash - sudo rpm -i nebula-analytics-{{plato.release}}-centos.x86_64.rpm --prefix /home/xxx/nebula-analytics + ``` + sudo rpm -ivh --prefix + sudo chown : -R + ``` + + For example: + + ``` + sudo rpm -ivh nebula-analytics-{{plato.release}}-centos.x86_64.rpm --prefix=/home/vesoft/nebula-analytics + sudo chown vesoft:vesoft -R /home/vesoft/nebula-analytics + ``` + +2. Configure the correct Hadoop path and JDK path in the file `set_env.sh`, the file path is `nebula-analytics/scripts/set_env.sh`. If there are multiple machines, ensure that the paths are the same. + + ``` + export HADOOP_HOME= + export JAVA_HOME= ``` -2. Copy the license into the directory `scripts` of the NebulaGraph Analytics installation path on all machines. +3. Copy the license into the directory `scripts` of the NebulaGraph Analytics installation path on all machines. -For more information about the preceding statements, see[User management](../../7.data-security/1.authentication/2.management-user.md) +For more information about the preceding statements, see [User management](../../7.data-security/1.authentication/2.management-user.md). +--> ## Browser From 0b5190c51d7980e94a88b59c8e31b20b743803c5 Mon Sep 17 00:00:00 2001 From: "abby.huang" <78209557+abby-cyber@users.noreply.github.com> Date: Tue, 8 Nov 2022 11:13:48 +0800 Subject: [PATCH 23/89] add-note-for-multiple-data-storage-directories- (#1741) --- .../3.1create-cluster-with-kubectl.md | 9 +++++++-- .../8.custom-cluster-configurations/8.2.pv-reclaim.md | 2 ++ .../8.3.balance-data-when-scaling-storage.md | 2 ++ docs-2.0/nebula-operator/9.upgrade-nebula-cluster.md | 2 ++ 4 files changed, 13 insertions(+), 2 deletions(-) diff --git a/docs-2.0/nebula-operator/3.deploy-nebula-graph-cluster/3.1create-cluster-with-kubectl.md b/docs-2.0/nebula-operator/3.deploy-nebula-graph-cluster/3.1create-cluster-with-kubectl.md index 894fda2ec9c..760d97aacd0 100644 --- a/docs-2.0/nebula-operator/3.deploy-nebula-graph-cluster/3.1create-cluster-with-kubectl.md +++ b/docs-2.0/nebula-operator/3.deploy-nebula-graph-cluster/3.1create-cluster-with-kubectl.md @@ -82,13 +82,15 @@ The following example shows how to create a NebulaGraph cluster by creating a cl requests: storage: 2Gi storageClassName: fast-disks - dataVolumeClaims: + dataVolumeClaims: // You can mount multiple disks starting from NebulaGraph Operator 1.3.0. - resources: requests: storage: 2Gi + storageClassName: fast-disks - resources: requests: storage: 2Gi + storageClassName: fast-disks enableAutoBalance: true reference: name: statefulsets.apps @@ -168,7 +170,8 @@ The following example shows how to create a NebulaGraph cluster by creating a cl | `spec.storaged.replicas` | `3` | The numeric value of replicas of the Storaged service. | | `spec.storaged.images` | `vesoft/nebula-storaged` | The container image of the Storaged service. | | `spec.storaged.version` | `{{nebula.tag}}` | The version of the Storaged service. | - | `spec.storaged.dataVolumeClaims.resources.requests.storage` | - | Data disk storage size for the Storaged service. You can specify multiple data disks to store data. | + | `spec.storaged.dataVolumeClaims.resources.requests.storage` | - | Data disk storage size for the Storaged service. You can specify multiple data disks to store data. When multiple disks are specified, the storage path is `/usr/local/nebula/data1`, `/usr/local/nebula/data2`, etc.| + | `spec.storaged.dataVolumeClaims.resources.storageClassName` | - | The data disk storage configurations for Storaged. If not specified, the global storage parameter is applied. | | `spec.storaged.logVolumeClaim.storageClassName`|- | The log disk storage configurations for the Storaged service.| | `spec.storaged.enableAutoBalance` | `true` |Whether to balance data automatically. | | `spec.reference.name` | - | The name of the dependent controller. | @@ -258,9 +261,11 @@ The following shows how to scale out a NebulaGraph cluster by changing the numbe - resources: requests: storage: 2Gi + storageClassName: fast-disks - resources: requests: storage: 2Gi + storageClassName: fast-disks logVolumeClaim: resources: requests: diff --git a/docs-2.0/nebula-operator/8.custom-cluster-configurations/8.2.pv-reclaim.md b/docs-2.0/nebula-operator/8.custom-cluster-configurations/8.2.pv-reclaim.md index 6ac769e7170..ee93d59aab0 100644 --- a/docs-2.0/nebula-operator/8.custom-cluster-configurations/8.2.pv-reclaim.md +++ b/docs-2.0/nebula-operator/8.custom-cluster-configurations/8.2.pv-reclaim.md @@ -78,9 +78,11 @@ The following example uses a cluster named `nebula` and the cluster's configurat - resources: requests: storage: 2Gi + storageClassName: fast-disks - resources: requests: storage: 2Gi + storageClassName: fast-disks image: vesoft/nebula-storaged logVolumeClaim: resources: diff --git a/docs-2.0/nebula-operator/8.custom-cluster-configurations/8.3.balance-data-when-scaling-storage.md b/docs-2.0/nebula-operator/8.custom-cluster-configurations/8.3.balance-data-when-scaling-storage.md index 5f8b08c5ee5..2b41e8ed539 100644 --- a/docs-2.0/nebula-operator/8.custom-cluster-configurations/8.3.balance-data-when-scaling-storage.md +++ b/docs-2.0/nebula-operator/8.custom-cluster-configurations/8.3.balance-data-when-scaling-storage.md @@ -82,9 +82,11 @@ The following example uses a cluster named `nebula` and the cluster's configurat - resources: requests: storage: 2Gi + storageClassName: fast-disks - resources: requests: storage: 2Gi + storageClassName: fast-disks image: vesoft/nebula-storaged logVolumeClaim: resources: diff --git a/docs-2.0/nebula-operator/9.upgrade-nebula-cluster.md b/docs-2.0/nebula-operator/9.upgrade-nebula-cluster.md index 22be039d037..ac697b3aff1 100644 --- a/docs-2.0/nebula-operator/9.upgrade-nebula-cluster.md +++ b/docs-2.0/nebula-operator/9.upgrade-nebula-cluster.md @@ -108,9 +108,11 @@ The version of the NebulaGraph cluster to be upgraded in this topic is `{{operat - resources: requests: storage: 2Gi + storageClassName: fast-disks - resources: requests: storage: 2Gi + storageClassName: fast-disks logVolumeClaim: resources: requests: From 7273d91cfc80e8640f6a448fc81b343e83eb4297 Mon Sep 17 00:00:00 2001 From: cooper-lzy <78672629+cooper-lzy@users.noreply.github.com> Date: Wed, 9 Nov 2022 11:10:26 +0800 Subject: [PATCH 24/89] Update 0.FAQ.md --- docs-2.0/20.appendix/0.FAQ.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs-2.0/20.appendix/0.FAQ.md b/docs-2.0/20.appendix/0.FAQ.md index eb8597e5209..efc9628652f 100644 --- a/docs-2.0/20.appendix/0.FAQ.md +++ b/docs-2.0/20.appendix/0.FAQ.md @@ -388,9 +388,9 @@ If you have not modified the predefined ports in the [Configurations](../5.confi | Service | Port | |---------|---------------------------| -| Meta | 9559, 9560, 19559, 19560 | -| Graph | 9669, 19669, 19670 | -| Storage | 9777 ~ 9780, 19779, 19780 | +| Meta | 9559, 9560, 19559 | +| Graph | 9669, 19669 | +| Storage | 9777 ~ 9780, 19779| If you have customized the configuration files and changed the predefined ports, find the port numbers in your configuration files and open them on the firewalls. From ef9c74c319b5a7b45123c80e6982a28f219caf5c Mon Sep 17 00:00:00 2001 From: "abby.huang" <78209557+abby-cyber@users.noreply.github.com> Date: Wed, 9 Nov 2022 15:20:15 +0800 Subject: [PATCH 25/89] Update mkdocs.yml (#1747) --- mkdocs.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/mkdocs.yml b/mkdocs.yml index 04a5f925b54..654f36fe46b 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -198,9 +198,9 @@ extra: tag: v3.2.0 branch: release-3.2 console: - release: 3.3.0 + release: 3.3.1 branch: release-3.3 - tag: v3.3.0 + tag: v3.3.1 br: release: 0.6.1 branch: master From 48d69d6b716168685261a63f7ca24f25376a538a Mon Sep 17 00:00:00 2001 From: "abby.huang" <78209557+abby-cyber@users.noreply.github.com> Date: Wed, 9 Nov 2022 15:38:50 +0800 Subject: [PATCH 26/89] Update 6.eco-tool-version.md (#1748) --- docs-2.0/20.appendix/6.eco-tool-version.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/docs-2.0/20.appendix/6.eco-tool-version.md b/docs-2.0/20.appendix/6.eco-tool-version.md index 900f714da10..c7a8ab3b092 100644 --- a/docs-2.0/20.appendix/6.eco-tool-version.md +++ b/docs-2.0/20.appendix/6.eco-tool-version.md @@ -146,6 +146,18 @@ Docker Compose can quickly deploy NebulaGraph clusters. For how to use it, pleas |:---|:---| | {{ nebula.tag }} | {{br.tag}}| + +{{ent.ent_begin}} +## Backup & Restore Enterprise Edition + +Backup Restore (BR for short) Enterprise Edition is a Command-Line Interface (CLI) tool. With BR Enterprise Edition, you can back up and restore NebulaGraph Enterprise Edition data. + +|NebulaGraph version|BR version| +|:---|:---| +| {{ nebula.tag }} | {{br_ent.tag}}| + +{{ent.ent_end}} + ## NebulaGraph Bench [NebulaGraph Bench](https://github.com/vesoft-inc/nebula-bench/releases/tag/{{bench.tag}}) is used to test the baseline performance data of NebulaGraph. It uses the standard data set of LDBC. From 2d84c5a6bc640c327d69e7c83382b0514363c0b2 Mon Sep 17 00:00:00 2001 From: cooper-lzy <78672629+cooper-lzy@users.noreply.github.com> Date: Thu, 10 Nov 2022 10:02:50 +0800 Subject: [PATCH 27/89] update dashboard and explorer (#1749) --- .../{cluster-information => operator}/backup-and-restore.md | 2 +- .../4.cluster-operator/operator/version-upgrade.md | 2 +- docs-2.0/nebula-explorer/ex-ug-page-overview.md | 1 + mkdocs.yml | 2 +- 4 files changed, 4 insertions(+), 3 deletions(-) rename docs-2.0/nebula-dashboard-ent/4.cluster-operator/{cluster-information => operator}/backup-and-restore.md (99%) diff --git a/docs-2.0/nebula-dashboard-ent/4.cluster-operator/cluster-information/backup-and-restore.md b/docs-2.0/nebula-dashboard-ent/4.cluster-operator/operator/backup-and-restore.md similarity index 99% rename from docs-2.0/nebula-dashboard-ent/4.cluster-operator/cluster-information/backup-and-restore.md rename to docs-2.0/nebula-dashboard-ent/4.cluster-operator/operator/backup-and-restore.md index efafc11d260..6226a7c870a 100644 --- a/docs-2.0/nebula-dashboard-ent/4.cluster-operator/cluster-information/backup-and-restore.md +++ b/docs-2.0/nebula-dashboard-ent/4.cluster-operator/operator/backup-and-restore.md @@ -28,7 +28,7 @@ To prevent data loss due to operational errors or system failures, NebulaGraph o 1. In the top navigation bar, click **Cluster Management**. 2. On the right side of the target cluster, click **Detail**. -3. In the left navigation bar, click **Information**->**Backup&Restore**. +3. In the left navigation bar, click **Operation**->**Backup&Restore**. ### Back up data diff --git a/docs-2.0/nebula-dashboard-ent/4.cluster-operator/operator/version-upgrade.md b/docs-2.0/nebula-dashboard-ent/4.cluster-operator/operator/version-upgrade.md index 154bc208e7e..921c4c98578 100644 --- a/docs-2.0/nebula-dashboard-ent/4.cluster-operator/operator/version-upgrade.md +++ b/docs-2.0/nebula-dashboard-ent/4.cluster-operator/operator/version-upgrade.md @@ -10,7 +10,7 @@ NebulaGraph Dashboard Enterprise Edition supports upgrading the version of the e !!! note - - Only supports upgrading the NebulaGraph cluster that version greater than **3.0.0**. + - Only supports upgrading the NebulaGraph cluster that version greater than **3.0.0** to the version equal to or lower than **3.2.1**. To upgrade to **3.3.0**, see [manual upgrade](../../..//4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-from-300-to-latest.md). - Do not support upgrading clusters across the major version. - The community edition can be upgraded to the enterprise edition by uploading and verifying licenses, and the enterprise edition can be upgraded to the community edition. - The cluster can be upgraded to a minor version in the current major version, including a smaller version than the current minor version. diff --git a/docs-2.0/nebula-explorer/ex-ug-page-overview.md b/docs-2.0/nebula-explorer/ex-ug-page-overview.md index c0ef5b7f877..cce2d8c523a 100644 --- a/docs-2.0/nebula-explorer/ex-ug-page-overview.md +++ b/docs-2.0/nebula-explorer/ex-ug-page-overview.md @@ -13,6 +13,7 @@ The NebulaGraph Explorer page consists of three modules top navigation bar, left | **Explorer** | Visually explore and analyze data. For more information, see [Start querying](graph-explorer/ex-ug-query-exploration.md), [Vertex Filter](graph-explorer/node-filtering.md), [Graph exploration](graph-explorer/ex-ug-graph-exploration.md) and [Graph algorithm](graph-explorer/graph-algorithm.md). | | **Visual Query** | Visually construct scenarios for data queries. For more information, see [Visual Query](12.query-visually.md). | | **Workflow** | Visually construct custom workflows for complex graph computing. For more information, see [Workflow overview](workflow/workflows.md). | +| ![Schema_drafting](https://docs-cdn.nebula-graph.com.cn/figures/schema_drafting_221110.png) | Users can design their schemas on the canvas to visually display the relationships between vertices and edges. For more information, see [Schema drafting](db-management/draft.md). | | ![create_schema](https://docs-cdn.nebula-graph.com.cn/figures/studio-nav-schema.png) | Manage NebulaGraph database graph spaces. For more information, see [Create a schema](db-management/10.create-schema.md). | | ![import_data](https://docs-cdn.nebula-graph.com.cn/figures/studio-btn-download.png) | Bulk import of data into NebulaGraph. For more information, see [Import data](db-management/11.import-data.md). | | ![Console](https://docs-cdn.nebula-graph.com.cn/figures/nav-console2.png) | Query the NebulaGraph data with nGQL statements. For more information, see [Console](db-management/explorer-console.md). | diff --git a/mkdocs.yml b/mkdocs.yml index 654f36fe46b..94a2ce7716f 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -578,7 +578,6 @@ nav: - Information overview: nebula-dashboard-ent/4.cluster-operator/cluster-information/overview-info.md - Cluster diagnostics: nebula-dashboard-ent/4.cluster-operator/cluster-information/cluster-diagnosis.md # - Job management: nebula-dashboard-ent/4.cluster-operator/cluster-information/job-management.md - - Backup and restore: nebula-dashboard-ent/4.cluster-operator/cluster-information/backup-and-restore.md - Operation: - Node: nebula-dashboard-ent/4.cluster-operator/operator/node.md - Scale: nebula-dashboard-ent/4.cluster-operator/operator/scale.md @@ -586,6 +585,7 @@ nav: - Update config: nebula-dashboard-ent/4.cluster-operator/operator/update-config.md - Member management: nebula-dashboard-ent/4.cluster-operator/operator/member-management.md - Version upgrade: nebula-dashboard-ent/4.cluster-operator/operator/version-upgrade.md + - Backup and restore: nebula-dashboard-ent/4.cluster-operator/operator/backup-and-restore.md - Operation records: nebula-dashboard-ent/4.cluster-operator/5.operation-record.md - Other settings: nebula-dashboard-ent/4.cluster-operator/6.settings.md - Authority management: nebula-dashboard-ent/5.account-management.md From ef8517d75677670a87be021d609706c35d31a675 Mon Sep 17 00:00:00 2001 From: cooper-lzy <78672629+cooper-lzy@users.noreply.github.com> Date: Thu, 10 Nov 2022 11:08:52 +0800 Subject: [PATCH 28/89] Update ex-ug-what-is-exchange.md (#1750) --- .../about-exchange/ex-ug-what-is-exchange.md | 33 +++++++++++++------ 1 file changed, 23 insertions(+), 10 deletions(-) diff --git a/docs-2.0/nebula-exchange/about-exchange/ex-ug-what-is-exchange.md b/docs-2.0/nebula-exchange/about-exchange/ex-ug-what-is-exchange.md index 1191796b56c..3a0c0bca54f 100644 --- a/docs-2.0/nebula-exchange/about-exchange/ex-ug-what-is-exchange.md +++ b/docs-2.0/nebula-exchange/about-exchange/ex-ug-what-is-exchange.md @@ -52,16 +52,29 @@ Exchange has the following advantages: ## Version compatibility -The correspondence between the NebulaGraph Exchange release (the JAR version) and the NebulaGraph core release is as follows. - -|NebulaGraph |Exchange client | -|:---|:---| -|nightly |3.0-SNAPSHOT| -|3.0.0 ~ 3.3.0 |3.3.0 | -|3.0.0 ~ 3.2.x |3.0.0 | -|2.6.x |2.6.x | -|2.5.x |2.5.x | -|2.0.0、2.0.1|2.1.0、2.0.1、2.0.0| +The correspondence between the NebulaGraph Exchange version (the JAR version), the NebulaGraph core version and the Spark version is as follows. + +| Exchange version | NebulaGraph version | Spark version | +|:----------|:-----------|:-------| +|nebula-exchange_spark_3.0-3.0-SNAPSHOT.jar| nightly |3.3.x、3.2.x、3.1.x、3.0.x | +|nebula-exchange_spark_2.4-3.0-SNAPSHOT.jar| nightly |2.4.x | +|nebula-exchange_spark_2.2-3.0-SNAPSHOT.jar| nightly |2.2.x | +|nebula-exchange_spark_3.0-3.3.0.jar | 3.x.x |3.3.x、3.2.x、3.1.x、3.0.x| +|nebula-exchange_spark_2.4-3.3.0.jar | 3.x.x |2.4.x | +|nebula-exchange_spark_2.2-3.3.0.jar | 3.x.x |2.2.x | +|nebula-exchange_spark_3.0-3.0.0.jar | 3.x.x |3.3.x、3.2.x、3.1.x、3.0.x| +|nebula-exchange_spark_2.4-3.0.0.jar | 3.x.x |2.4.x | +|nebula-exchange_spark_2.2-3.0.0.jar | 3.x.x |2.2.x | +|nebula-exchange-2.6.3.jar | 2.6.1、2.6.0 |2.4.x | +|nebula-exchange-2.6.2.jar | 2.6.1、2.6.0 |2.4.x | +|nebula-exchange-2.6.1.jar | 2.6.1、2.6.0 |2.4.x | +|nebula-exchange-2.6.0.jar | 2.6.1、2.6.0 |2.4.x | +|nebula-exchange-2.5.2.jar | 2.5.1、2.5.0 |2.4.x | +|nebula-exchange-2.5.1.jar | 2.5.1、2.5.0 |2.4.x | +|nebula-exchange-2.5.0.jar | 2.5.1、2.5.0 |2.4.x | +|nebula-exchange-2.1.0.jar | 2.0.1、2.0.0 |2.4.x | +|nebula-exchange-2.0.1.jar | 2.0.1、2.0.0 |2.4.x | +|nebula-exchange-2.0.0.jar | 2.0.1、2.0.0 |2.4.x | ## Data source From 1fd37bf4644e8fa7ef71b36f3d3da28681cfa496 Mon Sep 17 00:00:00 2001 From: cooper-lzy <78672629+cooper-lzy@users.noreply.github.com> Date: Thu, 10 Nov 2022 15:42:27 +0800 Subject: [PATCH 29/89] Update 1.prepare-resources.md (#1751) --- docs-2.0/nebula-explorer/workflow/1.prepare-resources.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs-2.0/nebula-explorer/workflow/1.prepare-resources.md b/docs-2.0/nebula-explorer/workflow/1.prepare-resources.md index 58ad6880a9f..f324e5e9916 100644 --- a/docs-2.0/nebula-explorer/workflow/1.prepare-resources.md +++ b/docs-2.0/nebula-explorer/workflow/1.prepare-resources.md @@ -18,8 +18,8 @@ You must prepare your environment for running a workflow, including NebulaGraph |Type|Description| |:--|:--| - |NebulaGraph Configuration| The access address of the graph service that executes a graph query or to which the graph computing result is written. The default address is the address that you use to log into Explorer and can not be changed. You can set timeout periods for three services.| - |HDFS Configuration| The HDFS address that stores the result of the graph query or graph computing. Click **Add** to add a new address, you can set the HDFS name, HDFS path, and HDFS username (optional). + |NebulaGraph Configuration| The access address of the graph service that executes a graph query or to which the graph computing result is written. The default address is the address that you use to log into Explorer and can not be changed. You can set timeout periods for three services. | + |HDFS Configuration| The HDFS address that stores the result of the graph query or graph computing (`fs.defaultFS`). Click **Add** to add a new address, you can set the HDFS name, HDFS path, and HDFS username (optional). The configuration takes effect only after the HDFS client is installed on the machine where the Analytics is installed. | |NebulaGraph Analytics Configuration| The NebulaGraph Analytics address that performs the graph computing. Click **Add** to add a new address.| 4. Click **Confirm**. From 785c4f61cc4c0f9b4710a2206bb17152ce42cf73 Mon Sep 17 00:00:00 2001 From: "abby.huang" <78209557+abby-cyber@users.noreply.github.com> Date: Fri, 11 Nov 2022 15:59:59 +0800 Subject: [PATCH 30/89] add-length()-and-size() (#1752) --- docs-2.0/2.quick-start/6.cheatsheet-for-ngql.md | 4 ++-- .../6.functions-and-expressions/1.math.md | 14 ++++++++++++-- .../6.functions-and-expressions/2.string.md | 15 +++++++++++++-- 3 files changed, 27 insertions(+), 6 deletions(-) diff --git a/docs-2.0/2.quick-start/6.cheatsheet-for-ngql.md b/docs-2.0/2.quick-start/6.cheatsheet-for-ngql.md index 725cca1fe0b..1193bd809eb 100644 --- a/docs-2.0/2.quick-start/6.cheatsheet-for-ngql.md +++ b/docs-2.0/2.quick-start/6.cheatsheet-for-ngql.md @@ -31,7 +31,7 @@ | bit_and() | Bitwise AND. | | bit_or() | Bitwise OR. | | bit_xor() | Bitwise XOR. | - | int size() | Returns the number of elements in a list or a map. | + | int size() | Returns the number of elements in a list or a map or the length of a string. | | int range(int start, int end, int step) | Returns a list of integers from `[start,end]` in the specified steps. `step` is 1 by default. | | int sign(double x) | Returns the signum of the given number.
If the number is `0`, the system returns `0`.
If the number is negative, the system returns `-1`.
If the number is positive, the system returns `1`. | | double e() | Returns the base of the natural logarithm, e (2.718281828459045). | @@ -60,7 +60,7 @@ |string toLower(string a) | The same as `lower()`. | |string upper(string a) | Returns the argument in uppercase. | |string toUpper(string a) | The same as `upper()`. | - |int length(string a) | Returns the length of the given string in bytes. | + |int length(a) | Returns the length of the given string in bytes or the length of a path in hops. | |string trim(string a) | Removes leading and trailing spaces. | |string ltrim(string a) | Removes leading spaces. | |string rtrim(string a) | Removes trailing spaces. | diff --git a/docs-2.0/3.ngql-guide/6.functions-and-expressions/1.math.md b/docs-2.0/3.ngql-guide/6.functions-and-expressions/1.math.md index 734f99bc5b5..6e5331a3400 100644 --- a/docs-2.0/3.ngql-guide/6.functions-and-expressions/1.math.md +++ b/docs-2.0/3.ngql-guide/6.functions-and-expressions/1.math.md @@ -551,11 +551,12 @@ nebula> RETURN bit_xor(5,6); ## size() -size() returns the number of elements in a list or a map. +size() returns the number of elements in a list or a map, or the length of a string. -Syntax: `size()` +Syntax: `size({|})` - `expression`: An expression for a list or map. +- `string`: A specified string. - Result type: Int @@ -570,6 +571,15 @@ nebula> RETURN size([1,2,3,4]); +-----------------+ ``` +```ngql +nebula> RETURN size("basketballplayer") as size; ++------+ +| size | ++------+ +| 16 | ++------+ +``` + ## range() range() returns a list of integers from `[start,end]` in the specified steps. diff --git a/docs-2.0/3.ngql-guide/6.functions-and-expressions/2.string.md b/docs-2.0/3.ngql-guide/6.functions-and-expressions/2.string.md index 187cea9bfc0..d02ab3e2c40 100644 --- a/docs-2.0/3.ngql-guide/6.functions-and-expressions/2.string.md +++ b/docs-2.0/3.ngql-guide/6.functions-and-expressions/2.string.md @@ -77,10 +77,10 @@ nebula> RETURN upper("Basketball_Player"); length() returns the length of the given string in bytes. -Syntax: `length()` +Syntax: `length({|})` - `string`: A specified string. - +- `path`: A specified path represented by a variable. - Result type: Int Example: @@ -94,6 +94,17 @@ nebula> RETURN length("basketball"); +----------------------+ ``` +```ngql +nebula> MATCH p=(v:player{name:"Tim Duncan"})-->(v2) return length(p); ++-----------+ +| length(p) | ++-----------+ +| 1 | +| 1 | +| 1 | ++-----------+ +``` + ## trim() trim() removes the spaces at the leading and trailing of the string. From 1c5ec040a737058f55e639fc3232cbd3ecf64953 Mon Sep 17 00:00:00 2001 From: cooper-lzy <78672629+cooper-lzy@users.noreply.github.com> Date: Mon, 14 Nov 2022 11:05:47 +0800 Subject: [PATCH 31/89] explorer removes dependence on studio (#1753) --- .../db-management/10.create-schema.md | 70 ++++++++++++++++++- .../db-management/11.import-data.md | 48 ++++++++++++- .../db-management/explorer-console.md | 30 +++++++- 3 files changed, 139 insertions(+), 9 deletions(-) diff --git a/docs-2.0/nebula-explorer/db-management/10.create-schema.md b/docs-2.0/nebula-explorer/db-management/10.create-schema.md index 38d71f9026b..42386346334 100644 --- a/docs-2.0/nebula-explorer/db-management/10.create-schema.md +++ b/docs-2.0/nebula-explorer/db-management/10.create-schema.md @@ -1,7 +1,71 @@ # Create a schema -Explorer allows you to create a schema both using GUI and using commands. +Explorer allows you to create a schema by using GUI. -At the upper right corner of the page, click ![schema](https://docs-cdn.nebula-graph.com.cn/figures/studio-nav-schema.png) to enter the schema creation page. +!!! Note -The Explorer's schema feature is the same as Studio's. For more information, see [Create a schema](../../nebula-studio/quick-start/st-ug-create-schema.md). + - Users can use the Schema drafting function to design schema visually. For more information, see [Schema drafting](draft.md). + - Users can directly execute nGQL commands on the console to manage the schema. + +## Prerequisites + +- Your account has the privilege of GOD, ADMIN, or DBA. For more information, see [Roles and privileges](../../7.data-security/1.authentication/3.role-list.md) . + +- The schema is designed. + +!!! note + + If no graph space exists and your account has the GOD privilege, you can create a graph space on the **Console** page. + +## Entry + +At the top navigation bar, click ![schema](https://docs-cdn.nebula-graph.com.cn/figures/studio-nav-schema.png). + +## Create graph space + +1. Click **Create Space**. +2. Set parameters. For descriptions of the parameters, see [CREATE SPACE](../../3.ngql-guide/9.space-statements/1.create-space.md). +3. Click **Create**. + +## Create Tag or Edge type + +1. In the **Graph Space List** page, find a graph space and then click its name or click **Schema** in the **Operations** column. +2. Click the **Tag** or **Edge Type** tab and click the **Create** button. +3. Set parameters. For descriptions of the parameters, see [CREATE TAG](../../3.ngql-guide/10.tag-statements/1.create-tag.md) or [CREATE EDGE](../../3.ngql-guide/11.edge-type-statements/1.create-edge.md). + + !!! Note + + If no index is set for the tag, you can set the TTL configuration. For more information, see [TTL configuration](../../3.ngql-guide/8.clauses-and-options/ttl-options.md). + +4. Click **Create**. + +In the **Tag** and **Edge Type** lists, you can perform modification and deletion operations. + +## Create index + +!!! Note + + - Before creating an index, ensure that the associated Tag or Edge type has been created. + - The index can decrease the write speed during data import. We recommend that you import data first and then create and rebuild an index. For more information, see [Index overview](../../3.ngql-guide/14.native-index-statements/README.md). + +1. In the **Graph Space List** page, find a graph space and then click its name or click **Schema** in the **Operations** column. +2. Click the **Index** tab and click the **Create** button. +3. Set parameters. For descriptions of the parameters, see [CREATE INDEX](../../3.ngql-guide/14.native-index-statements/1.create-native-index.md). + + !!! Note + + The order of the indexed properties has an effect on the result of the `LOOKUP` statement. For more information, see [LOOKUP](../../3.ngql-guide/7.general-query-statements/5.lookup.md). + +4. Click **Create**. + +In the **Index** list, you can rebuild or delete the index. + +## View statistics + +1. In the **Graph Space List** page, find a graph space and then click its name or click **Schema** in the **Operations** column. +2. Click **Statistics** tab and click the **Refresh** button. + +## View schema + +1. In the **Graph Space List** page, find a graph space and then click its name or click **Schema** in the **Operations** column. +2. Click **View Schema** tab and click the **Refresh** button. \ No newline at end of file diff --git a/docs-2.0/nebula-explorer/db-management/11.import-data.md b/docs-2.0/nebula-explorer/db-management/11.import-data.md index 17e6832fb9a..2b928b16db3 100644 --- a/docs-2.0/nebula-explorer/db-management/11.import-data.md +++ b/docs-2.0/nebula-explorer/db-management/11.import-data.md @@ -1,7 +1,49 @@ # Import data -Explorer allows you to import data into NebulaGraph using GUI. +Explorer allows you to import data in CSV format into NebulaGraph using GUI. -At the upper right corner of the page, click ![download](https://docs-cdn.nebula-graph.com.cn/figures/studio-btn-download.png) to enter the data import page. +## Prerequisites -The Explorer's data import feature is the same as Studio's. For more information, see [Import data](../../nebula-studio/quick-start/st-ug-import-data.md). +- CSV files meet the demands of the Schema. + +- Your account has the privilege of GOD, ADMIN, or DBA. For more information, see [Roles and privileges](../../7.data-security/1.authentication/3.role-list.md) . + +## Entry + +At the top navigation bar, click ![download](https://docs-cdn.nebula-graph.com.cn/figures/studio-btn-download.png). + +## Steps + +### Upload files + +1. In the **Upload Files** tab, click the **Upload Files** button and then choose CSV files. + + !!! Note + + You can choose multiple CSV files at the same time. + +2. After uploading, you can click the ![detail](https://docs-cdn.nebula-graph.com.cn/figures/detail.png) button in the **Operations** column to preview the file content. + +### Import Data + +1. In the **Import Data** tab, click **+ New Import** button to complete these operations: + + !!! caution + + users can click **Import Template** to download the example configuration file `example.yaml`, and upload the configuration file after configuration. The configuration mode is similar to that of [NebulaGraph Importer](../../nebula-importer/use-importer.md), but all file paths for configuration files in the template retain the filename only. And make sure all CSV data files are uploaded before importing the YAML file. + + - **Space**: The name of the graph space that you want to import data from. + - **Task Name**: Automatically generated by default and can be modified. + - **Batch Size** (Optional): The number of rows of imported data per batch. + - **Map Vertices**: Click the **Bind Datasource** button, then select bind source file in the dialog box, and click the **Confirm** button. + + - In the **vertexID** item of the **vertices 1** drop-down list, click **Select CSV Index**, and select the data source for VID in the pop-up dialog box. + - Click the **Add Tag** button, then click **Select Tag** in the newly created tab and select the Tag you want to associate. In the property list, select the data source for the property. + + - **Map Edges**: Similar to the operation of the **Map Vertices**. + + ![Import_data](https://docs-cdn.nebula-graph.com.cn/figures/import_task_221111_en.png) + +2. After completing the settings, click the **Import** button and enter the password of your NebulaGraph account. + +On the **Import Data** tab, you can view logs, download logs, download configuration files, and delete tasks. diff --git a/docs-2.0/nebula-explorer/db-management/explorer-console.md b/docs-2.0/nebula-explorer/db-management/explorer-console.md index 02774a6d8e4..3e06da92141 100644 --- a/docs-2.0/nebula-explorer/db-management/explorer-console.md +++ b/docs-2.0/nebula-explorer/db-management/explorer-console.md @@ -1,7 +1,31 @@ # Explorer console -Explorer console allows you to enter nGQL statements and visualize the query results. +Explorer console allows you to enter nGQL statements and visualize the query results. This topic describes the console page. -At the upper right corner of the page, click ![console](https://docs-cdn.nebula-graph.com.cn/figures/nav-console2.png) to enter the console page. +## Entry -The Explorer's console feature is the same as Studio's. For more information, see [Console](../../nebula-studio/quick-start/st-ug-console.md). +At the top navigation bar, click ![console](https://docs-cdn.nebula-graph.com.cn/figures/nav-console2.png) . + +## Overview + +![Console overview](https://docs-cdn.nebula-graph.com.cn/figures/console_ovewview_221111_en.png) + +The following table lists the functions on the console page. + +| number | function | descriptions | +| :-- | :--| :-- | +| 1 | select a space | Select a space in the Current Graph Space list. The `USE ` statement in the console is not supported to switch graph spaces. | +| 2 | favorites | Click the ![save](https://docs-cdn.nebula-graph.com.cn/figures/studio-btn-save.png) button to expand the favorites, click one of the statements, and the input box will automatically enter the statement. | +| 3 | history list | Click ![history](https://docs-cdn.nebula-graph.com.cn/figures/studio-btn-history.png) button representing the statement record. In the statement running record list, click one of the statements, and the statement will be automatically entered in the input box. The list provides the record of the last 15 statements. | +| 4 | clean input box | Click ![clean](https://docs-cdn.nebula-graph.com.cn/figures/studio-btn-clear.png) button to clear the content entered in the input box. | +| 5 | run | After inputting the nGQL statement in the input box, click ![run](https://docs-cdn.nebula-graph.com.cn/figures/studio-btn-play.png) button to indicate the operation to start running the statement. | +| 6 | save as template | Save the nGQL statement entered in the input box as a template. For details, see [nGQL template](ngql-template.md). | +| 7 | input box | After inputting the nGQL statements, click the ![run](https://docs-cdn.nebula-graph.com.cn/figures/studio-btn-play.png) button to run the statement. You can input multiple statements and run them at the same time by using the separator `;`, and also use the symbol `//` to add comments. | +| 8 | custom parameters display | Click the ![Query](https://docs-cdn.nebula-graph.com.cn/figures/down.png) button to expand the custom parameters for parameterized query. For details, see [Manage parameters](../../nebula-console.md).| +| 9 | statement running status | After running the nGQL statement, the statement running status is displayed. If the statement runs successfully, the statement is displayed in green. If the statement fails, the statement is displayed in red. | +| 10 | add to favorites | Click the ![save](https://docs-cdn.nebula-graph.com.cn/figures/studio-btn-save.png) button to save the statement as a favorite, the button for the favorite statement is colored in yellow exhibit.| +| 11 | export CSV file or PNG file | After running the nGQL statement to return the result, when the result is in **Table** window, click the ![download](https://docs-cdn.nebula-graph.com.cn/figures/studio-btn-download.png) button to export as a CSV file.
Switch to the **Graph** window and click the ![download](https://docs-cdn.nebula-graph.com.cn/figures/studio-btn-download.png) button to save the results as a CSV file or PNG image export. | +| 12 | expand/hide execution results | Click the ![up](https://docs-cdn.nebula-graph.com.cn/figures/studio-btn-up.png) button to hide the result or click ![down](https://docs-cdn.nebula-graph.com.cn/figures/studio-btn-down.png) button to expand the result. | +| 13 | close execution results | Click the ![close](https://docs-cdn.nebula-graph.com.cn/figures/studio-btn-close.png) button to close the result returned by this nGQL statement. | +| 14 | **Table** window | Display the result from running nGQL statement. If the statement returns results, the window displays the results in a table. | +| 15 | **Graph** window | Display the result from running nGQL statement. If the statement returns the complete vertex-edge result, the window displays the result as a graph . Click the ![expand](https://docs-cdn.nebula-graph.com.cn/figures/studio-btn-back.png) button on the right to view the overview panel. | \ No newline at end of file From 1e6e5438379d8e5aaa24e5e295c6a03463d02dfd Mon Sep 17 00:00:00 2001 From: cooper-lzy <78672629+cooper-lzy@users.noreply.github.com> Date: Mon, 14 Nov 2022 11:58:12 +0800 Subject: [PATCH 32/89] update workflow (#1754) --- docs-2.0/nebula-explorer/deploy-connect/ex-ug-deploy.md | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/docs-2.0/nebula-explorer/deploy-connect/ex-ug-deploy.md b/docs-2.0/nebula-explorer/deploy-connect/ex-ug-deploy.md index a4bc76dbfdb..4a54c19b34c 100644 --- a/docs-2.0/nebula-explorer/deploy-connect/ex-ug-deploy.md +++ b/docs-2.0/nebula-explorer/deploy-connect/ex-ug-deploy.md @@ -238,12 +238,11 @@ The Dag Controller can perform complex graph computing with NebulaGraph Analytic In the same way, complete the SSH password-free configurations so that the user in the machine A can log directly into the machine B-2, B-3, etc. and all machines within the NebulaGraph Analytics cluster can connect directly to each other without passwords. -2. Add the following to the file `~/.bash_profile` and run the command `source ~/.bash_profile` to make it effective. +2. Run `eval $(ssh-agent)` on the Dag Controller machine to start the ssh-agent, then run `ssh-add ~/.ssh/id_rsa` to give the private key to the ssh-agent to manage. - ``` - eval $(ssh-agent) - ssh-add ~/.ssh/id_rsa - ``` + !!! note + + ssh-agent is a key manager that manages multiple keys and provides proxies for other programs that need to use SSH key pairs. 3. Configure the username and port of the NebulaGraph Analytics in the file `dag-ctrl-api.yaml`, the file path is `dag-ctrl/etc/dag-ctrl-api.yaml`. If there are multiple machines, ensure that the usernames and ports are the same. From 44b1cb1110ec210b39bcc420c8e3c88145683e08 Mon Sep 17 00:00:00 2001 From: cooper-lzy <78672629+cooper-lzy@users.noreply.github.com> Date: Mon, 14 Nov 2022 16:41:56 +0800 Subject: [PATCH 33/89] Update ex-ug-deploy.md --- docs-2.0/nebula-explorer/deploy-connect/ex-ug-deploy.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs-2.0/nebula-explorer/deploy-connect/ex-ug-deploy.md b/docs-2.0/nebula-explorer/deploy-connect/ex-ug-deploy.md index 4a54c19b34c..98aad78755c 100644 --- a/docs-2.0/nebula-explorer/deploy-connect/ex-ug-deploy.md +++ b/docs-2.0/nebula-explorer/deploy-connect/ex-ug-deploy.md @@ -144,9 +144,9 @@ sudo rpm -e nebula-graph-explorer-.x86_64 ```bash cd nebula-explorer # Start Explorer. - sudo ./lib/start.sh + sudo ./scripts/start.sh # (Optional) Start Dag Controller. - sudo ./dag-ctrl/lib/start.sh + sudo ./dag-ctrl/scripts/start.sh ``` ### View the status From 88765a7bf8919d26c4902c92189b8685ba63a126 Mon Sep 17 00:00:00 2001 From: cooper-lzy <78672629+cooper-lzy@users.noreply.github.com> Date: Mon, 14 Nov 2022 16:46:16 +0800 Subject: [PATCH 34/89] Update ex-ug-deploy.md --- docs-2.0/nebula-explorer/deploy-connect/ex-ug-deploy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs-2.0/nebula-explorer/deploy-connect/ex-ug-deploy.md b/docs-2.0/nebula-explorer/deploy-connect/ex-ug-deploy.md index 98aad78755c..8e7de25876c 100644 --- a/docs-2.0/nebula-explorer/deploy-connect/ex-ug-deploy.md +++ b/docs-2.0/nebula-explorer/deploy-connect/ex-ug-deploy.md @@ -144,7 +144,7 @@ sudo rpm -e nebula-graph-explorer-.x86_64 ```bash cd nebula-explorer # Start Explorer. - sudo ./scripts/start.sh + sudo ./lib/start.sh # (Optional) Start Dag Controller. sudo ./dag-ctrl/scripts/start.sh ``` From 49dbd382e9c70a4154dace1650634a6717494615 Mon Sep 17 00:00:00 2001 From: cooper-lzy <78672629+cooper-lzy@users.noreply.github.com> Date: Tue, 15 Nov 2022 09:32:25 +0800 Subject: [PATCH 35/89] dashboard update create cluster (#1756) --- .../1.create-cluster.md | 23 ++++++++++--------- 1 file changed, 12 insertions(+), 11 deletions(-) diff --git a/docs-2.0/nebula-dashboard-ent/3.create-import-dashboard/1.create-cluster.md b/docs-2.0/nebula-dashboard-ent/3.create-import-dashboard/1.create-cluster.md index 34d148ec848..b3b5fab65e2 100644 --- a/docs-2.0/nebula-dashboard-ent/3.create-import-dashboard/1.create-cluster.md +++ b/docs-2.0/nebula-dashboard-ent/3.create-import-dashboard/1.create-cluster.md @@ -10,30 +10,31 @@ You can create a cluster following these steps: 2. On the **Cluster management** page, click **Create cluster**. 3. On the **Create cluster** page, fill in the following: - - Enter a **Cluster Name**, up to 15 characters for each name. In this example, the cluster name is `test`. - - Choose a NebulaGraph version to install. In this example, the version is `Enterprise v3.1.0`. + - Enter a **Cluster Name**, up to 15 characters for each name. + - Choose a NebulaGraph version to install. !!! note Only one Enterprise Edition of NebulaGraph is provided for you to choose from on the **Create cluster** page. To install other versions of NebulaGraph, you can download or upload the corresponding installer package on the **Package Management** page. For details, see [Package management](../system-settings/manage-package.md). - - Click **Upload License**. + - Click **Upload License**. !!! note For the creation of a Community version of NebulaGraph, skip this step to upload the License file. - - **Add nodes**. The information of each node is required. + - **Add nodes**. Enter the following information, the Host, SSH port, SSH user, authentication type, NebulaGraph package, etc. - ![cluster](https://docs-cdn.nebula-graph.com.cn/figures/create-cluster-2022-04-08_en.png) + The authentication type is described as follows: - 1. Enter the IP information of each host. In this example, it is `192.168.8.129`. - 2. Enter the SSH information. In this example, the SSH port is `22`, the SSH user is `vesoft`, and the SSH password is `nebula`. - 3. Choose the target NebulaGraph package. In this example, the package is `nebula-graph-ent-3.1.0-ent.el7.x86_64.rpm`. - 4. Customize the cluster installation path. In this example, the default path is `.nebula/cluster`. - 5. (Optional) Enter the node name to make a note on the node. In this example, the note is `Node_1`. + - SSH Password: Enter the password of the SSH user. - - **Import nodes in batches**. The information of each node is required. To import nodes in batches, you need to choose the installation package and click **download the CSV template**. Fill in the template and upload it. Ensure that the node is correct, otherwise, upload failure may happen. + - SSH Key: Click **Upload** and select the private key file of the node. You need to generate the secret key files on the node to be added and send the private key file to the current computer (not the machine where Dashboard is deployed). If the passphrase is set, this parameter is also required. + + ![cluster](https://docs-cdn.nebula-graph.com.cn/figures/create-cluster-221115_en.png) + + + - **Import nodes in batches**. The information of each node is required. To import nodes in batches, you need to choose the installation package and click **download the CSV template**. Fill in the template and upload it. Ensure that the node is correct, otherwise, upload failure may happen. 4. Select the node and add the service you need in the upper right corner. To create a cluster, you need to add 3 types of services to the node. If not familiar with the NebulaGraph architecture, click **Auto add service**. From 016603a8f42c3dfb38090dba830a0042baa3d2b3 Mon Sep 17 00:00:00 2001 From: foesa <35463247+foesa-yang@users.noreply.github.com> Date: Tue, 15 Nov 2022 16:04:30 +0800 Subject: [PATCH 36/89] Update 2.balance-syntax.md (#1758) --- docs-2.0/synchronization-and-migration/2.balance-syntax.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs-2.0/synchronization-and-migration/2.balance-syntax.md b/docs-2.0/synchronization-and-migration/2.balance-syntax.md index 8f7b0469c27..7aa821d0641 100644 --- a/docs-2.0/synchronization-and-migration/2.balance-syntax.md +++ b/docs-2.0/synchronization-and-migration/2.balance-syntax.md @@ -6,10 +6,10 @@ The `BALANCE` statements are listed as follows. |Syntax|Description| |:---|:---| -|`BALANCE DATA`| Starts a job to balance the distribution of storage partitions in the current graph space. It returns the job ID. | -|`BALANCE DATA REMOVE [,: ...]`| Migrate the partitions in the specified storage host to other storage hosts in the current graph space. | |`BALANCE LEADER`| Starts a job to balance the distribution of storage leaders in the current graph space. It returns the job ID. | From 00032be0a304fb35a3015f3ab46deeb4e40cbf97 Mon Sep 17 00:00:00 2001 From: cooper-lzy <78672629+cooper-lzy@users.noreply.github.com> Date: Thu, 17 Nov 2022 17:27:46 +0800 Subject: [PATCH 39/89] add hdfs error for dag (#1761) --- .../nebula-explorer/deploy-connect/ex-ug-deploy.md | 6 ++++++ docs-2.0/nebula-explorer/faq.md | 13 +++++++++++++ .../nebula-explorer/workflow/1.prepare-resources.md | 4 +++- 3 files changed, 22 insertions(+), 1 deletion(-) diff --git a/docs-2.0/nebula-explorer/deploy-connect/ex-ug-deploy.md b/docs-2.0/nebula-explorer/deploy-connect/ex-ug-deploy.md index 8e7de25876c..7d4da6160b2 100644 --- a/docs-2.0/nebula-explorer/deploy-connect/ex-ug-deploy.md +++ b/docs-2.0/nebula-explorer/deploy-connect/ex-ug-deploy.md @@ -29,6 +29,12 @@ Before deploying Explorer, you must check the following information: License is only available in the Enterprise Edition. To obtain the license, apply for [NebulaGraph Explorer Free Trial](https://nebula-graph.io/visualization-tools-free-trial). +- The HDFS services are deployed if graph computing is required. The namenode uses port 8020 by default, and the datanode uses port 50010 by default. + + !!! caution + + If the HDFS port is unavailable, the connection timeout message may be displayed. + ## RPM-based deployment ### Installation diff --git a/docs-2.0/nebula-explorer/faq.md b/docs-2.0/nebula-explorer/faq.md index c8279589bb3..a78fd63fc2e 100644 --- a/docs-2.0/nebula-explorer/faq.md +++ b/docs-2.0/nebula-explorer/faq.md @@ -68,6 +68,19 @@ Check according to the following procedure: 3. Restart the Dag Controller for the settings to take effect. +## How to resolve the error `no available namenodes: dial tcp xx.xx.xx.xx:8020: connect: connection timed out`? + +Check whether the HDFS namenode port 8020 is open. + +## How to resolve the error `org.apache.hadoop.net.ConnectTimeoutException: 60000 millis timeout`? + +Check whether the HDFS datanode port 50010 is open. + +If the port is not opened, an error similar to the following may be reported: + +- `Check failed: false close hdfs-file failed` +- `org.apache.hadoop.ipc.RemoteException(java.io.IOException): File /analytics/xx/tasks/analytics_xxx/xxx.csv could only be replicated to 0 nodes instead of minReplication` + ## How to resolve the error `broadcast.hpp:193] Check failed: (size_t)recv_bytes >= sizeof(chunk_tail_t) recv message too small: 0`? The amount of data to be processed is too small, but the number of compute nodes and processes is too large. Smaller `clusterSize` and `processes` need to be set when submitting jobs. diff --git a/docs-2.0/nebula-explorer/workflow/1.prepare-resources.md b/docs-2.0/nebula-explorer/workflow/1.prepare-resources.md index f324e5e9916..275d772d1cc 100644 --- a/docs-2.0/nebula-explorer/workflow/1.prepare-resources.md +++ b/docs-2.0/nebula-explorer/workflow/1.prepare-resources.md @@ -16,10 +16,12 @@ You must prepare your environment for running a workflow, including NebulaGraph 3. Configure the following resources: + ![workflow_configuration](https://docs-cdn.nebula-graph.com.cn/figures/workflow_configuration_221117_en.png) + |Type|Description| |:--|:--| |NebulaGraph Configuration| The access address of the graph service that executes a graph query or to which the graph computing result is written. The default address is the address that you use to log into Explorer and can not be changed. You can set timeout periods for three services. | - |HDFS Configuration| The HDFS address that stores the result of the graph query or graph computing (`fs.defaultFS`). Click **Add** to add a new address, you can set the HDFS name, HDFS path, and HDFS username (optional). The configuration takes effect only after the HDFS client is installed on the machine where the Analytics is installed. | + |HDFS Configuration| The HDFS address that stores the result of the graph query or graph computing. Click **Add** to add a new address, you can set the HDFS name, HDFS path (`fs.defaultFS`), and HDFS username. You can configure the save path, such as `hdfs://192.168.8.100:9000/test`. The configuration takes effect only after the HDFS client is installed on the machine where the Analytics is installed. | |NebulaGraph Analytics Configuration| The NebulaGraph Analytics address that performs the graph computing. Click **Add** to add a new address.| 4. Click **Confirm**. From 6aa992c7441a602d1882fd4c33b73408d564c7a3 Mon Sep 17 00:00:00 2001 From: cooper-lzy <78672629+cooper-lzy@users.noreply.github.com> Date: Fri, 18 Nov 2022 11:34:46 +0800 Subject: [PATCH 40/89] update ngql template (#1763) --- docs-2.0/nebula-explorer/db-management/ngql-template.md | 4 +++- .../nebula-explorer/graph-explorer/ex-ug-query-exploration.md | 2 ++ 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/docs-2.0/nebula-explorer/db-management/ngql-template.md b/docs-2.0/nebula-explorer/db-management/ngql-template.md index 4c110a54481..738896acb28 100644 --- a/docs-2.0/nebula-explorer/db-management/ngql-template.md +++ b/docs-2.0/nebula-explorer/db-management/ngql-template.md @@ -40,4 +40,6 @@ At the top navigation bar, click ![Template](https://docs-cdn.nebula-graph.com.c ## Use template -In addition to clicking ![console](https://docs-cdn.nebula-graph.com.cn/figures/nav-console2.png) on the template list page to automatically jump to the console and enter the template, templates can also be used on the graph exploration page. For details, see [Start querying](../graph-explorer/ex-ug-query-exploration.md). \ No newline at end of file +- (Recommended) Use templates on the graph exploration page. For details, see [Start querying](../graph-explorer/ex-ug-query-exploration.md). + +- Click ![console](https://docs-cdn.nebula-graph.com.cn/figures/nav-console2.png) on the template list page to automatically jump to the console and enter the template. You need to modify the parameterized text. diff --git a/docs-2.0/nebula-explorer/graph-explorer/ex-ug-query-exploration.md b/docs-2.0/nebula-explorer/graph-explorer/ex-ug-query-exploration.md index 1c393804c69..25f2aa08bc1 100644 --- a/docs-2.0/nebula-explorer/graph-explorer/ex-ug-query-exploration.md +++ b/docs-2.0/nebula-explorer/graph-explorer/ex-ug-query-exploration.md @@ -61,6 +61,8 @@ The following is an example of VIDs `Kings` and `Suns`, step number `2`, and inc You can select the created nGQL template, and set the parameter value. +![query_template](https://docs-cdn.nebula-graph.com.cn/figures/query_template_221118_en.png) + - When the returned result is vertices, they will be displayed on the canvas. - When the returned result is not vertices, they will be displayed in table format. For example, return player name, age, etc. From 93fc2662ddfebe57d620af514ae81b2f629da6c6 Mon Sep 17 00:00:00 2001 From: foesa <35463247+foesa-yang@users.noreply.github.com> Date: Fri, 18 Nov 2022 17:09:37 +0800 Subject: [PATCH 41/89] Update optional-match.md (#1764) --- .../7.general-query-statements/optional-match.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/docs-2.0/3.ngql-guide/7.general-query-statements/optional-match.md b/docs-2.0/3.ngql-guide/7.general-query-statements/optional-match.md index 69885a3a402..5dca761e716 100644 --- a/docs-2.0/3.ngql-guide/7.general-query-statements/optional-match.md +++ b/docs-2.0/3.ngql-guide/7.general-query-statements/optional-match.md @@ -1,5 +1,9 @@ # OPTIONAL MATCH +!!! caution + + The feature is still in beta. It will continue to be optimized. + The `OPTIONAL MATCH` clause is used to search for the pattern described in it. `OPTIONAL MATCH` matches patterns against your graph database, just like `MATCH` does. The difference is that if no matches are found, `OPTIONAL MATCH` will use a null for missing parts of the pattern. ## OpenCypher Compatibility @@ -36,4 +40,4 @@ nebula> MATCH (m)-[]->(n) WHERE id(m)=="player100" \ | "player100" | "player125" | "team204" | | "player100" | "player125" | "player100" | +-------------+-------------+-------------+ -``` \ No newline at end of file +``` From 3518169fd1e54fd2ff36de82d569a6ef335d6128 Mon Sep 17 00:00:00 2001 From: cooper-lzy <78672629+cooper-lzy@users.noreply.github.com> Date: Mon, 21 Nov 2022 16:28:30 +0800 Subject: [PATCH 42/89] merge helm in studio doc (#1765) --- .../st-ug-what-is-graph-studio.md | 5 +- .../deploy-connect/st-ug-deploy-by-helm.md | 63 ------------------- .../deploy-connect/st-ug-deploy.md | 59 +++++++++++++++++ mkdocs.yml | 1 - 4 files changed, 60 insertions(+), 68 deletions(-) delete mode 100644 docs-2.0/nebula-studio/deploy-connect/st-ug-deploy-by-helm.md diff --git a/docs-2.0/nebula-studio/about-studio/st-ug-what-is-graph-studio.md b/docs-2.0/nebula-studio/about-studio/st-ug-what-is-graph-studio.md index 95634efbb9a..a6b786c03a2 100644 --- a/docs-2.0/nebula-studio/about-studio/st-ug-what-is-graph-studio.md +++ b/docs-2.0/nebula-studio/about-studio/st-ug-what-is-graph-studio.md @@ -8,10 +8,7 @@ NebulaGraph Studio (Studio in short) is a browser-based visualization tool to ma ## Released versions -You can deploy Studio using the following methods: - -- You can deploy Studio with Docker, RPM-based, Tar-based or DEB-based and connect it to NebulaGraph. For more information, see [Deploy Studio](../deploy-connect/st-ug-deploy.md). -- Helm-based. You can deploy Studio with Helm in the Kubernetes cluster and connect it to NebulaGraph. For more information, see [Helm-based Studio](../deploy-connect/st-ug-deploy-by-helm.md). +In addition to deploying Studio with RPM-based, DEB-based, or Tar-based package, or with Docker. You can also deploy Studio with Helm in the Kubernetes cluster. For more information, see [Deploy Studio](../deploy-connect/st-ug-deploy.md). From 9fa63642a8547dc67d355080f8521faf8ba8d585 Mon Sep 17 00:00:00 2001 From: cooper-lzy <78672629+cooper-lzy@users.noreply.github.com> Date: Tue, 22 Nov 2022 13:49:36 +0800 Subject: [PATCH 46/89] fix links (#1769) --- mkdocs.yml | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/mkdocs.yml b/mkdocs.yml index bd0399955f0..082e1d62da8 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -469,9 +469,9 @@ nav: - Query NebulaGraph metrics: 6.monitor-and-metrics/1.query-performance-metrics.md - RocksDB Statistics: 6.monitor-and-metrics/2.rocksdb-statistics.md #ent - - Black-box monitoring: - - What is black-box monitoring: 6.monitor-and-metrics/3.bbox/3.1.bbox.md - - Black-box monitoring tool: 6.monitor-and-metrics/3.bbox/3.2.bbox-reviewer.md +#ent - Black-box monitoring: +#ent - What is black-box monitoring: 6.monitor-and-metrics/3.bbox/3.1.bbox.md +#ent - Black-box monitoring tool: 6.monitor-and-metrics/3.bbox/3.2.bbox-reviewer.md - Data security: - Authentication and authorization: @@ -580,7 +580,8 @@ nav: # - Job management: nebula-dashboard-ent/4.cluster-operator/cluster-information/job-management.md - Operation: - Node: nebula-dashboard-ent/4.cluster-operator/operator/node.md - - Scale: nebula-dashboard-ent/4.cluster-operator/operator/scale.md +#ent +#ent - Scale: nebula-dashboard-ent/4.cluster-operator/operator/scale.md - Service: nebula-dashboard-ent/4.cluster-operator/operator/service.md - Update config: nebula-dashboard-ent/4.cluster-operator/operator/update-config.md - Member management: nebula-dashboard-ent/4.cluster-operator/operator/member-management.md From 39feb9dd5c24afe870ee2a00b4d8bc0ce65c725c Mon Sep 17 00:00:00 2001 From: cooper-lzy <78672629+cooper-lzy@users.noreply.github.com> Date: Tue, 22 Nov 2022 15:01:52 +0800 Subject: [PATCH 47/89] Fix links 2 (#1770) * fix links * update --- .../1.install-nebula-graph-by-compiling-the-source-code.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs-2.0/4.deployment-and-installation/2.compile-and-install-nebula-graph/1.install-nebula-graph-by-compiling-the-source-code.md b/docs-2.0/4.deployment-and-installation/2.compile-and-install-nebula-graph/1.install-nebula-graph-by-compiling-the-source-code.md index 6c6316c4e6d..71193bf3bce 100644 --- a/docs-2.0/4.deployment-and-installation/2.compile-and-install-nebula-graph/1.install-nebula-graph-by-compiling-the-source-code.md +++ b/docs-2.0/4.deployment-and-installation/2.compile-and-install-nebula-graph/1.install-nebula-graph-by-compiling-the-source-code.md @@ -82,7 +82,9 @@ The source code of the master branch changes frequently. If the corresponding Ne ## Next to do +{{ ent.ent_begin }} - (Enterprise Edition)[Deploy license](../deploy-license.md) +{{ ent.ent_end }} - [Manage NebulaGraph services](../../2.quick-start/5.start-stop-service.md) From d01ceba4eec49753bace9e460d7c539458c26b8c Mon Sep 17 00:00:00 2001 From: "abby.huang" <78209557+abby-cyber@users.noreply.github.com> Date: Tue, 22 Nov 2022 16:22:38 +0800 Subject: [PATCH 48/89] Implicit group by (#1771) * implicit-group-by * Update group-by.md * Update group-by.md --- .../8.clauses-and-options/group-by.md | 26 +++++++++++++++++-- 1 file changed, 24 insertions(+), 2 deletions(-) diff --git a/docs-2.0/3.ngql-guide/8.clauses-and-options/group-by.md b/docs-2.0/3.ngql-guide/8.clauses-and-options/group-by.md index 12b0c9034d9..b5d28b3e8b0 100644 --- a/docs-2.0/3.ngql-guide/8.clauses-and-options/group-by.md +++ b/docs-2.0/3.ngql-guide/8.clauses-and-options/group-by.md @@ -59,8 +59,6 @@ nebula> GO FROM "player100" OVER follow BIDIRECT \ +---------------------+------------+ ``` -## Group and calculate with functions - The following statement finds all the vertices connected directly to vertex `"player100"`, groups the result set by source vertices, and returns the sum of degree values. ```ngql @@ -76,3 +74,27 @@ nebula> GO FROM "player100" OVER follow \ ``` For more information about the `sum()` function, see [Built-in math functions](../6.functions-and-expressions/1.math.md). + + +## Implicit GROUP BY + +The usage of `GROUP BY` in the above nGQL statements that explicitly write `GROUP BY` and act as grouping fields is called explicit `GROUP BY`, while in openCypher, the `GROUP BY` is implicit, i.e., `GROUP BY` groups fields without explicitly writing `GROUP BY`. The explicit `GROUP BY` in nGQL is the same as the implicit `GROUP BY` in openCypher, and nGQL also supports the implicit `GROUP BY`. For the implicit usage of `GROUP BY`, see [how-to-make-group-by-in-a-cypher-query](https://stackoverflow.com/questions/52722671/how-to-make-group-by-in-a-cypher-query). + + +For example, to look up the players over 34 years old with the same length of service, you can use the following statement: + +```ngql +nebula> LOOKUP ON player WHERE player.age > 34 YIELD id(vertex) AS v | \ + GO FROM $-.v OVER serve YIELD serve.start_year AS start_year, serve.end_year AS end_year | \ + YIELD $-.start_year, $-.end_year, count(*) AS count | \ + ORDER BY $-.count DESC | LIMIT 5; ++---------------+-------------+-------+ +| $-.start_year | $-.end_year | count | ++---------------+-------------+-------+ +| 2018 | 2019 | 3 | +| 1998 | 2004 | 2 | +| 2012 | 2013 | 2 | +| 2007 | 2012 | 2 | +| 2010 | 2011 | 2 | ++---------------+-------------+-------+ +``` \ No newline at end of file From 305763c58e832d674dfeafdcbd114940cc1708b4 Mon Sep 17 00:00:00 2001 From: cooper-lzy <78672629+cooper-lzy@users.noreply.github.com> Date: Wed, 23 Nov 2022 10:19:10 +0800 Subject: [PATCH 49/89] update TIMESTAMP (#1772) --- docs-2.0/2.quick-start/6.cheatsheet-for-ngql.md | 4 ++-- docs-2.0/3.ngql-guide/3.data-types/4.date-and-time.md | 2 +- .../6.functions-and-expressions/3.date-and-time.md | 4 ++-- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs-2.0/2.quick-start/6.cheatsheet-for-ngql.md b/docs-2.0/2.quick-start/6.cheatsheet-for-ngql.md index 1193bd809eb..282d6bc93b6 100644 --- a/docs-2.0/2.quick-start/6.cheatsheet-for-ngql.md +++ b/docs-2.0/2.quick-start/6.cheatsheet-for-ngql.md @@ -82,8 +82,8 @@ |Function| Description | |---- | ----| - |int now() | Returns the current date and time of the system timezone. | - |timestamp timestamp() | Returns the current date and time of the system timezone. | + |int now() | Returns the current timestamp of the system. | + |timestamp timestamp() | Returns the current timestamp of the system. | |date date() | Returns the current UTC date based on the current system. | |time time() | Returns the current UTC time based on the current system. | |datetime datetime() | Returns the current UTC date and time based on the current system. | diff --git a/docs-2.0/3.ngql-guide/3.data-types/4.date-and-time.md b/docs-2.0/3.ngql-guide/3.data-types/4.date-and-time.md index e290b6ceb58..2c50b1954b8 100644 --- a/docs-2.0/3.ngql-guide/3.data-types/4.date-and-time.md +++ b/docs-2.0/3.ngql-guide/3.data-types/4.date-and-time.md @@ -96,7 +96,7 @@ The `TIMESTAMP` data type is used for values that contain both date and time par - Supported `TIMESTAMP` inserting methods: timestamp, `timestamp()` function, and `now()` function. -- `timestamp()` function accepts empty arguments to get the timestamp of the current timezone. +- `timestamp()` function accepts empty arguments to get the current timestamp. - `timestamp()` function can convert `DATETIME` to `TIMESTAMP`. The data type of `DATETIME` should be a `string`. diff --git a/docs-2.0/3.ngql-guide/6.functions-and-expressions/3.date-and-time.md b/docs-2.0/3.ngql-guide/6.functions-and-expressions/3.date-and-time.md index f304db740d4..0681d403bc1 100644 --- a/docs-2.0/3.ngql-guide/6.functions-and-expressions/3.date-and-time.md +++ b/docs-2.0/3.ngql-guide/6.functions-and-expressions/3.date-and-time.md @@ -4,8 +4,8 @@ NebulaGraph supports the following built-in date and time functions: | Function | Description | |:-- |:-- | -| int now() | Returns the current date and time of the system time zone. | -| timestamp timestamp() | Returns the current date and time of the system time zone. | +| int now() | Returns the current timestamp of the system. | +| timestamp timestamp() | Returns the current timestamp of the system. | | date date() | Returns the current UTC date based on the current system. | | time time() | Returns the current UTC time based on the current system. | | datetime datetime() | Returns the current UTC date and time based on the current system. | From b7c6b999bb5adc7426f08a4c21e7bc376ecd7fce Mon Sep 17 00:00:00 2001 From: "abby.huang" <78209557+abby-cyber@users.noreply.github.com> Date: Wed, 23 Nov 2022 11:19:15 +0800 Subject: [PATCH 50/89] add-example-for-getting-vertex/edge-without-specifying-tag/edge-type (#1773) * add-example-for-getting-vertex/edge-without-specifying-tag/edge-type * Update 2.match.md --- .../2.quick-start/6.cheatsheet-for-ngql.md | 4 +-- .../7.general-query-statements/2.match.md | 34 +++++++++++++++++++ 2 files changed, 36 insertions(+), 2 deletions(-) diff --git a/docs-2.0/2.quick-start/6.cheatsheet-for-ngql.md b/docs-2.0/2.quick-start/6.cheatsheet-for-ngql.md index 282d6bc93b6..d3dbbe73495 100644 --- a/docs-2.0/2.quick-start/6.cheatsheet-for-ngql.md +++ b/docs-2.0/2.quick-start/6.cheatsheet-for-ngql.md @@ -185,14 +185,14 @@ | Match vertices | `(v)` | You can use a user-defined variable in a pair of parentheses to represent a vertex in a pattern. For example: `(v)`. | | Match tags | `MATCH (v:player) RETURN v` | You can specify a tag with `:` after the vertex in a pattern. | | Match multiple tags | `MATCH (v:player:team) RETURN v LIMIT 10` | To match vertices with multiple tags, use colons (:). | - | Match vertex properties | `MATCH (v:player{name:"Tim Duncan"}) RETURN v` | You can specify a vertex property with `{: }` after the tag in a pattern. | + | Match vertex properties | `MATCH (v:player{name:"Tim Duncan"}) RETURN v`

`MATCH (v) WITH v, properties(v) as props, keys(properties(v)) as kk LIMIT 10000 WHERE [i in kk where props[i] == "Tim Duncan"] RETURN v` | You can specify a vertex property with `{: }` after the tag in a pattern; or use a vertex property value to get vertices directly. | | Match a VID. | `MATCH (v) WHERE id(v) == 'player101' RETURN v` | You can use the VID to match a vertex. The `id()` function can retrieve the VID of a vertex. | | Match multiple VIDs. | `MATCH (v:player { name: 'Tim Duncan' })--(v2) WHERE id(v2) IN ["player101", "player102"] RETURN v2` | To match multiple VIDs, use `WHERE id(v) IN [vid_list]`. | | Match connected vertices | `MATCH (v:player{name:"Tim Duncan"})--(v2) RETURN v2.player.name AS Name` | You can use the `--` symbol to represent edges of both directions and match vertices connected by these edges. You can add a `>` or `<` to the `--` symbol to specify the direction of an edge. | | Match paths | `MATCH p=(v:player{name:"Tim Duncan"})-->(v2) RETURN p` | Connected vertices and edges form a path. You can use a user-defined variable to name a path as follows. | | Match edges | `MATCH (v:player{name:"Tim Duncan"})-[e]-(v2) RETURN e`
`MATCH ()<-[e]-() RETURN e LIMIT 3` | Besides using `--`, `-->`, or `<--` to indicate a nameless edge, you can use a user-defined variable in a pair of square brackets to represent a named edge. For example: `-[e]-`. | | Match an edge type | `MATCH ()-[e:follow]-() RETURN e LIMIT 5` |Just like vertices, you can specify an edge type with `:` in a pattern. For example: `-[e:follow]-`. | - | Match edge type properties | ` MATCH (v:player{name:"Tim Duncan"})-[e:follow{degree:95}]->(v2) RETURN e` | You can specify edge type properties with `{: }` in a pattern. For example: `[e:follow{likeness:95}]`. | + | Match edge type properties | ` MATCH (v:player{name:"Tim Duncan"})-[e:follow{degree:95}]->(v2) RETURN e`

`MATCH ()-[e]->() WITH e, properties(e) as props, keys(properties(e)) as kk LIMIT 10000 WHERE [i in kk where props[i] == 90] RETURN e`| You can specify edge type properties with `{: }` in a pattern. For example: `[e:follow{likeness:95}]`; or use an edge type property value to get edges directly. | | Match multiple edge types | `MATCH (v:player{name:"Tim Duncan"})-[e:follow | :serve]->(v2) RETURN e` | The `|` symbol can help matching multiple edge types. For example: `[e:follow|:serve]`. The English colon (:) before the first edge type cannot be omitted, but the English colon before the subsequent edge type can be omitted, such as `[e:follow|serve]`. | | Match multiple edges | `MATCH (v:player{name:"Tim Duncan"})-[]->(v2)<-[e:serve]-(v3) RETURN v2, v3` | You can extend a pattern to match multiple edges in a path. | | Match fixed-length paths | `MATCH p=(v:player{name:"Tim Duncan"})-[e:follow*2]->(v2) RETURN DISTINCT v2 AS Friends` | You can use the `:*` pattern to match a fixed-length path. `hop` must be a non-negative integer. The data type of `e` is the list.| diff --git a/docs-2.0/3.ngql-guide/7.general-query-statements/2.match.md b/docs-2.0/3.ngql-guide/7.general-query-statements/2.match.md index 57ecaf5f21c..6c574dbc037 100644 --- a/docs-2.0/3.ngql-guide/7.general-query-statements/2.match.md +++ b/docs-2.0/3.ngql-guide/7.general-query-statements/2.match.md @@ -195,6 +195,21 @@ nebula> MATCH (v:player) \ In openCypher 9, `=` is the equality operator. However, in nGQL, `==` is the equality operator and `=` is the assignment operator (as in C++ or Java). + +You also use properties without specifying a tag to get vertices directly. For example, to get all the vertices with the vertex property value Tim Duncan. + +```ngql +nebula> MATCH (v) \ + WITH v, properties(v) as props, keys(properties(v)) as kk \ + LIMIT 10000 WHERE [i in kk where props[i] == "Tim Duncan"] \ + RETURN v; ++----------------------------------------------------+ +| v | ++----------------------------------------------------+ +| ("player100" :player{age: 42, name: "Tim Duncan"}) | ++----------------------------------------------------+ +``` + ### Match VIDs You can use the VID to match a vertex. The `id()` function can retrieve the VID of a vertex. @@ -399,6 +414,25 @@ nebula> MATCH (v:player{name:"Tim Duncan"})-[e:follow{degree:95}]->(v2) \ +--------------------------------------------------------+ ``` + +You also use properties without specifying an edge type to get edges directly. For example, to get all the edges with the edge property value 90. + +```ngql +nebula> MATCH ()-[e]->() \ + WITH e, properties(e) as props, keys(properties(e)) as kk \ + LIMIT 10000 WHERE [i in kk where props[i] == 90] \ + RETURN e; ++----------------------------------------------------+ +| e | ++----------------------------------------------------+ +| [:follow "player125"->"player100" @0 {degree: 90}] | +| [:follow "player140"->"player114" @0 {degree: 90}] | +| [:follow "player133"->"player144" @0 {degree: 90}] | +| [:follow "player133"->"player114" @0 {degree: 90}] | +... ++----------------------------------------------------+ +``` + ### Match multiple edge types The `|` symbol can help matching multiple edge types. For example: `[e:follow|:serve]`. The English colon (:) before the first edge type cannot be omitted, but the English colon before the subsequent edge type can be omitted, such as `[e:follow|serve]`. From 9eff79ad401c78d8ec5462453676ebc63e18e9a9 Mon Sep 17 00:00:00 2001 From: cooper-lzy <78672629+cooper-lzy@users.noreply.github.com> Date: Wed, 23 Nov 2022 14:16:23 +0800 Subject: [PATCH 51/89] Update 2.deploy-connect-dashboard-ent.md --- .../2.deploy-connect-dashboard-ent.md | 50 ------------------- 1 file changed, 50 deletions(-) diff --git a/docs-2.0/nebula-dashboard-ent/2.deploy-connect-dashboard-ent.md b/docs-2.0/nebula-dashboard-ent/2.deploy-connect-dashboard-ent.md index 99c9e5c8155..b4375553c84 100644 --- a/docs-2.0/nebula-dashboard-ent/2.deploy-connect-dashboard-ent.md +++ b/docs-2.0/nebula-dashboard-ent/2.deploy-connect-dashboard-ent.md @@ -201,31 +201,6 @@ sudo /dashboard/scripts/dashboard.service restart all #Restart Dashboard. sudo rpm -i nebula-dashboard-ent-xxx.rpm --prefix= ``` - During the installation process, you need to enter the path to the license and choose a database for storing Dashboard metadata. Currently, we support MySQL and SQLite. - - For example: - - === "SQLite" - - ```bash - NebulaGraph Dashboard Enterprise version need license, please enter the license file path(~/nebula.license): /home/vesoft/license/nebula.license - Which database do you want to use? [sqlite | mysql]:sqlite # The default value is SQLite. - Do you want to start the service now? [Y/N]: y - ``` - === "MySQL" - - ```bash - Nebula Dashboard Enterprise version need license please enter the license file path(~/nebula.license): /home/vesoft/license/nebula.license - Which database do you want to use? [sqlite | mysql]:mysql - Step1: set mysql database config - Enter mysql host(127.0.0.1): 192.168.8.157 # The IP address of the connected MySQL database. - Enter mysql service port(3306): # The port of the connected MySQL database. The default port is 3306. - Enter mysql username(root): # The username to log in MySQL. - Enter mysql password(nebula): # The password to log in MySQL. - Enter mysql database name(dashboard): # The name of the corresponding database. - Do you want to start the service now? [Y/N]: y - ``` - 3. (Optional) Run the following commands to view the status of and start all the services. ``` @@ -319,31 +294,6 @@ sudo rpm -e sudo dpkg -i nebula-dashboard-ent-{{dashboard_ent.release}}.ubuntu1804.amd64.deb ``` - During the installation process, you need to enter the path to the license and choose a database for storing Dashboard metadata. Currently, we support MySQL and SQLite. - - For example: - - === "SQLite" - - ```bash - NebulaGraph Dashboard Enterprise version need license, please enter the license file path(~/nebula.license): /home/vesoft/license/nebula.license - Which database do you want to use? [sqlite | mysql]:sqlite # The default value is SQLite. - Do you want to start the service now? [Y/N]: y - ``` - === "MySQL" - - ```bash - Nebula Dashboard Enterprise version need license please enter the license file path(~/nebula.license): /home/vesoft/license/nebula.license - Which database do you want to use? [sqlite | mysql]:mysql - Step1: set mysql database config - Enter mysql host(127.0.0.1): 192.168.8.157 # The IP address of the connected MySQL database. - Enter mysql service port(3306): # The port of the connected MySQL database. The default port is 3306. - Enter mysql username(root): # The username to log in MySQL. - Enter mysql password(nebula): # The password to log in MySQL. - Enter mysql database name(dashboard): # The name of the corresponding database. - Do you want to start the service now? [Y/N]: y - ``` - 3. (Optional) Run the following commands to view the status of and start all the services. ``` From e3ad86ec80247467c622d3f09babc2def7ea80b3 Mon Sep 17 00:00:00 2001 From: cooper-lzy <78672629+cooper-lzy@users.noreply.github.com> Date: Thu, 24 Nov 2022 09:20:02 +0800 Subject: [PATCH 52/89] Dashboard update 3.2.2 (#1775) --- .../dashboard-ent-release-note.md | 20 +++++++++++++++++++ .../1.what-is-dashboard-ent.md | 2 +- mkdocs.yml | 4 ++-- 3 files changed, 23 insertions(+), 3 deletions(-) diff --git a/docs-2.0/20.appendix/release-notes/dashboard-ent-release-note.md b/docs-2.0/20.appendix/release-notes/dashboard-ent-release-note.md index 3fc0475bbc6..0e02a6880f3 100644 --- a/docs-2.0/20.appendix/release-notes/dashboard-ent-release-note.md +++ b/docs-2.0/20.appendix/release-notes/dashboard-ent-release-note.md @@ -1,5 +1,25 @@ # NebulaGraph Dashboard Enterprise Edition release notes +## Enterprise Edition v3.2.2 + +- Enhancement + + - Delete unnecessary public folders. + +- Bugfix + + - Fixed the bug that the RPM and DEB packages could not automatically register services with the Dashboard. + +## Enterprise Edition v3.2.1 + +- Enhancement + + - Add NebulaGraph 3.3.0 version to download list. + +- Bugfix + + - Fixed the bug that the BR failed in NebulaGraph Community 3.3.0 version. + ## Enterprise Edition 3.2.0 - Feature diff --git a/docs-2.0/nebula-dashboard-ent/1.what-is-dashboard-ent.md b/docs-2.0/nebula-dashboard-ent/1.what-is-dashboard-ent.md index f00752d719d..53915b949d0 100644 --- a/docs-2.0/nebula-dashboard-ent/1.what-is-dashboard-ent.md +++ b/docs-2.0/nebula-dashboard-ent/1.what-is-dashboard-ent.md @@ -60,7 +60,7 @@ The version correspondence between NebulaGraph and Dashboard Enterprise Edition |NebulaGraph version|Dashboard version| |:---|:---| -|3.3.0 |3.2.0| +|3.3.0 |3.2.2, 3.2.1, 3.2.0| |2.5.0 ~ 3.2.0|3.1.2, 3.1.1, 3.1.0| |2.5.x ~ 3.1.0|3.0.4| |2.5.1 ~ 3.0.0|1.1.0| diff --git a/mkdocs.yml b/mkdocs.yml index 082e1d62da8..62198163943 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -194,8 +194,8 @@ extra: base100: 1.0.0 branch: release-3.2 dashboard_ent: - release: 3.2.0 - tag: v3.2.0 + release: 3.2.2 + tag: v3.2.2 branch: release-3.2 console: release: 3.3.1 From 15691b9a474e6055cffb815976ba6332995ef8bb Mon Sep 17 00:00:00 2001 From: "abby.huang" <78209557+abby-cyber@users.noreply.github.com> Date: Thu, 24 Nov 2022 14:13:08 +0800 Subject: [PATCH 53/89] add-note-for-supporting-arm (#1776) --- .../1.resource-preparations.md | 9 +++++++++ .../3.deploy-nebula-graph-with-docker-compose.md | 1 - 2 files changed, 9 insertions(+), 1 deletion(-) diff --git a/docs-2.0/4.deployment-and-installation/1.resource-preparations.md b/docs-2.0/4.deployment-and-installation/1.resource-preparations.md index ed17bde7890..a974f60b333 100644 --- a/docs-2.0/4.deployment-and-installation/1.resource-preparations.md +++ b/docs-2.0/4.deployment-and-installation/1.resource-preparations.md @@ -19,11 +19,20 @@ NebulaGraph is designed and implemented for NVMe SSD. All default parameters are - Use local SSD devices, or AWS Provisioned IOPS SSD equivalence. ## About CPU architecture + +{{ ent.ent_begin }} +!!! enterpriseonly + + You can run NebulaGraph Enterprise Edition on ARM, including Apple Mac M1 and Huawei Kunpeng. [Contact us](https://nebula-graph.com.cn/pricing/) for details. + +{{ ent.ent_end }} !!! note Starting with 3.0.2, you can run containerized NebulaGraph databases on Docker Desktop for ARM macOS or on ARM Linux servers. + + ## Requirements for compiling the source code ### Hardware requirements for compiling NebulaGraph diff --git a/docs-2.0/4.deployment-and-installation/2.compile-and-install-nebula-graph/3.deploy-nebula-graph-with-docker-compose.md b/docs-2.0/4.deployment-and-installation/2.compile-and-install-nebula-graph/3.deploy-nebula-graph-with-docker-compose.md index 57db0b87299..86b1c840293 100644 --- a/docs-2.0/4.deployment-and-installation/2.compile-and-install-nebula-graph/3.deploy-nebula-graph-with-docker-compose.md +++ b/docs-2.0/4.deployment-and-installation/2.compile-and-install-nebula-graph/3.deploy-nebula-graph-with-docker-compose.md @@ -42,7 +42,6 @@ Using Docker Compose can quickly deploy NebulaGraph services based on the prepar 3. Run the following command to start all the NebulaGraph services. - Starting with 3.0.2, NebulaGraph comes with ARM64 Linux Docker images. You can run containerized NebulaGraph databases on Docker Desktop for ARM macOS or on ARM Linux servers. !!! Note From 70d8d7921a4aebd4bb7d685557eb9ade6ae9df0b Mon Sep 17 00:00:00 2001 From: "abby.huang" <78209557+abby-cyber@users.noreply.github.com> Date: Fri, 25 Nov 2022 14:15:15 +0800 Subject: [PATCH 54/89] why-space-0-not-found (#1777) --- .../3.upgrade-nebula-graph/upgrade-nebula-graph-to-latest.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs-2.0/4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-graph-to-latest.md b/docs-2.0/4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-graph-to-latest.md index b7cf05810e6..db57efc7f95 100644 --- a/docs-2.0/4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-graph-to-latest.md +++ b/docs-2.0/4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-graph-to-latest.md @@ -161,6 +161,11 @@ All NebulaGraph clients in use must be switched to the old version. A: No. You must stop all NebulaGraph services during the upgrade. + +### The `Space 0 not found` warning message during the upgrade process + +When the `Space 0 not found` warning message appears during the upgrade process, you can ignore it. The space `0` is used to store meta information about the Storage service and does not contain user data, so it will not affect the upgrade. + ### How to upgrade if a machine has only the Graph Service, but not the Storage Service? A: You only need to update the configuration files and binaries of the Graph Service. From c840e47c4b0f116b046102a97504ecfcf973c33f Mon Sep 17 00:00:00 2001 From: "abby.huang" <78209557+abby-cyber@users.noreply.github.com> Date: Fri, 25 Nov 2022 14:17:24 +0800 Subject: [PATCH 55/89] why-space-0-not-found (#1778) From 59abcc3328c0cfffde29a4a18df7581488101541 Mon Sep 17 00:00:00 2001 From: "abby.huang" <78209557+abby-cyber@users.noreply.github.com> Date: Fri, 25 Nov 2022 17:08:08 +0800 Subject: [PATCH 56/89] br-opts-330 (#1782) --- .../nebula-br/1.what-is-br.md | 5 +- .../nebula-br/2.compile-br.md | 75 +++++++++++++++++++ .../nebula-br/3.br-backup-data.md | 26 +++---- .../nebula-br/4.br-restore-data.md | 24 +++--- mkdocs.yml | 2 +- 5 files changed, 103 insertions(+), 29 deletions(-) diff --git a/docs-2.0/backup-and-restore/nebula-br/1.what-is-br.md b/docs-2.0/backup-and-restore/nebula-br/1.what-is-br.md index 7d338f647b2..762125f8b49 100644 --- a/docs-2.0/backup-and-restore/nebula-br/1.what-is-br.md +++ b/docs-2.0/backup-and-restore/nebula-br/1.what-is-br.md @@ -19,11 +19,10 @@ The BR has the following features. It supports: - Supports full backup, but not incremental backup. - Currently, NebulaGraph Listener and full-text indexes do not support backup. - If you back up data to the local disk, the backup files will be saved in the local path of each server. You can also mount the NFS on your host to restore the backup data to a different host. -- The backup graph space can be restored to the original cluster only. Cross clusters restoration is not supported. - During the backup process, both DDL and DML statements in the specified graph spaces are blocked. We recommend that you do the operation within the low peak period of the business, for example, from 2:00 AM to 5:00 AM. -- Restoration requires that the number of the storage servers in the original cluster is the same as that of the storage servers in the target cluster and storage server IPs must be the same. +- The backup graph space can be restored to the original cluster only. Cross clusters restoration is not supported. Make sure the number of hosts in the cluster is not changed. Restoring a specified graph space will delete all other graph spaces in the cluster. +- Restoration requires that the number of the storage servers in the original cluster is the same as that of the storage servers in the target cluster and storage server IPs must be the same. Restoring the specified space will clear all the remaining spaces in the cluster. - During the restoration process, there is a time when NebulaGraph stops running. -- If you back up data of a specified graph space in cluster A and restore the graph space data to cluster B, the data of other graph spaces in cluster B will be deleted. - Using BR in a container-based NebulaGraph cluster is not supported. diff --git a/docs-2.0/backup-and-restore/nebula-br/2.compile-br.md b/docs-2.0/backup-and-restore/nebula-br/2.compile-br.md index f6c36363c54..b1a5169fa50 100644 --- a/docs-2.0/backup-and-restore/nebula-br/2.compile-br.md +++ b/docs-2.0/backup-and-restore/nebula-br/2.compile-br.md @@ -2,6 +2,18 @@ This topic introduces how to install BR. + +## Notes + +To use the BR (Enterprise Edition) tool, you need to install the NebulaGraph Agent service, which is taken as a daemon for each machine in the cluster that starts and stops the NebulaGraph service, and uploads and downloads backup files. The BR (Enterprise Edition) tool and the Agent plug-in are installed as described below. + + +## Version compatibility + +|NebulaGraph|BR |Agent | +|:---|:---|:---| +|3.3.0|3.3.0|0.2.0| + ## Install BR with a binary file 1. Install BR. @@ -64,3 +76,66 @@ Users can enter `bin/br version` on the command line. If the following results a [nebula-br]$ bin/br version NebulaGraph Backup And Restore Utility Tool,V-{{br.release}} ``` + +## Install Agent + +NebulaGraph Agent is installed as a binary file in each machine and serves the BR tool with the RPC protocol. + +In **each machine**, follow these steps: + +1. Install Agent. + + ``` + wget https://github.com/vesoft-inc/nebula-agent/releases/download/v{{agent.release}}/agent-{{agent.release}}-linux-amd64 + ``` + +2. Rename the Agent file to `agent`. + + ``` + sudo mv agent-{{agent.release}}-linux-amd64 agent + ``` + +3. Add execute permission to Agent. + + ``` + sudo chmod +x agent + ``` + +4. Start Agent. + + !!! note + + Before starting Agent, make sure that the Meta service has been started and Agent has read and write access to the corresponding NebulaGraph cluster directory and backup directory. + + ``` + sudo nohup ./nebula_agent --agent=":8888" --meta=":9559" > nebula_agent.log 2>&1 & + ``` + + - `--agent`: The IP address and port number of Agent. + - `--meta`: The IP address and access port of any Meta service in the cluster. + - `--ratelimit`: (Optional) Limits the speed of file uploads and downloads to prevent bandwidth from being filled up and making other services unavailable. Unit: Bytes. + + For example: + + ``` + sudo nohup ./nebula_agent --agent="192.168.8.129:8888" --meta="192.168.8.129:9559" --ratelimit=1048576 > nebula_agent.log 2>&1 & + ``` + !!! caution + + The IP address format for `--agent`should be the same as that of Meta and Storage services set in the [configuration files](../../5.configurations-and-logs/1.configurations/1.configurations.md). That is, use the real IP addresses or use `127.0.0.1`. Otherwise Agent does not run. + +1. Log into NebulaGraph and then run the following command to view the status of Agent. + + ``` + nebula> SHOW HOSTS AGENT; + +-----------------+------+----------+---------+--------------+---------+ + | Host | Port | Status | Role | Git Info Sha | Version | + +-----------------+------+----------+---------+--------------+---------+ + | "192.168.8.129" | 8888 | "ONLINE" | "AGENT" | "96646b8" | | + +-----------------+------+----------+---------+--------------+---------+ + ``` + +## FAQ + +### The error `E_LIST_CLUSTER_NO_AGENT_FAILURE +If you encounter `E_LIST_CLUSTER_NO_AGENT_FAILURE` error, it may be due to the Agent service is not started or the Agent service is not registered to Meta service. First, execute `SHOW HOSTS AGENT` to check the status of the Agent service on all nodes in the cluster, when the status shows `OFFLINE`, it means the registration of Agent failed, then check whether the value of the `--meta` option in the command to start the Agent service is correct. \ No newline at end of file diff --git a/docs-2.0/backup-and-restore/nebula-br/3.br-backup-data.md b/docs-2.0/backup-and-restore/nebula-br/3.br-backup-data.md index f2b4578e5b8..bbbdbe39ce1 100644 --- a/docs-2.0/backup-and-restore/nebula-br/3.br-backup-data.md +++ b/docs-2.0/backup-and-restore/nebula-br/3.br-backup-data.md @@ -1,17 +1,15 @@ # Use BR to back up data -After the BR is compiled, you can back up data of the entire graph space. This topic introduces how to use the BR to back up data. +After the BR is installed, you can back up data of the entire graph space. This topic introduces how to use the BR to back up data. ## Prerequisites To back up data with the BR, do a check of these: -- The BR is compiled. For more information, see [Compile BR](2.compile-br.md). +- [Install BR and Agent](2.compile-br.md) and run Agent on each host in the cluster. - The NebulaGraph services are running. -- The [nebula-agent](https://github.com/vesoft-inc/nebula-agent) has been downloaded and the nebula-agent service is running on each host in the cluster. - - If you store the backup files locally, create a directory with the same absolute path on the meta servers, the storage servers, and the BR machine for the backup files and get the absolute path. Make sure the account has write privileges for this directory. !!! note @@ -20,19 +18,19 @@ To back up data with the BR, do a check of these: ## Procedure -Run the following command to perform a full backup for the entire cluster. +In the BR installation directory (the default path of the compiled BR is `./bin/br`), run the following command to perform a full backup for the entire cluster. !!! Note Make sure that the local path where the backup file is stored exists. ```bash -$ ./bin/br backup full --meta --storage +$ ./br backup full --meta --storage ``` For example: -- Run the following command to perform a full backup for the entire cluster whose meta service address is `127.0.0.1:9559`, and save the backup file to `/home/nebula/backup/`. +- Run the following command to perform a full backup for the entire cluster whose meta service address is `192.168.8.129:9559`, and save the backup file to `/home/nebula/backup/`. !!! caution @@ -43,13 +41,13 @@ For example: If you back up data to a local disk, only the data of the leader metad is backed up by default. So if there are multiple metad processes, you need to manually copy the directory of the leader metad (path `/meta`) and overwrite the corresponding directory of other follower meatd processes. ```bash - $ ./bin/br backup full --meta "127.0.0.1:9559" --storage "local:///home/nebula/backup/" + $ ./br backup full --meta "192.168.8.129:9559" --storage "local:///home/nebula/backup/" ``` -- Run the following command to perform a full backup for the entire cluster whose meta service address is `127.0.0.1:9559`, and save the backup file to `backup` in the `br-test` bucket of the object storage service compatible with S3 protocol. +- Run the following command to perform a full backup for the entire cluster whose meta service address is `192.168.8.129:9559`, and save the backup file to `backup` in the `br-test` bucket of the object storage service compatible with S3 protocol. ```bash - $ ./bin/br backup full --meta "127.0.0.1:9559" --s3.endpoint "http://127.0.0.1:9000" --storage="s3://br-test/backup/" --s3.access_key=minioadmin --s3.secret_key=minioadmin --s3.region=default + $ ./br backup full --meta "192.168.8.129:9559" --s3.endpoint "http://192.168.8.129:9000" --storage="s3://br-test/backup/" --s3.access_key=minioadmin --s3.secret_key=minioadmin --s3.region=default ``` The parameters are as follows. @@ -57,10 +55,10 @@ The parameters are as follows. | Parameter | Data type | Required | Default value | Description | | --- | --- | --- | --- | --- | | `-h,-help` | - | No | None | Checks help for restoration. | -| `-debug` | - | No | None | Checks for more log information. | -| `-log` | string | No | `"br.log"` | Specifies detailed log path for restoration and backup. | -| `-meta` | string | Yes | None | The IP address and port of the meta service. | -| `-name` | string | Yes | None | The name of backup. | +| `--debug` | - | No | None | Checks for more log information. | +| `--log` | string | No | `"br.log"` | Specifies detailed log path for restoration and backup. | +| `--meta` | string | Yes | None | The IP address and port of the meta service. | +| `--space` | string | Yes | None | (Experimental feature) Specifies the names of the spaces to be backed up. All spaces will be backed up if not specified. Multiple spaces can be specified, and format is `--spaces nba_01 --spaces nba_02`.| | `--storage` | string | Yes | None | The target storage URL of BR backup data. The format is: \://\.
Schema: Optional values are `local` and `s3`.
When selecting s3, you need to fill in `s3.access_key`, `s3.endpoint`, `s3.region`, and `s3.secret_key`.
PATH: The path of the storage location. | | `--s3.access_key` | string | No | None | Sets AccessKey ID. | | `--s3.endpoint` | string | No | None | Sets the S3 endpoint URL, please specify the HTTP or HTTPS scheme explicitly. | diff --git a/docs-2.0/backup-and-restore/nebula-br/4.br-restore-data.md b/docs-2.0/backup-and-restore/nebula-br/4.br-restore-data.md index eed0d70fe75..86e40e8bc8f 100644 --- a/docs-2.0/backup-and-restore/nebula-br/4.br-restore-data.md +++ b/docs-2.0/backup-and-restore/nebula-br/4.br-restore-data.md @@ -14,7 +14,7 @@ If you use the BR to back up data, you can use it to restore the data to NebulaG To restore data with the BR, do a check of these: -- The BR is compiled. For more information, see [Compile BR](2.compile-br.md). +- [Install BR and Agent](2.compile-br.md) and run Agent on each host in the cluster. - Download [nebula-agent](https://github.com/vesoft-inc/nebula-agent) and start the agent service in each cluster(including metad, storaged, graphd) host. @@ -24,14 +24,16 @@ To restore data with the BR, do a check of these: ## Procedures +In the BR installation directory (the default path of the compiled BR is `./br`), run the following command to perform a full backup for the entire cluster. + 1. Users can use the following command to list the existing backup information: ```bash - $ ./bin/br show --storage + $ ./br show --storage ``` For example, run the following command to list the backup information in the local `/home/nebula/backup` path. ```bash - $ ./bin/br show --storage "local:///home/nebula/backup" + $ ./br show --storage "local:///home/nebula/backup" +----------------------------+---------------------+------------------------+-------------+------------+ | NAME | CREATE TIME | SPACES | FULL BACKUP | ALL SPACES | +----------------------------+---------------------+------------------------+-------------+------------+ @@ -40,9 +42,9 @@ To restore data with the BR, do a check of these: +----------------------------+---------------------+------------------------+-------------+------------+ ``` - Or, you can run the following command to list the backup information stored in S3 URL `s3://127.0.0.1:9000/br-test/backup`. + Or, you can run the following command to list the backup information stored in S3 URL `s3://192.168.8.129:9000/br-test/backup`. ```bash - $ ./bin/br show --s3.endpoint "http://127.0.0.1:9000" --storage="s3://br-test/backup/" --s3.access_key=minioadmin --s3.secret_key=minioadmin --s3.region=default + $ ./br show --s3.endpoint "http://192.168.8.129:9000" --storage="s3://br-test/backup/" --s3.access_key=minioadmin --s3.secret_key=minioadmin --s3.region=default ``` | Parameter | Data type | Required | Default value | Description | @@ -60,18 +62,18 @@ To restore data with the BR, do a check of these: 2. Run the following command to restore data. ``` - $ ./bin/br restore full --meta --storage --name + $ ./br restore full --meta --storage --name ``` - For example, run the following command to upload the backup files from the local `/home/nebula/backup/` to the cluster where the meta service's address is `127.0.0.1:9559`. + For example, run the following command to upload the backup files from the local `/home/nebula/backup/` to the cluster where the meta service's address is `192.168.8.129:9559`. ``` - $ ./bin/br restore full --meta "127.0.0.1:9559" --storage "local:///home/nebula/backup/" --name BACKUP_2021_12_08_18_38_08 + $ ./br restore full --meta "192.168.8.129:9559" --storage "local:///home/nebula/backup/" --name BACKUP_2021_12_08_18_38_08 ``` - Or, you can run the following command to upload the backup files from the S3 URL `s3://127.0.0.1:9000/br-test/backup`. + Or, you can run the following command to upload the backup files from the S3 URL `s3://192.168.8.129:9000/br-test/backup`. ```bash - $ ./bin/br restore full --meta "127.0.0.1:9559" --s3.endpoint "http://127.0.0.1:9000" --storage="s3://br-test/backup/" --s3.access_key=minioadmin --s3.secret_key=minioadmin --s3.region="default" --name BACKUP_2021_12_08_18_38_08 + $ ./br restore full --meta "192.168.8.129:9559" --s3.endpoint "http://192.168.8.129:9000" --storage="s3://br-test/backup/" --s3.access_key=minioadmin --s3.secret_key=minioadmin --s3.region="default" --name BACKUP_2021_12_08_18_38_08 ``` If the following information is returned, the data is restored successfully. @@ -101,7 +103,7 @@ To restore data with the BR, do a check of these: 3. Run the following command to clean up temporary files if any error occurred during backup. It will clean the files in cluster and external storage. You could also use it to clean up old backups files in external storage. ```bash - $ ./bin/br cleanup --meta --storage --name + $ ./br cleanup --meta --storage --name ``` The parameters are as follows. diff --git a/mkdocs.yml b/mkdocs.yml index 62198163943..b2e89cffff7 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -484,7 +484,7 @@ nav: - Backup & Restore: - NebulaGraph BR (Community Edition): - What is Backup & Restore (Community Edition): backup-and-restore/nebula-br/1.what-is-br.md - - Compile BR: backup-and-restore/nebula-br/2.compile-br.md + - Install BR: backup-and-restore/nebula-br/2.compile-br.md - Use BR to back up data: backup-and-restore/nebula-br/3.br-backup-data.md - Use BR to restore data: backup-and-restore/nebula-br/4.br-restore-data.md #ent From 65cae04c6a4af4e477e1e586569b048546dcc561 Mon Sep 17 00:00:00 2001 From: "abby.huang" <78209557+abby-cyber@users.noreply.github.com> Date: Mon, 28 Nov 2022 14:01:40 +0800 Subject: [PATCH 57/89] add-release-notes-on-the-default-page (#1783) --- docs-2.0/README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/docs-2.0/README.md b/docs-2.0/README.md index e901b62effb..9d21bcf2dc7 100644 --- a/docs-2.0/README.md +++ b/docs-2.0/README.md @@ -16,6 +16,17 @@ NebulaGraph is a distributed, scalable, and lightning-fast graph database. It is the optimal solution in the world capable of hosting graphs with dozens of billions of vertices (nodes) and trillions of edges (relationships) with millisecond latency. + +## Release notes + +- [NebulaGraph Community Edition {{ nebula.release }}](20.appendix/release-notes/nebula-comm-release-note.md) + +- [NebulaGraph Studio](20.appendix/release-notes/studio-release-note.md) +- [NebulaGraph Explorer](20.appendix/release-notes/explorer-release-note.md) +- [NebulaGraph Dashboard Community Edition](20.appendix/release-notes/dashboard-comm-release-note.md) +- [NebulaGraph Dashboard Enterprise Edition](20.appendix/release-notes/dashboard-ent-release-note.md) + + ## Getting started * [Learning path](20.appendix/learning-path.md) & [Get NebulaGraph Certifications](https://academic.nebula-graph.io/?lang=EN_US) From 44f48499cbfa90b11b599a6fc20c185e44a21311 Mon Sep 17 00:00:00 2001 From: "abby.huang" <78209557+abby-cyber@users.noreply.github.com> Date: Mon, 28 Nov 2022 16:05:44 +0800 Subject: [PATCH 58/89] Update 4.schema.md (#1784) --- docs-2.0/3.ngql-guide/6.functions-and-expressions/4.schema.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs-2.0/3.ngql-guide/6.functions-and-expressions/4.schema.md b/docs-2.0/3.ngql-guide/6.functions-and-expressions/4.schema.md index 096a5115ec3..8f89178af12 100644 --- a/docs-2.0/3.ngql-guide/6.functions-and-expressions/4.schema.md +++ b/docs-2.0/3.ngql-guide/6.functions-and-expressions/4.schema.md @@ -339,7 +339,7 @@ nebula> MATCH (v:player{name:"Tim Duncan"})-[e]->() \ ### startNode() -startNode() visits an edge or a path and returns its information of source vertex ID, including VIDs, tags, properties, and values. +startNode() visits a path and returns its information of source vertex ID, including VIDs, tags, properties, and values. Syntax: `startNode()` @@ -357,7 +357,7 @@ nebula> MATCH p = (a :player {name : "Tim Duncan"})-[r:serve]-(t) \ ### endNode() -endNode() visits an edge or a path and returns its information of destination vertex ID, including VIDs, tags, properties, and values. +endNode() visits a path and returns its information of destination vertex ID, including VIDs, tags, properties, and values. Syntax: `endNode()` From 90b4cb7e3de87f89e11c492dbfa8249ac744997b Mon Sep 17 00:00:00 2001 From: "abby.huang" <78209557+abby-cyber@users.noreply.github.com> Date: Mon, 28 Nov 2022 18:39:56 +0800 Subject: [PATCH 59/89] Add release notes on the default page (#1787) * add-release-notes-on-the-default-page * Update README.md --- docs-2.0/README.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/docs-2.0/README.md b/docs-2.0/README.md index 9d21bcf2dc7..59c8e2cebe7 100644 --- a/docs-2.0/README.md +++ b/docs-2.0/README.md @@ -16,6 +16,16 @@ NebulaGraph is a distributed, scalable, and lightning-fast graph database. It is the optimal solution in the world capable of hosting graphs with dozens of billions of vertices (nodes) and trillions of edges (relationships) with millisecond latency. +## Getting started + +* [Learning path](20.appendix/learning-path.md) & [Get NebulaGraph Certifications](https://academic.nebula-graph.io/?lang=EN_US) +* [What is Nebula Graph](1.introduction/1.what-is-nebula-graph.md) +* [Quick start](2.quick-start/1.quick-start-workflow.md) +* [Preparations before deployment](4.deployment-and-installation/1.resource-preparations.md) +* [nGQL cheatsheet](2.quick-start/6.cheatsheet-for-ngql.md) +* [FAQ](20.appendix/0.FAQ.md) +* [Ecosystem Tools](20.appendix/6.eco-tool-version.md) + ## Release notes @@ -27,16 +37,6 @@ NebulaGraph is a distributed, scalable, and lightning-fast graph database. It is - [NebulaGraph Dashboard Enterprise Edition](20.appendix/release-notes/dashboard-ent-release-note.md) -## Getting started - -* [Learning path](20.appendix/learning-path.md) & [Get NebulaGraph Certifications](https://academic.nebula-graph.io/?lang=EN_US) -* [What is Nebula Graph](1.introduction/1.what-is-nebula-graph.md) -* [Quick start](2.quick-start/1.quick-start-workflow.md) -* [Preparations before deployment](4.deployment-and-installation/1.resource-preparations.md) -* [nGQL cheatsheet](2.quick-start/6.cheatsheet-for-ngql.md) -* [FAQ](20.appendix/0.FAQ.md) -* [Ecosystem Tools](20.appendix/6.eco-tool-version.md) - ## Other Sources - [To cite NebulaGraph](https://arxiv.org/abs/2206.07278) From 6fddec8278826cd9c1ebd414ca463aded02323e6 Mon Sep 17 00:00:00 2001 From: "abby.huang" <78209557+abby-cyber@users.noreply.github.com> Date: Tue, 29 Nov 2022 10:04:20 +0800 Subject: [PATCH 60/89] Update README.md --- docs-2.0/README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/docs-2.0/README.md b/docs-2.0/README.md index 59c8e2cebe7..148f0dc0198 100644 --- a/docs-2.0/README.md +++ b/docs-2.0/README.md @@ -41,7 +41,6 @@ NebulaGraph is a distributed, scalable, and lightning-fast graph database. It is - [To cite NebulaGraph](https://arxiv.org/abs/2206.07278) - [NebulaGraph Homepage](https://nebula-graph.io/) -- [Release notes](20.appendix/release-notes/nebula-comm-release-note.md) - [Forum](https://discuss.nebula-graph.io/) - [Blogs](https://nebula-graph.io/posts/) - [Videos](https://www.youtube.com/channel/UC73V8q795eSEMxDX4Pvdwmw) From bc7a89f3d015093acb2ca7b82c6d9bfb77c18c5d Mon Sep 17 00:00:00 2001 From: cooper-lzy <78672629+cooper-lzy@users.noreply.github.com> Date: Tue, 29 Nov 2022 13:51:19 +0800 Subject: [PATCH 61/89] Update 3.go.md (#1790) --- docs-2.0/3.ngql-guide/7.general-query-statements/3.go.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs-2.0/3.ngql-guide/7.general-query-statements/3.go.md b/docs-2.0/3.ngql-guide/7.general-query-statements/3.go.md index 5227625bd0f..acc24c17b18 100644 --- a/docs-2.0/3.ngql-guide/7.general-query-statements/3.go.md +++ b/docs-2.0/3.ngql-guide/7.general-query-statements/3.go.md @@ -47,7 +47,8 @@ YIELD [DISTINCT] !!! note - There are some restrictions for the `WHERE` clause when you traverse along with multiple edge types. For example, `WHERE edge1.prop1 > edge2.prop2` is not supported. + - There are some restrictions for the `WHERE` clause when you traverse along with multiple edge types. For example, `WHERE edge1.prop1 > edge2.prop2` is not supported. + - The GO statement is executed by traversing all the vertices and then filtering according to the filter condition. - `YIELD [DISTINCT] `: defines the output to be returned. It is recommended to use the [Schema function](../6.functions-and-expressions/4.schema.md) to fill in ``. `src(edge)`, `dst(edge)`, `type(edge) )`, `rank(edge)`, etc., are currently supported, while nested functions are not. For more information, see [YIELD](../8.clauses-and-options/yield.md). From 50927b9098a877a3f9bd82179d211df172a35d08 Mon Sep 17 00:00:00 2001 From: "abby.huang" <78209557+abby-cyber@users.noreply.github.com> Date: Tue, 29 Nov 2022 13:51:41 +0800 Subject: [PATCH 62/89] about-linux-operating-system (#1789) --- .../4.install-nebula-graph-from-tar.md | 5 ++++- docs-2.0/reuse/source_install-nebula-graph-by-rpm-or-deb.md | 4 ++++ 2 files changed, 8 insertions(+), 1 deletion(-) diff --git a/docs-2.0/4.deployment-and-installation/2.compile-and-install-nebula-graph/4.install-nebula-graph-from-tar.md b/docs-2.0/4.deployment-and-installation/2.compile-and-install-nebula-graph/4.install-nebula-graph-from-tar.md index 02931cbea41..35985eb7fae 100644 --- a/docs-2.0/4.deployment-and-installation/2.compile-and-install-nebula-graph/4.install-nebula-graph-from-tar.md +++ b/docs-2.0/4.deployment-and-installation/2.compile-and-install-nebula-graph/4.install-nebula-graph-from-tar.md @@ -4,7 +4,10 @@ You can install NebulaGraph by downloading the tar.gz file. !!! note - NebulaGraph provides installing with the tar.gz file starting from version 2.6.0. + - NebulaGraph provides installing with the tar.gz file starting from version 2.6.0. + + - NebulaGraph is currently only supported for installation on Linux systems, and only CentOS 7.x, CentOS 8.x, Ubuntu 16.04, Ubuntu 18.04, and Ubuntu 20.04 operating systems are supported. + ## Installation steps diff --git a/docs-2.0/reuse/source_install-nebula-graph-by-rpm-or-deb.md b/docs-2.0/reuse/source_install-nebula-graph-by-rpm-or-deb.md index 3ecab0c5b5f..4718f01cf35 100644 --- a/docs-2.0/reuse/source_install-nebula-graph-by-rpm-or-deb.md +++ b/docs-2.0/reuse/source_install-nebula-graph-by-rpm-or-deb.md @@ -15,6 +15,10 @@ Wget installed. ## Download the package from cloud service +!!! note + + NebulaGraph is currently only supported for installation on Linux systems, and only CentOS 7.x, CentOS 8.x, Ubuntu 16.04, Ubuntu 18.04, and Ubuntu 20.04 operating systems are supported. + * Download the released version. URL: From f107e2daf23231497d7b19b5f9825421f0ec3ea3 Mon Sep 17 00:00:00 2001 From: "abby.huang" <78209557+abby-cyber@users.noreply.github.com> Date: Wed, 30 Nov 2022 17:16:13 +0800 Subject: [PATCH 63/89] wording-revision-of-schema-related-functions (#1793) --- docs-2.0/2.quick-start/6.cheatsheet-for-ngql.md | 2 +- docs-2.0/3.ngql-guide/16.subgraph-and-path/1.get-subgraph.md | 2 +- .../4.variable-and-composite-queries/3.property-reference.md | 2 +- docs-2.0/3.ngql-guide/6.functions-and-expressions/4.schema.md | 4 ++-- docs-2.0/3.ngql-guide/7.general-query-statements/3.go.md | 2 +- mkdocs.yml | 2 +- 6 files changed, 7 insertions(+), 7 deletions(-) diff --git a/docs-2.0/2.quick-start/6.cheatsheet-for-ngql.md b/docs-2.0/2.quick-start/6.cheatsheet-for-ngql.md index d3dbbe73495..6818a1cd1d8 100644 --- a/docs-2.0/2.quick-start/6.cheatsheet-for-ngql.md +++ b/docs-2.0/2.quick-start/6.cheatsheet-for-ngql.md @@ -88,7 +88,7 @@ |time time() | Returns the current UTC time based on the current system. | |datetime datetime() | Returns the current UTC date and time based on the current system. | -* [Schema functions](../3.ngql-guide/6.functions-and-expressions/4.schema.md) +* [Schema-related functions](../3.ngql-guide/6.functions-and-expressions/4.schema.md) * For nGQL statements diff --git a/docs-2.0/3.ngql-guide/16.subgraph-and-path/1.get-subgraph.md b/docs-2.0/3.ngql-guide/16.subgraph-and-path/1.get-subgraph.md index 2aebd01fdd8..4573529c85c 100644 --- a/docs-2.0/3.ngql-guide/16.subgraph-and-path/1.get-subgraph.md +++ b/docs-2.0/3.ngql-guide/16.subgraph-and-path/1.get-subgraph.md @@ -36,7 +36,7 @@ While using the `WHERE` clause in a `GET SUBGRAPH` statement, note the following - **Only support** the `AND` operator. - **Only support** filter destination vertex, the vertex format must be `$$.tagName.propName`. - **Support** math functions, aggregate functions, string functions, datetime functions, type conversion functions and general functions in list functions. -- **Not support** aggregate functions, schema functions, conditional expression, predicate functions, geography function and user-defined functions. +- **Not support** aggregate functions, schema-related functions, conditional expression, predicate functions, geography function and user-defined functions. ## Examples diff --git a/docs-2.0/3.ngql-guide/4.variable-and-composite-queries/3.property-reference.md b/docs-2.0/3.ngql-guide/4.variable-and-composite-queries/3.property-reference.md index dba3a2b24e8..c98378461e7 100644 --- a/docs-2.0/3.ngql-guide/4.variable-and-composite-queries/3.property-reference.md +++ b/docs-2.0/3.ngql-guide/4.variable-and-composite-queries/3.property-reference.md @@ -95,7 +95,7 @@ nebula> GO FROM "player100" OVER follow YIELD follow._src, follow._dst, follow._ !!! compatibility "Legacy version compatibility" - NebulaGraph 2.6.0 and later versions support the new [Schema function](../6.functions-and-expressions/4.schema.md). Similar statements as the above examples are written as follows in {{ nebula.release}}. + NebulaGraph 2.6.0 and later versions support the new [Schema-related functions](../6.functions-and-expressions/4.schema.md). Similar statements as the above examples are written as follows in {{ nebula.release}}. ```ngql GO FROM "player100" OVER follow YIELD properties($^).name AS startName, properties($$).age AS endAge; diff --git a/docs-2.0/3.ngql-guide/6.functions-and-expressions/4.schema.md b/docs-2.0/3.ngql-guide/6.functions-and-expressions/4.schema.md index 8f89178af12..7517e59ff67 100644 --- a/docs-2.0/3.ngql-guide/6.functions-and-expressions/4.schema.md +++ b/docs-2.0/3.ngql-guide/6.functions-and-expressions/4.schema.md @@ -1,6 +1,6 @@ -# Schema functions +# Schema-related functions -This topic describes the schema functions supported by NebulaGraph. There are two types of schema functions, one for native nGQL statements and the other for openCypher-compatible statements. +This topic describes the schema-related functions supported by NebulaGraph. There are two types of schema-related functions, one for native nGQL statements and the other for openCypher-compatible statements. ## For nGQL statements diff --git a/docs-2.0/3.ngql-guide/7.general-query-statements/3.go.md b/docs-2.0/3.ngql-guide/7.general-query-statements/3.go.md index acc24c17b18..7aa6a95c5ec 100644 --- a/docs-2.0/3.ngql-guide/7.general-query-statements/3.go.md +++ b/docs-2.0/3.ngql-guide/7.general-query-statements/3.go.md @@ -50,7 +50,7 @@ YIELD [DISTINCT] - There are some restrictions for the `WHERE` clause when you traverse along with multiple edge types. For example, `WHERE edge1.prop1 > edge2.prop2` is not supported. - The GO statement is executed by traversing all the vertices and then filtering according to the filter condition. -- `YIELD [DISTINCT] `: defines the output to be returned. It is recommended to use the [Schema function](../6.functions-and-expressions/4.schema.md) to fill in ``. `src(edge)`, `dst(edge)`, `type(edge) )`, `rank(edge)`, etc., are currently supported, while nested functions are not. For more information, see [YIELD](../8.clauses-and-options/yield.md). +- `YIELD [DISTINCT] `: defines the output to be returned. It is recommended to use the [Schema-related functions](../6.functions-and-expressions/4.schema.md) to fill in ``. `src(edge)`, `dst(edge)`, `type(edge) )`, `rank(edge)`, etc., are currently supported, while nested functions are not. For more information, see [YIELD](../8.clauses-and-options/yield.md). - `SAMPLE `: takes samples from the result set. For more information, see [SAMPLE](../8.clauses-and-options/sample.md). diff --git a/mkdocs.yml b/mkdocs.yml index b2e89cffff7..fa1382b0e45 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -324,7 +324,7 @@ nav: - Aggregate functions: 3.ngql-guide/6.functions-and-expressions/15.aggregating.md - String functions: 3.ngql-guide/6.functions-and-expressions/2.string.md - Date and time functions: 3.ngql-guide/6.functions-and-expressions/3.date-and-time.md - - Schema functions: 3.ngql-guide/6.functions-and-expressions/4.schema.md + - Schema-related functions: 3.ngql-guide/6.functions-and-expressions/4.schema.md - List functions: 3.ngql-guide/6.functions-and-expressions/6.list.md - Type conversion functions: 3.ngql-guide/6.functions-and-expressions/16.type-conversion.md - Conditional expressions: 3.ngql-guide/6.functions-and-expressions/5.conditional-expressions.md From af965c269945034bf2995f5cc75c3d619bc37134 Mon Sep 17 00:00:00 2001 From: cooper-lzy <78672629+cooper-lzy@users.noreply.github.com> Date: Thu, 1 Dec 2022 10:27:59 +0800 Subject: [PATCH 64/89] dashboard release 3.2.3 (#1794) --- .../20.appendix/release-notes/dashboard-ent-release-note.md | 6 ++++++ docs-2.0/nebula-dashboard-ent/1.what-is-dashboard-ent.md | 2 +- mkdocs.yml | 4 ++-- 3 files changed, 9 insertions(+), 3 deletions(-) diff --git a/docs-2.0/20.appendix/release-notes/dashboard-ent-release-note.md b/docs-2.0/20.appendix/release-notes/dashboard-ent-release-note.md index 0e02a6880f3..2e2862e2211 100644 --- a/docs-2.0/20.appendix/release-notes/dashboard-ent-release-note.md +++ b/docs-2.0/20.appendix/release-notes/dashboard-ent-release-note.md @@ -1,5 +1,11 @@ # NebulaGraph Dashboard Enterprise Edition release notes +## Enterprise Edition v3.2.3 + +- Enhancement + + - Hidden Backup&Restore page if the NebulaGraph Enterprise Edition version is above 3.3.0. + ## Enterprise Edition v3.2.2 - Enhancement diff --git a/docs-2.0/nebula-dashboard-ent/1.what-is-dashboard-ent.md b/docs-2.0/nebula-dashboard-ent/1.what-is-dashboard-ent.md index 53915b949d0..d199a17afa5 100644 --- a/docs-2.0/nebula-dashboard-ent/1.what-is-dashboard-ent.md +++ b/docs-2.0/nebula-dashboard-ent/1.what-is-dashboard-ent.md @@ -60,7 +60,7 @@ The version correspondence between NebulaGraph and Dashboard Enterprise Edition |NebulaGraph version|Dashboard version| |:---|:---| -|3.3.0 |3.2.2, 3.2.1, 3.2.0| +|3.3.0 |3.2.3, 3.2.2, 3.2.1, 3.2.0| |2.5.0 ~ 3.2.0|3.1.2, 3.1.1, 3.1.0| |2.5.x ~ 3.1.0|3.0.4| |2.5.1 ~ 3.0.0|1.1.0| diff --git a/mkdocs.yml b/mkdocs.yml index fa1382b0e45..046149c595b 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -194,8 +194,8 @@ extra: base100: 1.0.0 branch: release-3.2 dashboard_ent: - release: 3.2.2 - tag: v3.2.2 + release: 3.2.3 + tag: v3.2.3 branch: release-3.2 console: release: 3.3.1 From 1a39f50396c43288163ceab50a2c5f0a590240ea Mon Sep 17 00:00:00 2001 From: cooper-lzy <78672629+cooper-lzy@users.noreply.github.com> Date: Thu, 1 Dec 2022 15:11:08 +0800 Subject: [PATCH 65/89] Update ex-ug-deploy.md --- docs-2.0/nebula-explorer/deploy-connect/ex-ug-deploy.md | 1 - 1 file changed, 1 deletion(-) diff --git a/docs-2.0/nebula-explorer/deploy-connect/ex-ug-deploy.md b/docs-2.0/nebula-explorer/deploy-connect/ex-ug-deploy.md index 7d4da6160b2..1c021f81561 100644 --- a/docs-2.0/nebula-explorer/deploy-connect/ex-ug-deploy.md +++ b/docs-2.0/nebula-explorer/deploy-connect/ex-ug-deploy.md @@ -259,7 +259,6 @@ The Dag Controller can perform complex graph computing with NebulaGraph Analytic Host: 0.0.0.0 # The IP address of Dag Controller. Port: 9002 # The port of Dag Controller. Timeout: 60000 # he timeout duration of HTTP interface requests. - RPC_HDFS_PASSWORD: "123456" # Reserved parameter. Log: # The parameters related to log printing. For more Information, see https://go-zero.dev/cn/docs/blog/tool/logx/ Mode: file # The log printing method From 252c7c94d9c6a60ffe45dd01ac9a36fb46c2f978 Mon Sep 17 00:00:00 2001 From: "abby.huang" <78209557+abby-cyber@users.noreply.github.com> Date: Thu, 1 Dec 2022 15:33:41 +0800 Subject: [PATCH 66/89] timestamp()-supports-int (#1795) --- docs-2.0/3.ngql-guide/3.data-types/4.date-and-time.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs-2.0/3.ngql-guide/3.data-types/4.date-and-time.md b/docs-2.0/3.ngql-guide/3.data-types/4.date-and-time.md index 2c50b1954b8..0bd4e23f70c 100644 --- a/docs-2.0/3.ngql-guide/3.data-types/4.date-and-time.md +++ b/docs-2.0/3.ngql-guide/3.data-types/4.date-and-time.md @@ -96,9 +96,9 @@ The `TIMESTAMP` data type is used for values that contain both date and time par - Supported `TIMESTAMP` inserting methods: timestamp, `timestamp()` function, and `now()` function. -- `timestamp()` function accepts empty arguments to get the current timestamp. +- `timestamp()` function accepts empty arguments to get the current timestamp. It can pass an integer arguments to identify the integer as a timestamp and the range of passed integer is: `0~9223372036`。 -- `timestamp()` function can convert `DATETIME` to `TIMESTAMP`. The data type of `DATETIME` should be a `string`. +- `timestamp()` function can convert `DATETIME` to `TIMESTAMP`, and the data type of `DATETIME` should be a `string`. - The underlying storage data type is **int64**. From d938da35346c5b059cda71177a11a253d9d55957 Mon Sep 17 00:00:00 2001 From: cooper-lzy <78672629+cooper-lzy@users.noreply.github.com> Date: Fri, 2 Dec 2022 13:57:03 +0800 Subject: [PATCH 67/89] Update 1.resource-preparations.md (#1797) --- .../4.deployment-and-installation/1.resource-preparations.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs-2.0/4.deployment-and-installation/1.resource-preparations.md b/docs-2.0/4.deployment-and-installation/1.resource-preparations.md index a974f60b333..6a922118597 100644 --- a/docs-2.0/4.deployment-and-installation/1.resource-preparations.md +++ b/docs-2.0/4.deployment-and-installation/1.resource-preparations.md @@ -200,7 +200,7 @@ For a more common test environment, such as a cluster of 3 machines (named as A, | CPU architecture | x86_64 | | Number of CPU core | 48 | | Memory | 256 GB | -| Disk | 1TB, NVMe SSD | +| Disk | 2 * 1.6 TB, NVMe SSD | ### Supported operating systems for production environments @@ -212,7 +212,7 @@ Users can adjust some of the kernel parameters to better accommodate the need fo !!! danger - **DO NOT** deploy a cluster across IDCs. + **DO NOT** deploy a single cluster across IDCs (The Enterprise Edtion supports data synchronization between clusters across IDCs). | Process | Suggested number | | ----------------------------------------- | ---------------- | From 74cf0a97334f14742a2d54748082120f64d4abc2 Mon Sep 17 00:00:00 2001 From: foesa <35463247+foesa-yang@users.noreply.github.com> Date: Fri, 2 Dec 2022 16:32:38 +0800 Subject: [PATCH 68/89] Update 5.lookup.md (#1798) --- docs-2.0/3.ngql-guide/7.general-query-statements/5.lookup.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs-2.0/3.ngql-guide/7.general-query-statements/5.lookup.md b/docs-2.0/3.ngql-guide/7.general-query-statements/5.lookup.md index c0fed0df54a..c601d942f93 100644 --- a/docs-2.0/3.ngql-guide/7.general-query-statements/5.lookup.md +++ b/docs-2.0/3.ngql-guide/7.general-query-statements/5.lookup.md @@ -54,10 +54,12 @@ YIELD [AS ]; The `WHERE` clause in a `LOOKUP` statement does not support the following operations: - `$-` and `$^`. +- Filter `rank()`. - In relational expressions, operators are not supported to have field names on both sides, such as `tagName.prop1> tagName.prop2`. - Nested AliasProp expressions in operation expressions and function expressions are not supported. - The `XOR` operation is not supported. - +- String operations other than `STARTS WITH` are not supported. +- Graph patterns. ## Retrieve vertices From 04d8714dbaaa2dd2a25c039fe4645ab64435c590 Mon Sep 17 00:00:00 2001 From: cooper-lzy <78672629+cooper-lzy@users.noreply.github.com> Date: Fri, 2 Dec 2022 18:02:23 +0800 Subject: [PATCH 69/89] Update 10.create-schema.md --- docs-2.0/nebula-explorer/db-management/10.create-schema.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs-2.0/nebula-explorer/db-management/10.create-schema.md b/docs-2.0/nebula-explorer/db-management/10.create-schema.md index 42386346334..e75259d63df 100644 --- a/docs-2.0/nebula-explorer/db-management/10.create-schema.md +++ b/docs-2.0/nebula-explorer/db-management/10.create-schema.md @@ -52,7 +52,7 @@ In the **Tag** and **Edge Type** lists, you can perform modification and deletio 2. Click the **Index** tab and click the **Create** button. 3. Set parameters. For descriptions of the parameters, see [CREATE INDEX](../../3.ngql-guide/14.native-index-statements/1.create-native-index.md). - !!! Note + !!! Note The order of the indexed properties has an effect on the result of the `LOOKUP` statement. For more information, see [LOOKUP](../../3.ngql-guide/7.general-query-statements/5.lookup.md). @@ -68,4 +68,4 @@ In the **Index** list, you can rebuild or delete the index. ## View schema 1. In the **Graph Space List** page, find a graph space and then click its name or click **Schema** in the **Operations** column. -2. Click **View Schema** tab and click the **Refresh** button. \ No newline at end of file +2. Click **View Schema** tab and click the **Refresh** button. From c7761bb279ce4d802f0c04c8169e57858b4755e5 Mon Sep 17 00:00:00 2001 From: cooper-lzy <78672629+cooper-lzy@users.noreply.github.com> Date: Mon, 5 Dec 2022 10:02:00 +0800 Subject: [PATCH 70/89] Update config-without-header.md --- docs-2.0/nebula-importer/config-without-header.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs-2.0/nebula-importer/config-without-header.md b/docs-2.0/nebula-importer/config-without-header.md index ef525204bdf..1cbc09b2300 100644 --- a/docs-2.0/nebula-importer/config-without-header.md +++ b/docs-2.0/nebula-importer/config-without-header.md @@ -127,6 +127,7 @@ files: type: string # Tag Settings. + tags: # Tag name. - name: student From 4e894ab126cb272455f6904666d98cae79f678d8 Mon Sep 17 00:00:00 2001 From: cooper-lzy <78672629+cooper-lzy@users.noreply.github.com> Date: Tue, 6 Dec 2022 15:46:23 +0800 Subject: [PATCH 71/89] exchange update faq (#1800) --- docs-2.0/nebula-exchange/ex-ug-FAQ.md | 4 ++-- .../parameter-reference/ex-ug-para-import-command.md | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs-2.0/nebula-exchange/ex-ug-FAQ.md b/docs-2.0/nebula-exchange/ex-ug-FAQ.md index e4a4264dda9..46e6fee0496 100644 --- a/docs-2.0/nebula-exchange/ex-ug-FAQ.md +++ b/docs-2.0/nebula-exchange/ex-ug-FAQ.md @@ -46,9 +46,9 @@ Solution: Add the following configuration in the `profiles` scope of Maven's `se ## Execution -### Q: How to submit in Yarn-Cluster mode? +### Q: Error: `java.lang.ClassNotFoundException: com.vesoft.nebula.exchange.Exchange` -To submit a task in Yarn-Cluster mode, run the following command: +To submit a task in Yarn-Cluster mode, run the following command, **especially the two '--conf' commands in the example**. ```bash $SPARK_HOME/bin/spark-submit --class com.vesoft.nebula.exchange.Exchange \ diff --git a/docs-2.0/nebula-exchange/parameter-reference/ex-ug-para-import-command.md b/docs-2.0/nebula-exchange/parameter-reference/ex-ug-para-import-command.md index 284feb63a32..daa9cbb8546 100644 --- a/docs-2.0/nebula-exchange/parameter-reference/ex-ug-para-import-command.md +++ b/docs-2.0/nebula-exchange/parameter-reference/ex-ug-para-import-command.md @@ -20,9 +20,9 @@ After editing the configuration file, run the following commands to import speci The version number of a JAR file is subject to the name of the JAR file that is actually compiled. -!!! note +!!! faq - If users use the [yarn-cluster mode](https://spark-reference-doc-cn.readthedocs.io/zh_CN/latest/deploy-guide/running-on-yarn.html) to submit a job, see the following command: + If users use the [yarn-cluster mode](https://spark-reference-doc-cn.readthedocs.io/zh_CN/latest/deploy-guide/running-on-yarn.html) to submit a job, see the following command, **especially the two '--conf' commands in the example**. ```bash $SPARK_HOME/bin/spark-submit --master yarn-cluster \ From 4fd79fb6d7ff298423650ef1db2b49e05cd83244 Mon Sep 17 00:00:00 2001 From: "abby.huang" <78209557+abby-cyber@users.noreply.github.com> Date: Tue, 6 Dec 2022 17:22:46 +0800 Subject: [PATCH 72/89] Update 2.compile-br.md (#1801) --- docs-2.0/backup-and-restore/nebula-br/2.compile-br.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs-2.0/backup-and-restore/nebula-br/2.compile-br.md b/docs-2.0/backup-and-restore/nebula-br/2.compile-br.md index b1a5169fa50..7bd8b731f12 100644 --- a/docs-2.0/backup-and-restore/nebula-br/2.compile-br.md +++ b/docs-2.0/backup-and-restore/nebula-br/2.compile-br.md @@ -13,6 +13,7 @@ To use the BR (Enterprise Edition) tool, you need to install the NebulaGraph Age |NebulaGraph|BR |Agent | |:---|:---|:---| |3.3.0|3.3.0|0.2.0| +|3.0.x ~ 3.2.x|0.6.1|0.1.0 ~ 0.2.0| ## Install BR with a binary file @@ -138,4 +139,4 @@ In **each machine**, follow these steps: ## FAQ ### The error `E_LIST_CLUSTER_NO_AGENT_FAILURE -If you encounter `E_LIST_CLUSTER_NO_AGENT_FAILURE` error, it may be due to the Agent service is not started or the Agent service is not registered to Meta service. First, execute `SHOW HOSTS AGENT` to check the status of the Agent service on all nodes in the cluster, when the status shows `OFFLINE`, it means the registration of Agent failed, then check whether the value of the `--meta` option in the command to start the Agent service is correct. \ No newline at end of file +If you encounter `E_LIST_CLUSTER_NO_AGENT_FAILURE` error, it may be due to the Agent service is not started or the Agent service is not registered to Meta service. First, execute `SHOW HOSTS AGENT` to check the status of the Agent service on all nodes in the cluster, when the status shows `OFFLINE`, it means the registration of Agent failed, then check whether the value of the `--meta` option in the command to start the Agent service is correct. From 737526d6aa4e25d1f69403d8a74702435293ec38 Mon Sep 17 00:00:00 2001 From: cooper-lzy <78672629+cooper-lzy@users.noreply.github.com> Date: Wed, 7 Dec 2022 09:58:43 +0800 Subject: [PATCH 73/89] dashboard release 3.2.4 (#1802) --- .../20.appendix/release-notes/dashboard-ent-release-note.md | 6 ++++++ docs-2.0/nebula-dashboard-ent/1.what-is-dashboard-ent.md | 2 +- mkdocs.yml | 4 ++-- 3 files changed, 9 insertions(+), 3 deletions(-) diff --git a/docs-2.0/20.appendix/release-notes/dashboard-ent-release-note.md b/docs-2.0/20.appendix/release-notes/dashboard-ent-release-note.md index 2e2862e2211..4933e91dd88 100644 --- a/docs-2.0/20.appendix/release-notes/dashboard-ent-release-note.md +++ b/docs-2.0/20.appendix/release-notes/dashboard-ent-release-note.md @@ -1,5 +1,11 @@ # NebulaGraph Dashboard Enterprise Edition release notes +## Enterprise Edition v3.2.4 + +- Enhancement + + - Close experimental features by default when installing NebulaGraph Enterprise Edition 3.1.3 or 3.4. + ## Enterprise Edition v3.2.3 - Enhancement diff --git a/docs-2.0/nebula-dashboard-ent/1.what-is-dashboard-ent.md b/docs-2.0/nebula-dashboard-ent/1.what-is-dashboard-ent.md index d199a17afa5..7aa6f2da42f 100644 --- a/docs-2.0/nebula-dashboard-ent/1.what-is-dashboard-ent.md +++ b/docs-2.0/nebula-dashboard-ent/1.what-is-dashboard-ent.md @@ -60,7 +60,7 @@ The version correspondence between NebulaGraph and Dashboard Enterprise Edition |NebulaGraph version|Dashboard version| |:---|:---| -|3.3.0 |3.2.3, 3.2.2, 3.2.1, 3.2.0| +|3.3.0 |3.2.4, 3.2.3, 3.2.2, 3.2.1, 3.2.0| |2.5.0 ~ 3.2.0|3.1.2, 3.1.1, 3.1.0| |2.5.x ~ 3.1.0|3.0.4| |2.5.1 ~ 3.0.0|1.1.0| diff --git a/mkdocs.yml b/mkdocs.yml index 046149c595b..9b6bcc8db82 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -194,8 +194,8 @@ extra: base100: 1.0.0 branch: release-3.2 dashboard_ent: - release: 3.2.3 - tag: v3.2.3 + release: 3.2.4 + tag: v3.2.4 branch: release-3.2 console: release: 3.3.1 From dc0b46863f78786575aa867ea13e1f28d854bfa9 Mon Sep 17 00:00:00 2001 From: cooper-lzy <78672629+cooper-lzy@users.noreply.github.com> Date: Wed, 7 Dec 2022 10:33:21 +0800 Subject: [PATCH 74/89] explorer release 3.2.1 (#1803) --- docs-2.0/20.appendix/release-notes/explorer-release-note.md | 6 ++++++ .../about-explorer/ex-ug-what-is-explorer.md | 2 +- mkdocs.yml | 4 ++-- 3 files changed, 9 insertions(+), 3 deletions(-) diff --git a/docs-2.0/20.appendix/release-notes/explorer-release-note.md b/docs-2.0/20.appendix/release-notes/explorer-release-note.md index 97c102a4180..3073e0ba455 100644 --- a/docs-2.0/20.appendix/release-notes/explorer-release-note.md +++ b/docs-2.0/20.appendix/release-notes/explorer-release-note.md @@ -1,5 +1,11 @@ # NebulaGraph Explorer release notes +## v3.2.1 + +- Bugfix + - Fixed the bug that the connection timeout and HTTP error `500` when connecting to a non-existent address. + - Fixed the bug that the vertex properties could not be displayed on the canvas when randomly importing vertices. + ## v3.2.0 - Feature diff --git a/docs-2.0/nebula-explorer/about-explorer/ex-ug-what-is-explorer.md b/docs-2.0/nebula-explorer/about-explorer/ex-ug-what-is-explorer.md index 910f8394256..b336f58169d 100644 --- a/docs-2.0/nebula-explorer/about-explorer/ex-ug-what-is-explorer.md +++ b/docs-2.0/nebula-explorer/about-explorer/ex-ug-what-is-explorer.md @@ -51,7 +51,7 @@ When NebulaGraph enables authentication, users can only sign into Studio with th | NebulaGraph version | Explorer version | | --- | --- | -| 3.3.0 | 3.2.0| +| 3.3.0 | 3.2.1, 3.2.0| | 3.1.0 ~ 3.2.x| 3.1.0| | 3.0.0 ~ 3.1.0 | 3.0.0 | | 2.5.x ~ 3.0.0| 2.2.0| diff --git a/mkdocs.yml b/mkdocs.yml index 9b6bcc8db82..f68e2fd2f53 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -153,9 +153,9 @@ extra: release: 3.5.0 tag: v3.5.0 explorer: - release: 3.2.0 + release: 3.2.1 branch: release-3.2 - tag: v3.2.0 + tag: v3.2.1 exchange_ent: release: 3.0.0 branch: v3.0.0 From a14d2ef34c888b1ff50d17e9837601914989958e Mon Sep 17 00:00:00 2001 From: randomJoe211 <69501902+randomJoe211@users.noreply.github.com> Date: Wed, 7 Dec 2022 17:14:29 +0800 Subject: [PATCH 75/89] Let it snow (#1805) --- mkdocs.yml | 3 +-- overrides/partials/header.html | 49 ++++++++++++++++++++++++++++++++++ 2 files changed, 50 insertions(+), 2 deletions(-) diff --git a/mkdocs.yml b/mkdocs.yml index f68e2fd2f53..7dba7c18ee9 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -27,7 +27,7 @@ theme: name: Switch to light mode features: - navigation.top - - header.autohide + # - header.autohide - content.tabs.link language: 'en' @@ -108,7 +108,6 @@ plugins: #render_js: true #headless_chrome_path: headless-chromium #enabled_if_env: ENABLE_PDF_EXPORT - #debug_html: true #show_anchors: true #verbose: true diff --git a/overrides/partials/header.html b/overrides/partials/header.html index adb60a1dc5d..bb21bf4e2d8 100644 --- a/overrides/partials/header.html +++ b/overrides/partials/header.html @@ -71,4 +71,53 @@ {% endif %} + + From 0e0034abd94fde9e25b094f5586b641cf73beb46 Mon Sep 17 00:00:00 2001 From: randomJoe211 <69501902+randomJoe211@users.noreply.github.com> Date: Thu, 8 Dec 2022 09:36:57 +0800 Subject: [PATCH 76/89] Revert "Let it snow (#1805)" (#1806) This reverts commit a14d2ef34c888b1ff50d17e9837601914989958e. --- mkdocs.yml | 3 ++- overrides/partials/header.html | 49 ---------------------------------- 2 files changed, 2 insertions(+), 50 deletions(-) diff --git a/mkdocs.yml b/mkdocs.yml index 7dba7c18ee9..f68e2fd2f53 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -27,7 +27,7 @@ theme: name: Switch to light mode features: - navigation.top - # - header.autohide + - header.autohide - content.tabs.link language: 'en' @@ -108,6 +108,7 @@ plugins: #render_js: true #headless_chrome_path: headless-chromium #enabled_if_env: ENABLE_PDF_EXPORT + #debug_html: true #show_anchors: true #verbose: true diff --git a/overrides/partials/header.html b/overrides/partials/header.html index bb21bf4e2d8..adb60a1dc5d 100644 --- a/overrides/partials/header.html +++ b/overrides/partials/header.html @@ -71,53 +71,4 @@ {% endif %} - - From b97738884dca2accfec9182626711ab7fa409785 Mon Sep 17 00:00:00 2001 From: cooper-lzy <78672629+cooper-lzy@users.noreply.github.com> Date: Fri, 9 Dec 2022 13:43:39 +0800 Subject: [PATCH 77/89] Update nebula-analytics.md --- docs-2.0/graph-computing/nebula-analytics.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/docs-2.0/graph-computing/nebula-analytics.md b/docs-2.0/graph-computing/nebula-analytics.md index 1871b11b523..0d0e9a64de5 100644 --- a/docs-2.0/graph-computing/nebula-analytics.md +++ b/docs-2.0/graph-computing/nebula-analytics.md @@ -144,8 +144,6 @@ After installation, you can set parameters of different algorithms and then exec --space=baskeyballplayer # Read data from NebulaGraph. - # The metad process address. - --meta_server_addrs=192.168.8.100:9559, 192.168.8.101:9559, 192.168.8.102:9559 # The name of edges. --edges=LIKES # The name of the property to be read as the weight of the edge. Can be either the attribute name or _rank. @@ -172,6 +170,12 @@ After installation, you can set parameters of different algorithms and then exec --write_batch_size=1000 # The file path where the data failed to be written back to NebulaGraph is stored. --err_file=/home/xxx/analytics/err.txt + + # other + # The access timeout period of the service. + --graphd_timeout=60000 + --metad_timeout=60000 + --storaged_timeout=60000 ``` 2. Modify the related parameters in the script to be used, such as `run_pagerank.sh`. From fcadeea5e6ce5ca18f732a5032f2b7240d8ffde8 Mon Sep 17 00:00:00 2001 From: foesa <35463247+foesa-yang@users.noreply.github.com> Date: Fri, 9 Dec 2022 14:33:56 +0800 Subject: [PATCH 78/89] Update 1.get-subgraph.md (#1807) --- docs-2.0/3.ngql-guide/16.subgraph-and-path/1.get-subgraph.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs-2.0/3.ngql-guide/16.subgraph-and-path/1.get-subgraph.md b/docs-2.0/3.ngql-guide/16.subgraph-and-path/1.get-subgraph.md index 4573529c85c..bc7ba12f392 100644 --- a/docs-2.0/3.ngql-guide/16.subgraph-and-path/1.get-subgraph.md +++ b/docs-2.0/3.ngql-guide/16.subgraph-and-path/1.get-subgraph.md @@ -35,6 +35,7 @@ While using the `WHERE` clause in a `GET SUBGRAPH` statement, note the following - **Only support** the `AND` operator. - **Only support** filter destination vertex, the vertex format must be `$$.tagName.propName`. +- **Support** filter edge, the edge format must be `edge_type.propName`. - **Support** math functions, aggregate functions, string functions, datetime functions, type conversion functions and general functions in list functions. - **Not support** aggregate functions, schema-related functions, conditional expression, predicate functions, geography function and user-defined functions. From 4029f4ccf97b8af6b935bc01b5d579c909d67c1f Mon Sep 17 00:00:00 2001 From: "abby.huang" <78209557+abby-cyber@users.noreply.github.com> Date: Mon, 12 Dec 2022 17:02:51 +0800 Subject: [PATCH 79/89] Update 4.schema.md (#1809) --- .../3.ngql-guide/6.functions-and-expressions/4.schema.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs-2.0/3.ngql-guide/6.functions-and-expressions/4.schema.md b/docs-2.0/3.ngql-guide/6.functions-and-expressions/4.schema.md index 7517e59ff67..89a1c26d84f 100644 --- a/docs-2.0/3.ngql-guide/6.functions-and-expressions/4.schema.md +++ b/docs-2.0/3.ngql-guide/6.functions-and-expressions/4.schema.md @@ -114,6 +114,10 @@ nebula> GO FROM "player100" OVER follow \ +-------------+-------------+ ``` +!!! note + + The semantics of the query for the starting vertex with src(edge) and [properties(`$^`)](../5.operators/5.property-reference.md) are different. src(edge) indicates the starting vertex ID of the edge in the graph database, while properties(`$^`) indicates the data of the starting vertex where you start to expand the graph, such as the data of the starting vertex `player100` in the above GO statement. + ### dst(edge) dst(edge) returns the destination vertex ID of an edge. @@ -135,6 +139,10 @@ nebula> GO FROM "player100" OVER follow \ +-------------+-------------+ ``` +!!! note + + dst(edge) indicates the destination vertex ID of the edge in the graph database. + ### rank(edge) rank(edge) returns the rank value of an edge. From 7131153e96488f9eeb16ff017a24fa28880412b6 Mon Sep 17 00:00:00 2001 From: cooper-lzy <78672629+cooper-lzy@users.noreply.github.com> Date: Wed, 14 Dec 2022 09:44:43 +0800 Subject: [PATCH 80/89] Update 3.connect-dashboard.md --- docs-2.0/nebula-dashboard/3.connect-dashboard.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs-2.0/nebula-dashboard/3.connect-dashboard.md b/docs-2.0/nebula-dashboard/3.connect-dashboard.md index 2c6e869d31c..6b3470fee9d 100644 --- a/docs-2.0/nebula-dashboard/3.connect-dashboard.md +++ b/docs-2.0/nebula-dashboard/3.connect-dashboard.md @@ -6,7 +6,7 @@ After Dashboard is deployed, you can log in and use Dashboard on the browser. - The Dashboard services are started. For more information, see [Deploy Dashboard](2.deploy-dashboard.md). -- We recommend you to use the Chrome browser of the version above 58. Otherwise, there may be compatibility issues. +- We recommend you to use the Chrome browser of the version above 89. Otherwise, there may be compatibility issues. ## Procedures From 5575d79ea0b702629ed7c8db2c673bb4c12f4400 Mon Sep 17 00:00:00 2001 From: "abby.huang" <78209557+abby-cyber@users.noreply.github.com> Date: Wed, 14 Dec 2022 10:12:57 +0800 Subject: [PATCH 81/89] Update 3.go.md (#1808) --- docs-2.0/3.ngql-guide/7.general-query-statements/3.go.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs-2.0/3.ngql-guide/7.general-query-statements/3.go.md b/docs-2.0/3.ngql-guide/7.general-query-statements/3.go.md index 7aa6a95c5ec..2217bced8e9 100644 --- a/docs-2.0/3.ngql-guide/7.general-query-statements/3.go.md +++ b/docs-2.0/3.ngql-guide/7.general-query-statements/3.go.md @@ -47,8 +47,8 @@ YIELD [DISTINCT] !!! note - - There are some restrictions for the `WHERE` clause when you traverse along with multiple edge types. For example, `WHERE edge1.prop1 > edge2.prop2` is not supported. - - The GO statement is executed by traversing all the vertices and then filtering according to the filter condition. + - There are some restrictions for the `WHERE` clause when you traverse along with multiple edge types. For example, `WHERE edge1.prop1 > edge2.prop2` is not supported. + - The GO statement is executed by traversing all the vertices and then filtering according to the filter condition. - `YIELD [DISTINCT] `: defines the output to be returned. It is recommended to use the [Schema-related functions](../6.functions-and-expressions/4.schema.md) to fill in ``. `src(edge)`, `dst(edge)`, `type(edge) )`, `rank(edge)`, etc., are currently supported, while nested functions are not. For more information, see [YIELD](../8.clauses-and-options/yield.md). From 65a9ffde240f2df5332ba0a1ff787c2c921ff6af Mon Sep 17 00:00:00 2001 From: Wey Gu Date: Wed, 14 Dec 2022 11:21:22 +0800 Subject: [PATCH 82/89] update ga code for 3.3.0 (#1774) --- mkdocs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/mkdocs.yml b/mkdocs.yml index f68e2fd2f53..0cf0d355ac8 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -131,7 +131,7 @@ extra: analytics: provider: google - property: UA-60523578-16 + property: UA-60523578-5 # branch represents code names (git clone). release represents version number used in texts. version: method: mike From 35757fdbe4d14630b5183d321548ee26cb1cc009 Mon Sep 17 00:00:00 2001 From: foesa <35463247+foesa-yang@users.noreply.github.com> Date: Wed, 14 Dec 2022 18:29:05 +0800 Subject: [PATCH 83/89] Update 0.FAQ.md --- docs-2.0/20.appendix/0.FAQ.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs-2.0/20.appendix/0.FAQ.md b/docs-2.0/20.appendix/0.FAQ.md index efc9628652f..4c172e8e808 100644 --- a/docs-2.0/20.appendix/0.FAQ.md +++ b/docs-2.0/20.appendix/0.FAQ.md @@ -293,7 +293,7 @@ Or get vertices by each tag, and then group them by yourself. Yes, for more information, see [Keywords and reserved words](../3.ngql-guide/1.nGQL-overview/keywords-and-reserved-words.md). -### "How to get the out-degree/the in-degree of a vertex with a given name?" +### "How to get the out-degree/the in-degree of a given vertex?" The out-degree of a vertex refers to the number of edges starting from that vertex, while the in-degree refers to the number of edges pointing to that vertex. From 87e80a8024785c84b60eea9afef0ad8332ccc9d9 Mon Sep 17 00:00:00 2001 From: cooper-lzy <78672629+cooper-lzy@users.noreply.github.com> Date: Thu, 15 Dec 2022 11:27:04 +0800 Subject: [PATCH 84/89] Unified dashboard directory structure (#1810) --- .../2.deploy-connect-dashboard-ent.md | 14 ---------- .../3.connect-dashboard.md | 27 +++++++++++++++++++ .../nebula-dashboard/2.deploy-dashboard.md | 2 +- mkdocs.yml | 9 ++++--- 4 files changed, 33 insertions(+), 19 deletions(-) create mode 100644 docs-2.0/nebula-dashboard-ent/3.connect-dashboard.md diff --git a/docs-2.0/nebula-dashboard-ent/2.deploy-connect-dashboard-ent.md b/docs-2.0/nebula-dashboard-ent/2.deploy-connect-dashboard-ent.md index b4375553c84..f282c22d670 100644 --- a/docs-2.0/nebula-dashboard-ent/2.deploy-connect-dashboard-ent.md +++ b/docs-2.0/nebula-dashboard-ent/2.deploy-connect-dashboard-ent.md @@ -351,17 +351,3 @@ To uninstall Dashboard Enterprise Edition, run the following command. ``` sudo dpkg -r ``` - -## Connect to Dashboard - -After Dashboard is successfully started, you can enter `http://:7005` in the address bar of a browser. - -If the following login interface is shown in the browser, then you have successfully deployed and started Dashboard. - -![dashboard-login-cn](https://docs-cdn.nebula-graph.com.cn/figures/login_20220909_en.png) - -!!! note - - When logging into the NebulaGraph Dashboard Enterprise Edition for the first time, the content of *END USER LICENSE AGREEMENT* is displayed on the login page. Please read it and then click **I Agree**. - -You can log into Dashboard with the default account name `nebula` and password `nebula`, and then create LDAP, OAuth2.0 or general accounts. You can log into Dashboard with the accounts that you have created then. For more information about the Dashboard account, see [Authority Management](../nebula-dashboard-ent/5.account-management.md). diff --git a/docs-2.0/nebula-dashboard-ent/3.connect-dashboard.md b/docs-2.0/nebula-dashboard-ent/3.connect-dashboard.md new file mode 100644 index 00000000000..5a90ff79bbb --- /dev/null +++ b/docs-2.0/nebula-dashboard-ent/3.connect-dashboard.md @@ -0,0 +1,27 @@ +# Connect Dashboard + +After Dashboard is deployed, you can log in and use Dashboard on the browser. + +## Prerequisites + +- The Dashboard services are started. For more information, see [Deploy Dashboard](2.deploy-connect-dashboard-ent.md). + +- We recommend you to use the Chrome browser of the version above 89. Otherwise, there may be compatibility issues. + +## Procedures + +1. Confirm the IP address of the machine where the Dashboard is installed. Enter `http://:7005` in the browser to open the login page. + + If the following login interface is shown in the browser, then you have successfully deployed and started Dashboard. + + ![dashboard-login-cn](https://docs-cdn.nebula-graph.com.cn/figures/login_20220909_en.png) + + !!! note + + When logging into the NebulaGraph Dashboard Enterprise Edition for the first time, the content of *END USER LICENSE AGREEMENT* is displayed on the login page. Please read it and then click **I Agree**. + +2. Log into Dashboard with the default account name `nebula` and password `nebula`. + + !!! note + + You can create LDAP, OAuth2.0 or general accounts after log into Dashboard. For more information about the Dashboard account, see [Authority Management](5.account-management.md). \ No newline at end of file diff --git a/docs-2.0/nebula-dashboard/2.deploy-dashboard.md b/docs-2.0/nebula-dashboard/2.deploy-dashboard.md index 9067db78dc0..47beefd85bf 100644 --- a/docs-2.0/nebula-dashboard/2.deploy-dashboard.md +++ b/docs-2.0/nebula-dashboard/2.deploy-dashboard.md @@ -1,4 +1,4 @@ -# Deploy Dashboard +# Deploy Dashboard Community Edition The deployment of Dashboard involves five services. This topic will describe how to deploy Dashboard in detail. To download and compile the latest source code of NebulaGraph Dashboard, follow the instructions on the [nebula dashboard GitHub page](https://github.com/vesoft-inc/nebula-dashboard). diff --git a/mkdocs.yml b/mkdocs.yml index 0cf0d355ac8..d2616ddc731 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -564,9 +564,10 @@ nav: - Monitoring metrics: nebula-dashboard/6.monitor-parameter.md - NebulaGraph Dashboard Enterprise Edition: - - What is NebulaGraph Dashboard Enterprise Edition: nebula-dashboard-ent/1.what-is-dashboard-ent.md - - Deploy Dashboard Enterprise Edition: nebula-dashboard-ent/2.deploy-connect-dashboard-ent.md - - NebulaGraph Dashboard Enterprise Edition license: nebula-dashboard-ent/11.dashboard-ent-license.md + - What is NebulaGraph Dashboard: nebula-dashboard-ent/1.what-is-dashboard-ent.md + - Dashboard Enterprise Edition license: nebula-dashboard-ent/11.dashboard-ent-license.md + - Deploy Dashboard: nebula-dashboard-ent/2.deploy-connect-dashboard-ent.md + - Connect to Dashboard: nebula-dashboard-ent/3.connect-dashboard.md - Create and import clusters: - Create clusters: nebula-dashboard-ent/3.create-import-dashboard/1.create-cluster.md - Import clusters: nebula-dashboard-ent/3.create-import-dashboard/2.import-cluster.md @@ -605,7 +606,7 @@ nav: - Deploy and connect: - Deploy Explorer: nebula-explorer/deploy-connect/ex-ug-deploy.md - Connect to NebulaGraph: nebula-explorer/deploy-connect/ex-ug-connect.md - - NebulaGraph Explorer License: nebula-explorer/deploy-connect/3.explorer-license.md + - Explorer License: nebula-explorer/deploy-connect/3.explorer-license.md - Page overview: nebula-explorer/ex-ug-page-overview.md - Database management: - Schema drafting: nebula-explorer/db-management/draft.md From 4ada859e2cb1974ba5df380cecb4d698f3e3281e Mon Sep 17 00:00:00 2001 From: foesa <35463247+foesa-yang@users.noreply.github.com> Date: Thu, 15 Dec 2022 15:10:23 +0800 Subject: [PATCH 85/89] Update 2.match.md (#1811) --- .../7.general-query-statements/2.match.md | 17 ++++++++--------- 1 file changed, 8 insertions(+), 9 deletions(-) diff --git a/docs-2.0/3.ngql-guide/7.general-query-statements/2.match.md b/docs-2.0/3.ngql-guide/7.general-query-statements/2.match.md index 6c574dbc037..742b8262674 100644 --- a/docs-2.0/3.ngql-guide/7.general-query-statements/2.match.md +++ b/docs-2.0/3.ngql-guide/7.general-query-statements/2.match.md @@ -8,7 +8,7 @@ The examples in this topic use the [basketballplayer](../1.nGQL-overview/1.overv ## Syntax -The syntax of `MATCH` is relatively more flexible compared with that of other query statements such as `GO` or `LOOKUP`. But generally, it can be summarized as follows. +The syntax of `MATCH` is relatively more flexible compared with that of other query statements such as `GO` or `LOOKUP`. The path type of the `MATCH` statement is `trail`. That is, only vertices can be repeatedly visited in the graph traversal. Edges cannot be repeatedly visited. For details, see [path](../../1.introduction/2.1.path.md). But generally, it can be summarized as follows. ```ngql MATCH [] RETURN []; @@ -22,7 +22,7 @@ MATCH [] RETURN []; - `clause_2`: The `ORDER BY` and `LIMIT` clauses are supported. -## Precautions +## Limitations !!! compatibility "Legacy version compatibility" @@ -30,19 +30,18 @@ MATCH [] RETURN []; !!! note - Currently the `match` statement cannot find dangling edges. + - Currently the `match` statement cannot find dangling edges. + - It is not supported to traverse the specified Tag and Edge Type at the same time when there is no index. For example, executing `MATCH (v:player)-[e:follow]->() RETURN e LIMIT N` an error will occur. -- The `MATCH` statement retrieves data according to the `RETURN` clause. - -- The path type of the `MATCH` statement is `trail`. That is, only vertices can be repeatedly visited in the graph traversal. Edges cannot be repeatedly visited. For details, see [path](../../1.introduction/2.1.path.md). +When no [index](../14.native-index-statements/1.create-native-index.md) has been created, the `MATCH` statements is only supported in the following cases. When you get an error executing the `MATCH` statement, you can create and rebuild the index and then execute the `MATCH` statement. - In a valid `MATCH` statement, the VID of a specific vertex must be specified with the id() function in the `WHERE` clause. There is no need to create an index. -- When traversing all vertices and edges with `MATCH`, such as `MATCH (v) RETURN v LIMIT N`, there is no need to create an index, but you need to use `LIMIT` to limit the number of output results. +- When traversing all vertices o r edges with `MATCH`, such as `MATCH (v) RETURN v LIMIT N`,`MATCH ()-[e]->() RETURN e LIMIT N`. -- When traversing all vertices of the specified Tag or edge of the specified Edge Type, such as `MATCH (v:player) RETURN v LIMIT N`, there is no need to create an index, but you need to use `LIMIT` to limit the number of output results. +- When traversing all vertices of the specified Tag, such as `MATCH (v:player) RETURN v LIMIT N`. -- In addition to the foregoing, make sure there is at least one index in the `MATCH` statement. How to create native indexes, see [CREATE INDEX](../3/../14.native-index-statements/1.create-native-index.md). +- When traversing all edges of the specified Edge Type(edges must have direction), such as `MATCH ()-[e:follow]->() RETURN e LIMIT N`. ## Using patterns in MATCH statements From d5e7406a3bcbb478ad4f7e9473c9f4a09465681c Mon Sep 17 00:00:00 2001 From: foesa <35463247+foesa-yang@users.noreply.github.com> Date: Thu, 15 Dec 2022 16:19:08 +0800 Subject: [PATCH 86/89] update --- .github/workflows/deploy.yml | 12 ++--- docs-2.0/stylesheets/extra.css | 18 +++---- mkdocs.yml | 90 +++++++++++++++++----------------- 3 files changed, 59 insertions(+), 61 deletions(-) diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml index a9df8333072..59e16da6c14 100644 --- a/.github/workflows/deploy.yml +++ b/.github/workflows/deploy.yml @@ -3,7 +3,7 @@ on: push: branches: # Remember to add v before the following version number unless the version is master. - - v3.3.0 + - master jobs: deploy: @@ -11,7 +11,7 @@ jobs: steps: - uses: actions/checkout@v2 with: - fetch-depth: 1 # fetch all commits/branches for gitversion + fetch-depth: 0 # fetch all commits/branches for gitversion - name: Setup Python uses: actions/setup-python@v1 @@ -25,12 +25,12 @@ jobs: - name: Git Config run: git config user.name whitewum && git config user.email min.wu@vesoft.com - - name: Mike Deploy 3.3.0 + - name: Mike Deploy master run: | - # mike delete 3.3.0 -p + # mike delete master -p git fetch origin gh-pages --depth=1 # fix mike's CI update - mike deploy 3.3.0 -p --rebase - mike set-default 3.3.0 -p --rebase + mike list + mike deploy master -p --rebase mike list # - name: Deploy diff --git a/docs-2.0/stylesheets/extra.css b/docs-2.0/stylesheets/extra.css index 5581d5b2e38..87d589214a9 100644 --- a/docs-2.0/stylesheets/extra.css +++ b/docs-2.0/stylesheets/extra.css @@ -1,19 +1,19 @@ .md-grid { - max-width: initial; - } + max-width: initial; +} /* nebula dark */ :root{ - --md-primary-fg-color:#6b2e38; /* Tar bar color*/ - --md-accent-fg-color: #f04949; /* Selected color */ +--md-primary-fg-color:#a27e7e; /* Tar bar color*/ +--md-accent-fg-color: #FA8072; /* Selected color */ } /* nebula light */ [data-md-color-scheme="nebula"]{ - --md-primary-fg-color: #C65467; /* Tar bar color */ - --md-accent-fg-color: #bb7d7c; /* Selected color */ +--md-primary-fg-color: #FF0000; /* Tar bar color */ +--md-accent-fg-color: #49BDF0; /* Selected color */ - --md-code-fg-color: rgb(12, 21, 26); - --md-code-bg-color: #eaebec; - --md-typeset-color: #000000; +--md-code-fg-color: rgb(12, 21, 26); +--md-code-bg-color: #eaebec; +--md-typeset-color: #000000; } \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index d2616ddc731..aaec4ea8ea8 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -9,13 +9,13 @@ repo_url: 'https://github.com/vesoft-inc/nebula-docs' copyright: Copyright © 2022 NebulaGraph # modify -edit_uri: 'edit/v3.3.0/docs-2.0/' +edit_uri: 'edit/master/docs-2.0/' theme: name: material custom_dir: overrides logo: 'https://cloud-cdn.nebula-graph.com.cn/vesoft-nebula-logo-white.png' - favicon: 'https://docs-cdn.nebula-graph.com.cn/figures/favicon.ico' + favicon: 'assets/images/favicon.ico' palette: - scheme: nebula toggle: @@ -60,7 +60,7 @@ markdown_extensions: # Plugins plugins: - # - search # 这个是原有的 mkdocs 搜索插件， 如果想使用algolia搜索，请注释掉这个插件 + - search # 这个是原有的 mkdocs 搜索插件， 如果想使用algolia搜索，请注释掉这个插件 - macros: include_dir: docs-2.0/reuse/ - git-revision-date-localized @@ -79,16 +79,16 @@ plugins: - nebula-dashboard-ent/4.cluster-operator/cluster-information/job-management.md # When publishing a version of a document that includes Enterprise Edition, annotation the following page # begin - - 3.ngql-guide/6.functions-and-expressions/17.ES-function.md - - 4.deployment-and-installation/deploy-license.md - - 5.configurations-and-logs/2.log-management/audit-log.md - - 7.data-security/1.authentication/4.ldap.md - - nebula-operator/8.custom-cluster-configurations/8.3.balance-data-when-scaling-storage.md - - synchronization-and-migration/replication-between-clusters.md - - 20.appendix/release-notes/nebula-ent-release-note.md - - nebula-dashboard-ent/4.cluster-operator/operator/scale.md - - backup-and-restore/nebula-br-ent/* - - 6.monitor-and-metrics/3.bbox/* +# - 3.ngql-guide/6.functions-and-expressions/17.ES-function.md +# - 4.deployment-and-installation/deploy-license.md +# - 5.configurations-and-logs/2.log-management/audit-log.md +# - 7.data-security/1.authentication/4.ldap.md +# - nebula-operator/8.custom-cluster-configurations/8.3.balance-data-when-scaling-storage.md +# - synchronization-and-migration/replication-between-clusters.md +# - 20.appendix/release-notes/nebula-ent-release-note.md +# - nebula-dashboard-ent/4.cluster-operator/operator/scale.md +# - backup-and-restore/nebula-br-ent/* +# - 6.monitor-and-metrics/3.bbox/* # end # Exclude the file with the following file name. # - abc.md @@ -98,7 +98,7 @@ plugins: - with-pdf: copyright: 2022 Vesoft Inc. - cover_subtitle: 3.3.0 + cover_subtitle: master author: Min Wu, Yao Zhou, Cooper Liang, Foesa Yang, Abby Huang cover: true back_cover: true @@ -131,7 +131,7 @@ extra: analytics: provider: google - property: UA-60523578-5 + property: UA-60523578-16 # branch represents code names (git clone). release represents version number used in texts. version: method: mike @@ -153,9 +153,9 @@ extra: release: 3.5.0 tag: v3.5.0 explorer: - release: 3.2.1 + release: 3.2.0 branch: release-3.2 - tag: v3.2.1 + tag: v3.2.0 exchange_ent: release: 3.0.0 branch: v3.0.0 @@ -194,17 +194,17 @@ extra: base100: 1.0.0 branch: release-3.2 dashboard_ent: - release: 3.2.4 - tag: v3.2.4 + release: 3.2.0 + tag: v3.2.0 branch: release-3.2 console: - release: 3.3.1 - branch: release-3.3 - tag: v3.3.1 - br: release: 3.3.0 branch: release-3.3 tag: v3.3.0 + br: + release: 0.6.1 + branch: master + tag: v0.6.1 br_ent: release: 0.7.0 tag: v0.7.0 @@ -255,8 +255,8 @@ extra: azureLatestRelease: 3.1.0 # The latest doc version that supports Azure Cloud aliyunLatestRelease: 3.1.0 # The latest doc version that supports Alibaba Cloud ent: - ent_begin: " when releasing core-ent - ent_end: --> # change to "" when releasing core-ent + ent_begin: # change to "" when releasing core-ent + ent_end: # change to "" when releasing core-ent nav: - About: README.md @@ -324,7 +324,7 @@ nav: - Aggregate functions: 3.ngql-guide/6.functions-and-expressions/15.aggregating.md - String functions: 3.ngql-guide/6.functions-and-expressions/2.string.md - Date and time functions: 3.ngql-guide/6.functions-and-expressions/3.date-and-time.md - - Schema-related functions: 3.ngql-guide/6.functions-and-expressions/4.schema.md + - Schema functions: 3.ngql-guide/6.functions-and-expressions/4.schema.md - List functions: 3.ngql-guide/6.functions-and-expressions/6.list.md - Type conversion functions: 3.ngql-guide/6.functions-and-expressions/16.type-conversion.md - Conditional expressions: 3.ngql-guide/6.functions-and-expressions/5.conditional-expressions.md @@ -469,9 +469,9 @@ nav: - Query NebulaGraph metrics: 6.monitor-and-metrics/1.query-performance-metrics.md - RocksDB Statistics: 6.monitor-and-metrics/2.rocksdb-statistics.md #ent -#ent - Black-box monitoring: -#ent - What is black-box monitoring: 6.monitor-and-metrics/3.bbox/3.1.bbox.md -#ent - Black-box monitoring tool: 6.monitor-and-metrics/3.bbox/3.2.bbox-reviewer.md + - Black-box monitoring: + - What is black-box monitoring: 6.monitor-and-metrics/3.bbox/3.1.bbox.md + - Black-box monitoring tool: 6.monitor-and-metrics/3.bbox/3.2.bbox-reviewer.md - Data security: - Authentication and authorization: @@ -484,16 +484,15 @@ nav: - Backup & Restore: - NebulaGraph BR (Community Edition): - What is Backup & Restore (Community Edition): backup-and-restore/nebula-br/1.what-is-br.md - - Install BR: backup-and-restore/nebula-br/2.compile-br.md + - Compile BR: backup-and-restore/nebula-br/2.compile-br.md - Use BR to back up data: backup-and-restore/nebula-br/3.br-backup-data.md - Use BR to restore data: backup-and-restore/nebula-br/4.br-restore-data.md -#ent -#ent - NebulaGraph BR (Enterprise Edition): -#ent - What is Backup & Restore (Enterprise Edition): backup-and-restore/nebula-br-ent/1.br-ent-overview.md -#ent - Install BR: backup-and-restore/nebula-br-ent/2.install-tools.md -#ent - Back up data with BR: backup-and-restore/nebula-br-ent/3.backup-data.md -#ent - Restore data with BR: backup-and-restore/nebula-br-ent/4.restore-data.md -#ent - Manage snapshots: backup-and-restore/3.manage-snapshot.md + - NebulaGraph BR (Enterprise Edition): + - What is Backup & Restore (Enterprise Edition): backup-and-restore/nebula-br-ent/1.br-ent-overview.md + - Install BR: backup-and-restore/nebula-br-ent/2.install-tools.md + - Back up data with BR: backup-and-restore/nebula-br-ent/3.backup-data.md + - Restore data with BR: backup-and-restore/nebula-br-ent/4.restore-data.md + - Manage snapshots: backup-and-restore/3.manage-snapshot.md - Synchronization & Migration: - Load balance: synchronization-and-migration/2.balance-syntax.md @@ -539,6 +538,7 @@ nav: - Limitations: nebula-studio/about-studio/st-ug-limitations.md - Deploy and connect: - Deploy Studio: nebula-studio/deploy-connect/st-ug-deploy.md + - Deploy Studio with Helm: nebula-studio/deploy-connect/st-ug-deploy-by-helm.md - Connect to NebulaGraph: nebula-studio/deploy-connect/st-ug-connect.md - Quick start: - Design a schema: nebula-studio/quick-start/st-ug-plan-schema.md @@ -564,10 +564,9 @@ nav: - Monitoring metrics: nebula-dashboard/6.monitor-parameter.md - NebulaGraph Dashboard Enterprise Edition: - - What is NebulaGraph Dashboard: nebula-dashboard-ent/1.what-is-dashboard-ent.md - - Dashboard Enterprise Edition license: nebula-dashboard-ent/11.dashboard-ent-license.md - - Deploy Dashboard: nebula-dashboard-ent/2.deploy-connect-dashboard-ent.md - - Connect to Dashboard: nebula-dashboard-ent/3.connect-dashboard.md + - What is NebulaGraph Dashboard Enterprise Edition: nebula-dashboard-ent/1.what-is-dashboard-ent.md + - Deploy Dashboard Enterprise Edition: nebula-dashboard-ent/2.deploy-connect-dashboard-ent.md + - NebulaGraph Dashboard Enterprise Edition license: nebula-dashboard-ent/11.dashboard-ent-license.md - Create and import clusters: - Create clusters: nebula-dashboard-ent/3.create-import-dashboard/1.create-cluster.md - Import clusters: nebula-dashboard-ent/3.create-import-dashboard/2.import-cluster.md @@ -579,15 +578,14 @@ nav: - Information overview: nebula-dashboard-ent/4.cluster-operator/cluster-information/overview-info.md - Cluster diagnostics: nebula-dashboard-ent/4.cluster-operator/cluster-information/cluster-diagnosis.md # - Job management: nebula-dashboard-ent/4.cluster-operator/cluster-information/job-management.md + - Backup and restore: nebula-dashboard-ent/4.cluster-operator/cluster-information/backup-and-restore.md - Operation: - Node: nebula-dashboard-ent/4.cluster-operator/operator/node.md -#ent -#ent - Scale: nebula-dashboard-ent/4.cluster-operator/operator/scale.md + - Scale: nebula-dashboard-ent/4.cluster-operator/operator/scale.md - Service: nebula-dashboard-ent/4.cluster-operator/operator/service.md - Update config: nebula-dashboard-ent/4.cluster-operator/operator/update-config.md - Member management: nebula-dashboard-ent/4.cluster-operator/operator/member-management.md - Version upgrade: nebula-dashboard-ent/4.cluster-operator/operator/version-upgrade.md - - Backup and restore: nebula-dashboard-ent/4.cluster-operator/operator/backup-and-restore.md - Operation records: nebula-dashboard-ent/4.cluster-operator/5.operation-record.md - Other settings: nebula-dashboard-ent/4.cluster-operator/6.settings.md - Authority management: nebula-dashboard-ent/5.account-management.md @@ -606,7 +604,7 @@ nav: - Deploy and connect: - Deploy Explorer: nebula-explorer/deploy-connect/ex-ug-deploy.md - Connect to NebulaGraph: nebula-explorer/deploy-connect/ex-ug-connect.md - - Explorer License: nebula-explorer/deploy-connect/3.explorer-license.md + - NebulaGraph Explorer License: nebula-explorer/deploy-connect/3.explorer-license.md - Page overview: nebula-explorer/ex-ug-page-overview.md - Database management: - Schema drafting: nebula-explorer/db-management/draft.md @@ -724,4 +722,4 @@ nav: - History timeline: 20.appendix/history.md - Error code: 20.appendix/error-code.md - - PDF: ./pdf/NebulaGraph-EN.pdf + - PDF: ./pdf/NebulaGraph-EN.pdf \ No newline at end of file From 20ebb4e4050fad8452b7ae4abd0a9dbae21e1f48 Mon Sep 17 00:00:00 2001 From: foesa <35463247+foesa-yang@users.noreply.github.com> Date: Thu, 15 Dec 2022 16:20:00 +0800 Subject: [PATCH 87/89] Update extra.css --- docs-2.0/stylesheets/extra.css | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/docs-2.0/stylesheets/extra.css b/docs-2.0/stylesheets/extra.css index 87d589214a9..02d32b686cc 100644 --- a/docs-2.0/stylesheets/extra.css +++ b/docs-2.0/stylesheets/extra.css @@ -4,16 +4,16 @@ /* nebula dark */ :root{ ---md-primary-fg-color:#a27e7e; /* Tar bar color*/ ---md-accent-fg-color: #FA8072; /* Selected color */ + --md-primary-fg-color:#a27e7e; /* Tar bar color*/ + --md-accent-fg-color: #FA8072; /* Selected color */ } /* nebula light */ [data-md-color-scheme="nebula"]{ ---md-primary-fg-color: #FF0000; /* Tar bar color */ ---md-accent-fg-color: #49BDF0; /* Selected color */ + --md-primary-fg-color: #FF0000; /* Tar bar color */ + --md-accent-fg-color: #49BDF0; /* Selected color */ ---md-code-fg-color: rgb(12, 21, 26); ---md-code-bg-color: #eaebec; ---md-typeset-color: #000000; -} \ No newline at end of file + --md-code-fg-color: rgb(12, 21, 26); + --md-code-bg-color: #eaebec; + --md-typeset-color: #000000; +} From 9da42d98216e4a8b8ad618f90c6b1ad4d03a3459 Mon Sep 17 00:00:00 2001 From: foesa <35463247+foesa-yang@users.noreply.github.com> Date: Thu, 15 Dec 2022 16:54:57 +0800 Subject: [PATCH 88/89] Update use-importer.md --- docs-2.0/nebula-importer/use-importer.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs-2.0/nebula-importer/use-importer.md b/docs-2.0/nebula-importer/use-importer.md index 07a5e49ef9b..6bdadf70069 100644 --- a/docs-2.0/nebula-importer/use-importer.md +++ b/docs-2.0/nebula-importer/use-importer.md @@ -141,14 +141,14 @@ NebulaGraph Importer uses configuration(`nebula-importer/examples/v2/example.yam The example configuration is as follows: ```yaml -version: v3 +version: v2 description: example removeTempFiles: false ``` |Parameter|Default value|Required|Description| |:---|:---|:---|:---| -|`version`|v2|Yes|Target version of NebulaGraph.| +|`version`|v2|Yes|Target version of the configuration file.| |`description`|example|No|Description of the configuration file.| |`removeTempFiles`|false|No|Whether to delete temporarily generated logs and error data files.| From 550ef5e8e3de3ac2b494d27f1261e7e4f5971832 Mon Sep 17 00:00:00 2001 From: foesa <35463247+foesa-yang@users.noreply.github.com> Date: Mon, 19 Dec 2022 16:41:08 +0800 Subject: [PATCH 89/89] Update mkdocs.yml --- mkdocs.yml | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/mkdocs.yml b/mkdocs.yml index aaec4ea8ea8..1c072e153e0 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -79,16 +79,16 @@ plugins: - nebula-dashboard-ent/4.cluster-operator/cluster-information/job-management.md # When publishing a version of a document that includes Enterprise Edition, annotation the following page # begin -# - 3.ngql-guide/6.functions-and-expressions/17.ES-function.md -# - 4.deployment-and-installation/deploy-license.md -# - 5.configurations-and-logs/2.log-management/audit-log.md -# - 7.data-security/1.authentication/4.ldap.md -# - nebula-operator/8.custom-cluster-configurations/8.3.balance-data-when-scaling-storage.md -# - synchronization-and-migration/replication-between-clusters.md -# - 20.appendix/release-notes/nebula-ent-release-note.md -# - nebula-dashboard-ent/4.cluster-operator/operator/scale.md -# - backup-and-restore/nebula-br-ent/* -# - 6.monitor-and-metrics/3.bbox/* + - 3.ngql-guide/6.functions-and-expressions/17.ES-function.md + - 4.deployment-and-installation/deploy-license.md + - 5.configurations-and-logs/2.log-management/audit-log.md + - 7.data-security/1.authentication/4.ldap.md + - nebula-operator/8.custom-cluster-configurations/8.3.balance-data-when-scaling-storage.md + - synchronization-and-migration/replication-between-clusters.md + - 20.appendix/release-notes/nebula-ent-release-note.md + - nebula-dashboard-ent/4.cluster-operator/operator/scale.md + - backup-and-restore/nebula-br-ent/* + - 6.monitor-and-metrics/3.bbox/* # end # Exclude the file with the following file name. # - abc.md @@ -722,4 +722,4 @@ nav: - History timeline: 20.appendix/history.md - Error code: 20.appendix/error-code.md - - PDF: ./pdf/NebulaGraph-EN.pdf \ No newline at end of file + - PDF: ./pdf/NebulaGraph-EN.pdf