From bb3bf4284ce9fb28064c5b63682473b93286bd57 Mon Sep 17 00:00:00 2001 From: cooper-lzy <78672629+cooper-lzy@users.noreply.github.com> Date: Tue, 7 Feb 2023 14:53:10 +0800 Subject: [PATCH 001/137] release 3.4.0 docs (#2562) * release 3.4.0 docs * Update deploy.yaml --- .github/workflows/deploy.yaml | 11 +-- docs-2.0/stylesheets/extra.css | 8 +-- mkdocs.yml | 124 ++++++++++++++++----------------- 3 files changed, 72 insertions(+), 71 deletions(-) diff --git a/.github/workflows/deploy.yaml b/.github/workflows/deploy.yaml index b964cce2730..ea61e5645ef 100644 --- a/.github/workflows/deploy.yaml +++ b/.github/workflows/deploy.yaml @@ -2,7 +2,7 @@ name: Publish docs via GitHub Pages on: push: branches: - - master + - v3.4.0 jobs: deploy: @@ -10,7 +10,7 @@ jobs: steps: - uses: actions/checkout@v2 with: - fetch-depth: 0 # fetch all commits/branches + fetch-depth: 1 # fetch all commits/branches - name: Setup Python uses: actions/setup-python@v1 @@ -27,7 +27,8 @@ jobs: - name: mike run: | git fetch origin gh-pages --depth=1 # fix mike's CI update - mike deploy master -p --rebase + mike deploy 3.4.0 -p --rebase + mike set-default 3.4.0 -p --rebase mike list - name: show git branch @@ -37,7 +38,7 @@ jobs: git checkout gh-pages - name: Compress run: | - tar -vczf nebula-docs.tar.gz master versions.json *.html + tar -vczf nebula-docs.tar.gz 3.4.0 versions.json *.html - name: Transfer # uses: garygrossgarten/github-action-scp@release @@ -60,7 +61,7 @@ jobs: mkdir -p /usr/web/nebula-docs/ tar -xzf /usr/web/nebula-docs.tar.gz -C /usr/web/nebula-docs/ mkdir -p /usr/web/nebula-docs/site/pdf/ - cp -f /usr/web/nebula-docs/master/pdf/NebulaGraph-CN.pdf /usr/web/nebula-docs/site/pdf/NebulaGraph-book.pdf + cp -f /usr/web/nebula-docs/3.4.0/pdf/NebulaGraph-CN.pdf /usr/web/nebula-docs/site/pdf/NebulaGraph-book.pdf # pip3 install --upgrade pip # pip3 install -r /usr/web/nebula-docs/requirement.txt diff --git a/docs-2.0/stylesheets/extra.css b/docs-2.0/stylesheets/extra.css index 66e78d33260..ae13acd10f1 100644 --- a/docs-2.0/stylesheets/extra.css +++ b/docs-2.0/stylesheets/extra.css @@ -4,14 +4,14 @@ /* NebulaGraph 黑夜主题色 */ :root{ - --md-primary-fg-color: #FF0000; /* 导航栏页面颜色 */ - --md-accent-fg-color: #49BDF0; /* 选中/悬浮颜色 */ + --md-primary-fg-color: #00d5ff; /* 导航栏页面颜色 */ + --md-accent-fg-color: #f049d4; /* 选中/悬浮颜色 */ } /* NebulaGraph 白天主题色 */ [data-md-color-scheme="nebula"]{ - --md-primary-fg-color: #F7A7A0; /* 导航栏页面颜色 */ - --md-accent-fg-color: #7DBB7C; /* 选中/悬浮颜色 */ + --md-primary-fg-color: #0FA37F; /* 导航栏页面颜色 */ + --md-accent-fg-color: #5b1cdb; /* 选中/悬浮颜色 */ --md-code-fg-color: rgb(12, 21, 26); /* 代码段字体色 */ --md-code-bg-color: #eaebec;/* 代码段背景色 */ diff --git a/mkdocs.yml b/mkdocs.yml index cccf7b9f2ef..08c56aa8632 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -5,7 +5,7 @@ site_url: https://docs.nebula-graph.com.cn/ repo_name: 'vesoft-inc/nebula' repo_url: 'https://github.com/vesoft-inc/nebula' docs_dir: docs-2.0 -copyright: Copyright © 2022 NebulaGraph - 浙ICP备20010487号 +copyright: Copyright © 2023 NebulaGraph - 浙ICP备20010487号 # modify when release: edit_uri: 'https://github.com/vesoft-inc/nebula-docs-cn/edit/master/docs-2.0/' @@ -81,7 +81,7 @@ plugins: - 4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-from-200-to-latest.md # 仅发布包含企业版功能的文档版本时，注释以下页面 - # begin + # ent.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 @@ -95,7 +95,7 @@ plugins: # - 20.appendix/8.about-license/ # - nebula-dashboard-ent/4.cluster-operator/operator/scale.md # - 6.monitor-and-metrics/3.bbox - # end + # ent.end # comm.begin # comm.end @@ -107,8 +107,8 @@ plugins: # modify when release: - with-pdf: - copyright: 2022 vesoft Inc. - cover_subtitle: master + copyright: 2023 vesoft Inc. + cover_subtitle: v3.4.0 author: 吴敏，周瑶，梁振亚，杨怡璇，黄凤仙 cover: true back_cover: true @@ -130,7 +130,7 @@ extra: # For conditional rendering # Valid options: enterprise, community, both # enterprise means this version is for the Enterprise only. And so on in a similar fashion - database_edition: community + database_edition: both # Language selector. alternate: - name: English @@ -152,38 +152,38 @@ extra: master: master base20: 2.0 base200: 2.0.0 - branch: release-3.3 - tag: v3.3.0 + branch: release-3.4 + tag: v3.4.0 studio: base111b: 1.1.1-beta base220: 2.2.1 base300: 3.0.0 release: 3.5.0 - tag: v3.5.0 + tag: v3.6.0 explorer: - release: 3.2.0 - branch: release-3.2 - tag: v3.2.0 + release: 3.4.0 + branch: release-3.4 + tag: v3.4.0 exchange_ent: - release: 3.0.0 - branch: v3.0.0 - tag: v3.0.0 + release: 3.4.0 + branch: release-3.4 + tag: v3.4.0 exchange: - release: 3.3.0 - branch: release-3.3 - tag: v3.3.0 + release: 3.4.0 + branch: release-3.4 + tag: v3.4.0 importer: - release: 3.1.0 - branch: release-3.1 - tag: v3.1.0 + release: 3.4.0 + branch: release-3.4 + tag: v3.4.0 algorithm: release: 3.0.0 branch: v3.0.0 tag: v3.0.0 plato: - release: 3.3.0 - branch: release-3.3 - tag: v3.3.0 + release: 3.4.0 + branch: release-3.4 + tag: v3.4.0 sparkconnector: release: 3.3.0 branch: release-3.3 @@ -193,56 +193,56 @@ extra: branch: release-3.3 tag: v3.3.0 dockercompose: - release: 3.2.0 - branch: release-3.2 - tag: v3.2.0 + release: 3.4.0 + branch: release-3.4 + tag: v3.4.0 dashboard: - release: 3.2.0 - tag: v3.2.0 + release: 3.4.0 + tag: v3.4.0 base100: 1.0.0 - branch: release-3.2 + branch: release-3.4 dashboard_ent: - release: 3.2.0 - tag: v3.2.0 - branch: release-3.2 + release: 3.4.0 + tag: v3.4.0 + branch: release-3.4 console: + release: 3.4.0 + branch: release-3.4 + tag: v3.4.0 + 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 + release: 3.4.0 + tag: v3.4.0 agent: - release: 0.2.0 - tag: v0.2.0 + release: 3.4.0 + tag: v3.4.0 cpp: - release: 3.3.0 - branch: release-3.3 - tag: v3.3.0 + release: 3.4.0 + branch: release-3.4 + tag: v3.4.0 java: - release: 3.3.0 - branch: release-3.3 - tag: v3.3.0 + release: 3.4.0 + branch: release-3.4 + tag: v3.4.0 python: - release: 3.3.0 - branch: release-3.3 - tag: v3.3.0 + release: 3.4.0 + branch: release-3.4 + tag: v3.4.0 go: - release: 3.3.0 - branch: release-3.3 - tag: v3.3.0 + release: 3.4.0 + branch: release-3.4 + tag: v3.4.0 bench: release: 1.2.0 branch: release-1.2 tag: v1.2.0 operator: - release: 1.3.0 - tag: v1.3.0 - branch: release-1.3 + release: 1.4.0 + tag: v1.4.0 + branch: release-1.4 upgrade_from: 3.0.0 upgrade_to: 3.3.x exporter: @@ -250,13 +250,13 @@ extra: branch: release-3.3 tag: v3.3.0 gateway: - release: 3.1.2 - branch: release-3.1 - tag: v3.1.2 + release: 3.4.0 + branch: release-3.4 + tag: v3.4.0 bbox: - release: 3.3.0 - branch: release-3.3 - tag: v3.3.0 + release: 3.4.0 + branch: release-3.4 + tag: v3.4.0 cloud: azureRelease: 3.1.1 # Azure云兼容的最新内核版本 aliyunRelease: 3.1.1 # 阿里云兼容的最新内核版本 From 2d59c10786d6a8b847fb64c264e00da3d70ebbd9 Mon Sep 17 00:00:00 2001 From: cooper-lzy <78672629+cooper-lzy@users.noreply.github.com> Date: Tue, 7 Feb 2023 15:13:50 +0800 Subject: [PATCH 002/137] fix 3.4.0 (#2563) --- docs-2.0/20.appendix/release-notes/nebula-comm-release-note.md | 2 +- docs-2.0/20.appendix/release-notes/nebula-ent-release-note.md | 2 +- mkdocs.yml | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs-2.0/20.appendix/release-notes/nebula-comm-release-note.md b/docs-2.0/20.appendix/release-notes/nebula-comm-release-note.md index eb23f5ed519..06f7e1b88d2 100644 --- a/docs-2.0/20.appendix/release-notes/nebula-comm-release-note.md +++ b/docs-2.0/20.appendix/release-notes/nebula-comm-release-note.md @@ -64,4 +64,4 @@ ## 历史版本 -[历史版本](https://nebula-graph.com.cn/tags/release-note/) +[历史版本](https://www.nebula-graph.com.cn/tags/%E5%8F%91%E7%89%88%E8%AF%B4%E6%98%8E) diff --git a/docs-2.0/20.appendix/release-notes/nebula-ent-release-note.md b/docs-2.0/20.appendix/release-notes/nebula-ent-release-note.md index 84a32fb3cc5..a3e37b98d6f 100644 --- a/docs-2.0/20.appendix/release-notes/nebula-ent-release-note.md +++ b/docs-2.0/20.appendix/release-notes/nebula-ent-release-note.md @@ -87,4 +87,4 @@ ## 历史版本 -[历史版本](https://nebula-graph.com.cn/tags/release-note/) +[历史版本](https://www.nebula-graph.com.cn/tags/%E5%8F%91%E7%89%88%E8%AF%B4%E6%98%8E) diff --git a/mkdocs.yml b/mkdocs.yml index 08c56aa8632..3ab31e92e21 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -8,7 +8,7 @@ docs_dir: docs-2.0 copyright: Copyright © 2023 NebulaGraph - 浙ICP备20010487号 # modify when release: -edit_uri: 'https://github.com/vesoft-inc/nebula-docs-cn/edit/master/docs-2.0/' +edit_uri: 'https://github.com/vesoft-inc/nebula-docs-cn/edit/v3.4.0/docs-2.0/' # Configuration theme: From 4cb8fcf13b08d3bdc4af7d32ba6d91e080778f8d Mon Sep 17 00:00:00 2001 From: cooper-lzy <78672629+cooper-lzy@users.noreply.github.com> Date: Tue, 7 Feb 2023 15:24:37 +0800 Subject: [PATCH 003/137] Update README.md --- docs-2.0/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs-2.0/README.md b/docs-2.0/README.md index 652244bc3e4..cc6a7d4efbe 100644 --- a/docs-2.0/README.md +++ b/docs-2.0/README.md @@ -2,7 +2,7 @@ !!! Note - 本文档更新时间{{ now().year }}-{{ now().month }}-{{ now().day }}，GitHub commit [{{ git.short_commit }}](https://github.com/vesoft-inc/nebula-docs/commits/v{{nebula.release}})。该版本主色系为"海后红"，色号为 #C65467。 + 本文档更新时间{{ now().year }}-{{ now().month }}-{{ now().day }}，GitHub commit [{{ git.short_commit }}](https://github.com/vesoft-inc/nebula-docs/commits/v{{nebula.release}})。该版本主色系为"GPT绿"，色号为 #0FA37F。 + +{{ ent.ent_begin }}- [NebulaGraph 企业版 {{ nebula.release }}](20.appendix/release-notes/nebula-ent-release-note.md) {{ ent.ent_end }} - [NebulaGraph Studio](20.appendix/release-notes/studio-release-note.md) - [NebulaGraph Dashboard](20.appendix/release-notes/dashboard-comm-release-note.md) - [NebulaGraph Dashboard 企业版](20.appendix/release-notes/dashboard-ent-release-note.md) - [NebulaGraph Explorer](20.appendix/release-notes/explorer-release-note.md) ---> + ## 其他资料 From 36db6d5d997da81bede9e02c7e87a7449e17b4e8 Mon Sep 17 00:00:00 2001 From: cooper-lzy <78672629+cooper-lzy@users.noreply.github.com> Date: Tue, 7 Feb 2023 15:53:49 +0800 Subject: [PATCH 005/137] Update mkdocs.yml --- mkdocs.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/mkdocs.yml b/mkdocs.yml index 3ab31e92e21..db16136a182 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -658,6 +658,7 @@ nav: - 工作流管理: nebula-explorer/workflow/3.workflow-management.md - 作业管理: nebula-explorer/workflow/4.jobs-management.md - 工作流 API: + - API 概览: nebula-explorer/workflow/workflow-api/workflow-api-overview.md - 新增作业: nebula-explorer/workflow/workflow-api/api-post-jobs.md - 获取所有作业列表: nebula-explorer/workflow/workflow-api/api-get-jobs.md - 获取指定工作流的作业列表: nebula-explorer/workflow/workflow-api/api-get-workflow-jobs.md From dba6de63d0ce85b5caaf3663b5672bbd29112606 Mon Sep 17 00:00:00 2001 From: "abby.huang" <78209557+abby-cyber@users.noreply.github.com> Date: Tue, 7 Feb 2023 15:56:30 +0800 Subject: [PATCH 006/137] Update upgrade-nebula-ent-from-3.x-3.4.md --- .../upgrade-nebula-ent-from-3.x-3.4.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs-2.0/4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-ent-from-3.x-3.4.md b/docs-2.0/4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-ent-from-3.x-3.4.md index 17a923ce215..9711554e0df 100644 --- a/docs-2.0/4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-ent-from-3.x-3.4.md +++ b/docs-2.0/4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-ent-from-3.x-3.4.md @@ -21,7 +21,7 @@ !!! caution - 请确保 3.4.0 集群的 Meta 服务和 Storage 服务的配置文件中的`--data_path`参数的值与 3.x 集群的配置文件中的`--data_path`参数的值相同。否则，升级后的集群无法启动。 + 请确保 3.4.0 集群的 Meta 服务和 Storage 服务的配置文件中的`--data_path`参数设置的存储路径数量值与 3.x 集群的配置文件中的`--data_path`参数的设置相同。否则，升级后的集群无法启动。 2. 停止企业版 NebulaGraph v3.x 服务。详情请参见[管理 NebulaGraph 服务](../../2.quick-start/3.quick-start-on-premise/5.start-stop-service.md)。 运行命令后可继续运行`nebula.service status all`命令以确认所有服务都已停止。 @@ -66,8 +66,8 @@ | 参数 | 说明 | | :-------------- | :--------------------------- | - | `--src_meta_path` | 指定源 Meta 数据目录的绝对路径。下述示例源数据的目录为`/usr/local/nebula-ent-3.1.0/data/storage`。 | - | `--dst_meta_path` | 指定目标 Meta 数据目录的绝对路径。本文示例的目标数据目录为`/usr/local/nebula-ent-3.4/data/storage`。| + | `--src_meta_path` | 指定源 Meta 数据目录的绝对路径。下述示例源数据的目录为`/usr/local/nebula-ent-3.1.0/data/meta`。 | + | `--dst_meta_path` | 指定目标 Meta 数据目录的绝对路径。本文示例的目标数据目录为`/usr/local/nebula-ent-3.4/data/meta`。| 示例： @@ -103,4 +103,4 @@ - \ No newline at end of file + From ae3a2ec610335694907d91cd94b79afb2d767d3c Mon Sep 17 00:00:00 2001 From: Abby <78209557+abby-cyber@users.noreply.github.com> Date: Tue, 7 Feb 2023 16:10:03 +0800 Subject: [PATCH 007/137] comments fix --- .../3.upgrade-nebula-graph/upgrade-nebula-ent-from-3.x-3.4.md | 4 ++-- mkdocs.yml | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs-2.0/4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-ent-from-3.x-3.4.md b/docs-2.0/4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-ent-from-3.x-3.4.md index 17a923ce215..9f9188a5353 100644 --- a/docs-2.0/4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-ent-from-3.x-3.4.md +++ b/docs-2.0/4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-ent-from-3.x-3.4.md @@ -30,7 +30,7 @@ - 升级 Storage 服务： - 语法： + 命令： ```bash sudo ./bin/db_upgrader --max_concurrent_parts= --src_db_path= --dst_db_path= @@ -58,7 +58,7 @@ - 升级 Meta 服务： - 语法： + 命令： ```bash sudo ./bin/meta_upgrader --src_meta_path= --dst_meta_path= diff --git a/mkdocs.yml b/mkdocs.yml index 3ab31e92e21..cf094a234ee 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -466,7 +466,7 @@ nav: - 升级版本: - 升级 v2.x 至 v3.4（社区版）: 4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-graph-to-latest.md - 升级 v3.x 至 v3.4（社区版）: 4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-from-300-to-latest.md - - 升级 v3.x 至 v3.4 (企业版）: 4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-ent-from-3.x-3.4.md + - 升级 v3.x 至 v3.4（企业版）: 4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-ent-from-3.x-3.4.md - 卸载 NebulaGraph: 4.deployment-and-installation/4.uninstall-nebula-graph.md - 配置与日志: From 0c6f5f36813213539b8694549e67e0933428e0cf Mon Sep 17 00:00:00 2001 From: cooper-lzy <78672629+cooper-lzy@users.noreply.github.com> Date: Tue, 7 Feb 2023 16:37:31 +0800 Subject: [PATCH 008/137] Update README.md --- docs-2.0/README.md | 12 ------------ 1 file changed, 12 deletions(-) diff --git a/docs-2.0/README.md b/docs-2.0/README.md index c302a0ad086..3055611c65c 100644 --- a/docs-2.0/README.md +++ b/docs-2.0/README.md @@ -27,18 +27,6 @@ NebulaGraph 是一款开源的、分布式的、易扩展的原生图数据库 * [生态工具](20.appendix/6.eco-tool-version.md) * [Academy 课程](https://academic.nebula-graph.io/intro/) - -## 最新发布 - -- [NebulaGraph 社区版 {{ nebula.release }}](20.appendix/release-notes/nebula-comm-release-note.md) - -{{ ent.ent_begin }}- [NebulaGraph 企业版 {{ nebula.release }}](20.appendix/release-notes/nebula-ent-release-note.md) {{ ent.ent_end }} -- [NebulaGraph Studio](20.appendix/release-notes/studio-release-note.md) -- [NebulaGraph Dashboard](20.appendix/release-notes/dashboard-comm-release-note.md) -- [NebulaGraph Dashboard 企业版](20.appendix/release-notes/dashboard-ent-release-note.md) -- [NebulaGraph Explorer](20.appendix/release-notes/explorer-release-note.md) - - ## 其他资料 - [学习路径](https://academic.nebula-graph.io/?lang=ZH_CN) From f30ef11634fc97809d92244992fd3c430d6cec86 Mon Sep 17 00:00:00 2001 From: "abby.huang" <78209557+abby-cyber@users.noreply.github.com> Date: Tue, 7 Feb 2023 17:02:57 +0800 Subject: [PATCH 009/137] Update upgrade-nebula-ent-from-3.x-3.4.md (#2567) --- .../3.upgrade-nebula-graph/upgrade-nebula-ent-from-3.x-3.4.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs-2.0/4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-ent-from-3.x-3.4.md b/docs-2.0/4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-ent-from-3.x-3.4.md index bbebb3f82bc..7947a2131d4 100644 --- a/docs-2.0/4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-ent-from-3.x-3.4.md +++ b/docs-2.0/4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-ent-from-3.x-3.4.md @@ -4,7 +4,7 @@ ## 升级说明 -- 此升级操作仅适用于升级企业版 NebulaGraph 3.x 至 3.4.0。 如果您的企业版 NebulaGraph 版本低于 3.0.0，请先升级到企业版 3.x 再升级到 3.4.0。具体操作请参见[升级 NebulaGraph 2.x 至 3.x](upgrade-nebula-graph-to-latest.md)。 +- 此升级操作仅适用于升级企业版 NebulaGraph 3.x 至 3.4.0。 如果您的企业版 NebulaGraph 版本低于 3.0.0，请先升级到企业版 3.x 再升级到 3.4.0。具体操作请参见[升级 NebulaGraph 2.x 至 3.1.0](https://docs.nebula-graph.io/3.1.0/4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-graph-to-latest/)。 - 执行升级操作的集群 IP 地址必须与原集群相同。 From fe83a47c4e160cf6f5ee7608b85a4bb0efac7fc9 Mon Sep 17 00:00:00 2001 From: randomJoe211 <69501902+randomJoe211@users.noreply.github.com> Date: Tue, 7 Feb 2023 17:14:11 +0800 Subject: [PATCH 010/137] Update theme color (#2568) --- docs-2.0/stylesheets/extra.css | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs-2.0/stylesheets/extra.css b/docs-2.0/stylesheets/extra.css index ae13acd10f1..765a15c53a3 100644 --- a/docs-2.0/stylesheets/extra.css +++ b/docs-2.0/stylesheets/extra.css @@ -4,14 +4,14 @@ /* NebulaGraph 黑夜主题色 */ :root{ - --md-primary-fg-color: #00d5ff; /* 导航栏页面颜色 */ - --md-accent-fg-color: #f049d4; /* 选中/悬浮颜色 */ + --md-primary-fg-color: #FF8BFF; /* 导航栏页面颜色 */ + --md-accent-fg-color: #0FA37F; /* 选中/悬浮颜色 */ } /* NebulaGraph 白天主题色 */ [data-md-color-scheme="nebula"]{ --md-primary-fg-color: #0FA37F; /* 导航栏页面颜色 */ - --md-accent-fg-color: #5b1cdb; /* 选中/悬浮颜色 */ + --md-accent-fg-color: #FF8BFF; /* 选中/悬浮颜色 */ --md-code-fg-color: rgb(12, 21, 26); /* 代码段字体色 */ --md-code-bg-color: #eaebec;/* 代码段背景色 */ From e245e7becf45f5e9351eca2b0fb04c8fbfa275ca Mon Sep 17 00:00:00 2001 From: randomJoe211 <69501902+randomJoe211@users.noreply.github.com> Date: Tue, 7 Feb 2023 17:48:47 +0800 Subject: [PATCH 011/137] Update theme color (#2570) --- docs-2.0/stylesheets/extra.css | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs-2.0/stylesheets/extra.css b/docs-2.0/stylesheets/extra.css index 765a15c53a3..9dd0066f78a 100644 --- a/docs-2.0/stylesheets/extra.css +++ b/docs-2.0/stylesheets/extra.css @@ -5,14 +5,14 @@ /* NebulaGraph 黑夜主题色 */ :root{ --md-primary-fg-color: #FF8BFF; /* 导航栏页面颜色 */ - --md-accent-fg-color: #0FA37F; /* 选中/悬浮颜色 */ + --md-accent-fg-color: #0FA37F; /* 选中/悬浮链接的颜色 */ } /* NebulaGraph 白天主题色 */ [data-md-color-scheme="nebula"]{ --md-primary-fg-color: #0FA37F; /* 导航栏页面颜色 */ - --md-accent-fg-color: #FF8BFF; /* 选中/悬浮颜色 */ - + --md-accent-fg-color: #FF8BFF; /* 选中/悬浮链接的颜色 */ + --md-typeset-a-color: #0FA37F!important; /* 白天的链接颜色 */ --md-code-fg-color: rgb(12, 21, 26); /* 代码段字体色 */ --md-code-bg-color: #eaebec;/* 代码段背景色 */ --md-typeset-color: #000000;/* 普通背景字 */ From 389fb0f804a1b8efbcc94700bdebbecedd79a964 Mon Sep 17 00:00:00 2001 From: Steam Date: Tue, 7 Feb 2023 18:07:23 +0800 Subject: [PATCH 012/137] add missing `#` symbol as titled --- docs-2.0/20.appendix/release-notes/nebula-comm-release-note.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs-2.0/20.appendix/release-notes/nebula-comm-release-note.md b/docs-2.0/20.appendix/release-notes/nebula-comm-release-note.md index 06f7e1b88d2..06d8cd9de01 100644 --- a/docs-2.0/20.appendix/release-notes/nebula-comm-release-note.md +++ b/docs-2.0/20.appendix/release-notes/nebula-comm-release-note.md @@ -26,7 +26,7 @@ - 修复索引相关的缺陷： - 全文索引 [#5214](https://github.com/vesoft-inc/nebula/pull/5214) [#5260](https://github.com/vesoft-inc/nebula/pull/5260) - - 字符串索引 [5126](https://github.com/vesoft-inc/nebula/pull/5126) + - 字符串索引 [#5126](https://github.com/vesoft-inc/nebula/pull/5126) - 修复查询语句的缺陷： From e0a1d0c1ce8059c8b3890c731100e93ae1a9a53a Mon Sep 17 00:00:00 2001 From: "abby.huang" <78209557+abby-cyber@users.noreply.github.com> Date: Tue, 7 Feb 2023 18:25:02 +0800 Subject: [PATCH 013/137] operator-version-updates-3.4.0 (#2571) --- docs-2.0/nebula-operator/1.introduction-to-nebula-operator.md | 1 + mkdocs.yml | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/docs-2.0/nebula-operator/1.introduction-to-nebula-operator.md b/docs-2.0/nebula-operator/1.introduction-to-nebula-operator.md index be97ce5e829..b562f0e7392 100644 --- a/docs-2.0/nebula-operator/1.introduction-to-nebula-operator.md +++ b/docs-2.0/nebula-operator/1.introduction-to-nebula-operator.md @@ -34,6 +34,7 @@ NebulaGraph Operator 不支持 v1.x 版本的 NebulaGraph，其与 NebulaGraph | NebulaGraph 版本 |NebulaGraph Operator 版本 | | ------------------- | ---------------- | +| 3.0.0 ~ 3.4.0 |1.4.0| | 3.0.0 ~ 3.3.x |1.3.0| | 3.0.0 ~ 3.3.x |1.0.0、1.1.0、1.2.0| | 2.5.x ~ 2.6.x |0.9.0| diff --git a/mkdocs.yml b/mkdocs.yml index 6f6ee408d5e..f532b3eb3ab 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -244,7 +244,7 @@ extra: tag: v1.4.0 branch: release-1.4 upgrade_from: 3.0.0 - upgrade_to: 3.3.x + upgrade_to: 3.4.0 exporter: release: 3.3.0 branch: release-3.3 From 0325061ab39c121e286ce425c097988c11250b5a Mon Sep 17 00:00:00 2001 From: cooper-lzy <78672629+cooper-lzy@users.noreply.github.com> Date: Wed, 8 Feb 2023 08:59:27 +0800 Subject: [PATCH 014/137] update compatibility (#2572) --- docs-2.0/nebula-dashboard-ent/1.what-is-dashboard-ent.md | 1 + docs-2.0/nebula-dashboard/1.what-is-dashboard.md | 1 + .../about-exchange/ex-ug-what-is-exchange.md | 7 +++++-- .../about-explorer/ex-ug-what-is-explorer.md | 1 + .../about-studio/st-ug-what-is-graph-studio.md | 1 + 5 files changed, 9 insertions(+), 2 deletions(-) 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 938ca5112f3..b08e428dab9 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 @@ -45,6 +45,7 @@ NebulaGraph 的版本和 Dashboard 企业版的版本对应关系如下。 |NebulaGraph 版本|Dashboard 版本| |:---|:---| +|3.4.0 |3.4.0、3.2.4、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| diff --git a/docs-2.0/nebula-dashboard/1.what-is-dashboard.md b/docs-2.0/nebula-dashboard/1.what-is-dashboard.md index d2a6da1071d..5c6c1d31b54 100644 --- a/docs-2.0/nebula-dashboard/1.what-is-dashboard.md +++ b/docs-2.0/nebula-dashboard/1.what-is-dashboard.md @@ -40,6 +40,7 @@ NebulaGraph 的版本和 Dashboard 社区版的版本对应关系如下。 |NebulaGraph 版本|Dashboard 版本| |:---|:---| +|3.4.0 |3.4.0、3.2.0| |3.3.0 |3.2.0| |2.5.0 ~ 3.2.0|3.1.0| |2.5.x ~ 3.1.0|1.1.1| 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 1667e506eac..3765c2c08b4 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 @@ -58,10 +58,13 @@ NebulaGraph Exchange 版本（即 JAR 包版本）、NebulaGraph 内核版本和 |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_3.0-3.4.0.jar | 3.x.x |3.3.x、3.2.x、3.1.x、3.0.x | +|nebula-exchange_spark_2.4-3.4.0.jar | 3.x.x |2.4.x | +|nebula-exchange_spark_2.2-3.4.0.jar | 3.x.x |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_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 | 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 cc786aed4b9..fd8a5103a69 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 @@ -47,6 +47,7 @@ NebulaGraph 的版本和 Explorer 版本对应关系如下。 | NebulaGraph 版本 | Explorer 版本 | | --- | --- | +| 3.4.0 | 3.4.0、3.2.1、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 | 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 2b203e06354..2a644a95f42 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 @@ -52,6 +52,7 @@ Studio 可以方便管理 NebulaGraph 图数据，具备以下功能： | NebulaGraph 版本 | Studio 版本 | | --- | --- | +| 3.4.0 | 3.6.0、3.5.0 | | 3.3.0 | 3.5.0 | | 3.0.0 ～ 3.2.x| 3.4.1、3.4.0| | 3.1.0 | 3.3.2 | From b091a65d12e1ea39986d8375df5db1159f4a4324 Mon Sep 17 00:00:00 2001 From: "abby.huang" <78209557+abby-cyber@users.noreply.github.com> Date: Wed, 8 Feb 2023 10:15:52 +0800 Subject: [PATCH 015/137] Update 3.br-backup-data.md --- docs-2.0/backup-and-restore/nebula-br/3.br-backup-data.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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 bb87f3c20f0..431482f1da7 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 @@ -8,7 +8,7 @@ - 确认 NebulaGraph 服务正在运行中。 -- 如果在本地保存备份文件，需要在 Meta 服务器、Storage 服务器和 BR 机器上创建绝对路径相同的目录，并记录绝对路径，同时需要保证账号对该目录有写权限。 +- 如果在本地保存备份文件，需要在 Meta 服务器、Storage 服务器和 BR 机器上创建绝对路径相同的备份目录，并记录绝对路径，同时需要保证账号对该目录有写权限。 !!! Note From 6b2331932758d3b40c497a3a9e5255af41adc430 Mon Sep 17 00:00:00 2001 From: "abby.huang" <78209557+abby-cyber@users.noreply.github.com> Date: Wed, 8 Feb 2023 10:43:34 +0800 Subject: [PATCH 016/137] unhide operator until 12.2.2023 (#2573) --- mkdocs.yml | 32 ++++++++++++++++---------------- 1 file changed, 16 insertions(+), 16 deletions(-) diff --git a/mkdocs.yml b/mkdocs.yml index f532b3eb3ab..c7868d0efe3 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -701,22 +701,22 @@ nav: - 导出 NebulaGraph 数据: nebula-exchange/use-exchange/ex-ug-export-from-nebula.md - Exchange 常见问题: nebula-exchange/ex-ug-FAQ.md - - NebulaGraph Operator: - - 什么是 NebulaGraph Operator: nebula-operator/1.introduction-to-nebula-operator.md - - 使用流程: nebula-operator/6.get-started-with-operator.md - - 部署 NebulaGraph Operator: nebula-operator/2.deploy-nebula-operator.md - - 部署 NebulaGraph集群: - - 使用 Kubectl 部署 NebulaGraph 集群: nebula-operator/3.deploy-nebula-graph-cluster/3.1create-cluster-with-kubectl.md - - 使用 Helm 部署 NebulaGraph 集群: nebula-operator/3.deploy-nebula-graph-cluster/3.2create-cluster-with-helm.md - - 配置 NebulaGraph 集群: - - 自定义 NebulaGraph 集群的配置参数: nebula-operator/8.custom-cluster-configurations/8.1.custom-conf-parameter.md - - 回收 PV: nebula-operator/8.custom-cluster-configurations/8.2.pv-reclaim.md -#ent - - 均衡扩容后的 Storage 数据: nebula-operator/8.custom-cluster-configurations/8.3.balance-data-when-scaling-storage.md - - 升级 NebulaGraph 集群: nebula-operator/9.upgrade-nebula-cluster.md - - 连接 NebulaGraph 数据库: nebula-operator/4.connect-to-nebula-graph-service.md - - 故障自愈: nebula-operator/5.operator-failover.md - - 常见问题: nebula-operator/7.operator-faq.md +# - NebulaGraph Operator: +# - 什么是 NebulaGraph Operator: nebula-operator/1.introduction-to-nebula-operator.md +# - 使用流程: nebula-operator/6.get-started-with-operator.md +# - 部署 NebulaGraph Operator: nebula-operator/2.deploy-nebula-operator.md +# - 部署 NebulaGraph集群: +# - 使用 Kubectl 部署 NebulaGraph 集群: nebula-operator/3.deploy-nebula-graph-cluster/3.1create-cluster-with-kubectl.md +# - 使用 Helm 部署 NebulaGraph 集群: nebula-operator/3.deploy-nebula-graph-cluster/3.2create-cluster-with-helm.md +# - 配置 NebulaGraph 集群: +# - 自定义 NebulaGraph 集群的配置参数: nebula-operator/8.custom-cluster-configurations/8.1.custom-conf-parameter.md +# - 回收 PV: nebula-operator/8.custom-cluster-configurations/8.2.pv-reclaim.md +# #ent +# - 均衡扩容后的 Storage 数据: nebula-operator/8.custom-cluster-configurations/8.3.balance-data-when-scaling-storage.md +# - 升级 NebulaGraph 集群: nebula-operator/9.upgrade-nebula-cluster.md +# - 连接 NebulaGraph 数据库: nebula-operator/4.connect-to-nebula-graph-service.md +# - 故障自愈: nebula-operator/5.operator-failover.md +# - 常见问题: nebula-operator/7.operator-faq.md - 图计算: From edc5a91bbc63ecb1886cbdc01ad5a8ab675b7ecf Mon Sep 17 00:00:00 2001 From: cooper-lzy <78672629+cooper-lzy@users.noreply.github.com> Date: Thu, 9 Feb 2023 09:28:35 +0800 Subject: [PATCH 017/137] Update mkdocs.yml --- mkdocs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/mkdocs.yml b/mkdocs.yml index c7868d0efe3..85fec3f09de 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -158,7 +158,7 @@ extra: base111b: 1.1.1-beta base220: 2.2.1 base300: 3.0.0 - release: 3.5.0 + release: 3.6.0 tag: v3.6.0 explorer: release: 3.4.0 From c5b8edc0b52ef68c182b0151c6a9dda7ce7b5ff5 Mon Sep 17 00:00:00 2001 From: cooper-lzy <78672629+cooper-lzy@users.noreply.github.com> Date: Thu, 9 Feb 2023 10:32:23 +0800 Subject: [PATCH 018/137] Update st-ug-deploy.md --- docs-2.0/nebula-studio/deploy-connect/st-ug-deploy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs-2.0/nebula-studio/deploy-connect/st-ug-deploy.md b/docs-2.0/nebula-studio/deploy-connect/st-ug-deploy.md index f6dc7e791b5..5263aa841e7 100644 --- a/docs-2.0/nebula-studio/deploy-connect/st-ug-deploy.md +++ b/docs-2.0/nebula-studio/deploy-connect/st-ug-deploy.md @@ -312,7 +312,7 @@ $ kill $(lsof -t -i :7001) # stop nebula-graph-studio |:---|:---|:---| | replicaCount | 0 | Deployment 的副本数。 | | image.nebulaStudio.name | vesoft/nebula-graph-studio | nebula-graph-studio 镜像的仓库地址。 | - | image.nebulaStudio.version | v3.2.0 | nebula-graph-studio 的版本。 | + | image.nebulaStudio.version | {{studio.tag}} | nebula-graph-studio 的版本。 | | service.type | ClusterIP | 服务类型，必须为`NodePort`，`ClusterIP`或`LoadBalancer`其中之一。 | | service.port | 7001 | nebula-graph-studio 中 web 服务的端口。 | | service.nodePort | 32701 | Kubernetes 集群外部访问 nebula-studio 的代理端口。 | From 84ebe617c0ecc8aaca78dc7e749b50cf85733e0b Mon Sep 17 00:00:00 2001 From: cooper-lzy <78672629+cooper-lzy@users.noreply.github.com> Date: Thu, 9 Feb 2023 11:57:38 +0800 Subject: [PATCH 019/137] Update st-ug-what-is-graph-studio.md --- .../nebula-studio/about-studio/st-ug-what-is-graph-studio.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) 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 2a644a95f42..b073af6b02a 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 @@ -52,8 +52,8 @@ Studio 可以方便管理 NebulaGraph 图数据，具备以下功能： | NebulaGraph 版本 | Studio 版本 | | --- | --- | -| 3.4.0 | 3.6.0、3.5.0 | -| 3.3.0 | 3.5.0 | +| 3.4.0 | 3.6.0、3.5.1、3.5.0 | +| 3.3.0 | 3.5.1、3.5.0 | | 3.0.0 ～ 3.2.x| 3.4.1、3.4.0| | 3.1.0 | 3.3.2 | | 3.0.0 | 3.2.x | From e5f7d324b612a0db1163a0afaee767056353144b Mon Sep 17 00:00:00 2001 From: Anqi Date: Thu, 9 Feb 2023 14:02:38 +0800 Subject: [PATCH 020/137] Update ex-ug-parameter.md --- docs-2.0/nebula-exchange/parameter-reference/ex-ug-parameter.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs-2.0/nebula-exchange/parameter-reference/ex-ug-parameter.md b/docs-2.0/nebula-exchange/parameter-reference/ex-ug-parameter.md index 1750a7ea7c7..2c2dcab4eeb 100644 --- a/docs-2.0/nebula-exchange/parameter-reference/ex-ug-parameter.md +++ b/docs-2.0/nebula-exchange/parameter-reference/ex-ug-parameter.md @@ -116,7 +116,7 @@ |参数|数据类型|默认值|是否必须|说明| |:---|:---|:---|:---|:---| |`tags.path`|string|-|是|HDFS 中点数据文件的路径。用双引号括起路径，以`hdfs://`开头。| -|`tags.separator`|string|`,`|是|分隔符。默认值为英文逗号（,）。| +|`tags.separator`|string|`,`|是|分隔符。默认值为英文逗号（,）。对于特殊字符，如控制符^A,用 UNICODE编码十六进制"\u0001"表示，控制符^B，用UNICODE编码十六进制"\u0002"表示，控制符^C，用UNICODE编码十六进制"\u0003"表示。| |`tags.header`|bool|`true`|是|文件是否有表头。| ### Hive 源特有参数 From 2d60e96ea367106d8b45439e471f998997b4f84e Mon Sep 17 00:00:00 2001 From: Anqi Date: Thu, 9 Feb 2023 14:12:13 +0800 Subject: [PATCH 021/137] Update ex-ug-parameter.md --- docs-2.0/nebula-exchange/parameter-reference/ex-ug-parameter.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs-2.0/nebula-exchange/parameter-reference/ex-ug-parameter.md b/docs-2.0/nebula-exchange/parameter-reference/ex-ug-parameter.md index 2c2dcab4eeb..14f8737b1f1 100644 --- a/docs-2.0/nebula-exchange/parameter-reference/ex-ug-parameter.md +++ b/docs-2.0/nebula-exchange/parameter-reference/ex-ug-parameter.md @@ -116,7 +116,7 @@ |参数|数据类型|默认值|是否必须|说明| |:---|:---|:---|:---|:---| |`tags.path`|string|-|是|HDFS 中点数据文件的路径。用双引号括起路径，以`hdfs://`开头。| -|`tags.separator`|string|`,`|是|分隔符。默认值为英文逗号（,）。对于特殊字符，如控制符^A,用 UNICODE编码十六进制"\u0001"表示，控制符^B，用UNICODE编码十六进制"\u0002"表示，控制符^C，用UNICODE编码十六进制"\u0003"表示。| +|`tags.separator`|string|`,`|是|分隔符。默认值为英文逗号（,）。对于特殊字符，如控制符^A,可以用ASCII八进制"\001" 或 UNICODE编码十六进制"\u0001"表示，控制符^B，用ASCII八进制 "\002" 或 UNICODE编码十六进制"\u0002"表示，控制符^C，用ASCII八进制"\003" 或 UNICODE编码十六进制"\u0003"表示。| |`tags.header`|bool|`true`|是|文件是否有表头。| ### Hive 源特有参数 From 15708ce433af1a19772cba6aaf793312db961301 Mon Sep 17 00:00:00 2001 From: Anqi Date: Thu, 9 Feb 2023 14:29:30 +0800 Subject: [PATCH 022/137] Update ex-ug-parameter.md --- docs-2.0/nebula-exchange/parameter-reference/ex-ug-parameter.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs-2.0/nebula-exchange/parameter-reference/ex-ug-parameter.md b/docs-2.0/nebula-exchange/parameter-reference/ex-ug-parameter.md index 14f8737b1f1..4a937f9713a 100644 --- a/docs-2.0/nebula-exchange/parameter-reference/ex-ug-parameter.md +++ b/docs-2.0/nebula-exchange/parameter-reference/ex-ug-parameter.md @@ -116,7 +116,7 @@ |参数|数据类型|默认值|是否必须|说明| |:---|:---|:---|:---|:---| |`tags.path`|string|-|是|HDFS 中点数据文件的路径。用双引号括起路径，以`hdfs://`开头。| -|`tags.separator`|string|`,`|是|分隔符。默认值为英文逗号（,）。对于特殊字符，如控制符^A,可以用ASCII八进制"\001" 或 UNICODE编码十六进制"\u0001"表示，控制符^B，用ASCII八进制 "\002" 或 UNICODE编码十六进制"\u0002"表示，控制符^C，用ASCII八进制"\003" 或 UNICODE编码十六进制"\u0003"表示。| +|`tags.separator`|string|`,`|是|分隔符。默认值为英文逗号（,）。对于特殊字符，如控制符'^A',可以用ASCII八进制"\001" 或 UNICODE编码十六进制"\u0001"表示，控制符'^B'，用ASCII八进制 "\002" 或 UNICODE编码十六进制"\u0002"表示，控制符'^C'，用ASCII八进制"\003" 或 UNICODE编码十六进制"\u0003"表示。| |`tags.header`|bool|`true`|是|文件是否有表头。| ### Hive 源特有参数 From 971b66e0eed383e3f3be5bf32046163839cbd5f1 Mon Sep 17 00:00:00 2001 From: cooper-lzy <78672629+cooper-lzy@users.noreply.github.com> Date: Thu, 9 Feb 2023 14:48:56 +0800 Subject: [PATCH 023/137] Update ex-ug-parameter.md --- docs-2.0/nebula-exchange/parameter-reference/ex-ug-parameter.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs-2.0/nebula-exchange/parameter-reference/ex-ug-parameter.md b/docs-2.0/nebula-exchange/parameter-reference/ex-ug-parameter.md index 4a937f9713a..4de090ae0cc 100644 --- a/docs-2.0/nebula-exchange/parameter-reference/ex-ug-parameter.md +++ b/docs-2.0/nebula-exchange/parameter-reference/ex-ug-parameter.md @@ -116,7 +116,7 @@ |参数|数据类型|默认值|是否必须|说明| |:---|:---|:---|:---|:---| |`tags.path`|string|-|是|HDFS 中点数据文件的路径。用双引号括起路径，以`hdfs://`开头。| -|`tags.separator`|string|`,`|是|分隔符。默认值为英文逗号（,）。对于特殊字符，如控制符'^A',可以用ASCII八进制"\001" 或 UNICODE编码十六进制"\u0001"表示，控制符'^B'，用ASCII八进制 "\002" 或 UNICODE编码十六进制"\u0002"表示，控制符'^C'，用ASCII八进制"\003" 或 UNICODE编码十六进制"\u0003"表示。| +|`tags.separator`|string|`,`|是|分隔符。默认值为英文逗号（,）。对于特殊字符，如控制符`^A`,可以用 ASCII 八进制`\001`或 UNICODE 编码十六进制`\u0001`表示，控制符`^B`，用 ASCII 八进制`\002`或 UNICODE 编码十六进制`\u0002`表示，控制符`^C`，用 ASCII 八进制`\003`或 UNICODE 编码十六进制`\u0003`表示。| |`tags.header`|bool|`true`|是|文件是否有表头。| ### Hive 源特有参数 From 02fe0067669c61286f75a1345dfa2b4d39173e4b Mon Sep 17 00:00:00 2001 From: "abby.huang" <78209557+abby-cyber@users.noreply.github.com> Date: Thu, 9 Feb 2023 16:58:14 +0800 Subject: [PATCH 024/137] upgrade-&-fulltext-supplementary-notes (#2577) * upgrade-&-fulltext-supplementary-notes * comment fix * fix * comment fix * comment fix --- .../20.appendix/release-notes/nebula-comm-release-note.md | 8 ++++++++ .../upgrade-nebula-ent-from-3.x-3.4.md | 7 ++++++- .../upgrade-nebula-from-300-to-latest.md | 6 ++++++ .../upgrade-nebula-graph-to-latest.md | 7 +++++-- 4 files changed, 25 insertions(+), 3 deletions(-) diff --git a/docs-2.0/20.appendix/release-notes/nebula-comm-release-note.md b/docs-2.0/20.appendix/release-notes/nebula-comm-release-note.md index 06d8cd9de01..c2ab82a9985 100644 --- a/docs-2.0/20.appendix/release-notes/nebula-comm-release-note.md +++ b/docs-2.0/20.appendix/release-notes/nebula-comm-release-note.md @@ -62,6 +62,14 @@ - 禁用 TOSS。 [#5119](https://github.com/vesoft-inc/nebula/pull/5119) - 重命名 Listener 的 pid 文件名和 log 目录名。 [#5119](https://github.com/vesoft-inc/nebula/pull/5119) + +## 升级说明 + +如果用户打算升级到该版本，请按照升级文档进行操作。 + +- [升级 NebulaGraph v2.x 至 v3.4.0](../../4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-graph-to-latest.md) +- [升级 NebulaGraph v3.x 至 v3.4.0](../../4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-from-300-to-latest.md) + ## 历史版本 [历史版本](https://www.nebula-graph.com.cn/tags/%E5%8F%91%E7%89%88%E8%AF%B4%E6%98%8E) diff --git a/docs-2.0/4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-ent-from-3.x-3.4.md b/docs-2.0/4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-ent-from-3.x-3.4.md index 2ee0cc0b142..3fdbd0f63d3 100644 --- a/docs-2.0/4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-ent-from-3.x-3.4.md +++ b/docs-2.0/4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-ent-from-3.x-3.4.md @@ -4,12 +4,17 @@ ## 升级说明 -- 此升级操作仅适用于升级企业版 NebulaGraph 3.x 至 3.4.0。 如果您的企业版 NebulaGraph 版本低于 3.0.0，请先升级到企业版 3.x 再升级到 3.4.0。具体操作请参见[升级 NebulaGraph 2.x 至 3.1.0](https://docs.nebula-graph.com.cn/3.1.0/4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-graph-to-latest/)。 +- 此升级操作仅适用于升级企业版 NebulaGraph 3.x 至 3.4.0。 如果您的企业版 NebulaGraph 版本低于 3.0.0，请先升级到企业版 3.1.0 再升级到 3.4.0。具体操作请参见[升级 NebulaGraph 2.x 至 3.1.0](https://docs.nebula-graph.com.cn/3.1.0/4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-graph-to-latest/)。 - 执行升级操作的集群 IP 地址必须与原集群相同。 - 机器硬盘剩余空间至少需为原数据目录的 1.5 倍。 +- 在升级部署了全文索引的 NebulaGraph 前，需要手动删除 Elasticsearch (ES) 中的全文索引。在升级后需要重新使用`SIGN IN`语句登录 ES 并重新创建全文索引。 + + !!! note + + 用户可通过 cURL 命令手动删除 ES 中全文索引。命令为`curl -XDELETE -u : ':/'`，例如`curl -XDELETE -u elastic:elastic 'http://192.168.8.223:9200/nebula_index_2534'`。如果 ES 没有设置用户名及密码，则无需指定`-u`选项。 ## 升级步骤 diff --git a/docs-2.0/4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-from-300-to-latest.md b/docs-2.0/4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-from-300-to-latest.md index 88734559bfb..124fcff8bf2 100644 --- a/docs-2.0/4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-from-300-to-latest.md +++ b/docs-2.0/4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-from-300-to-latest.md @@ -2,6 +2,12 @@ NebulaGraph v3.x 升级至 v{{nebula.release}}，只需要使用 v{{nebula.release}}的 RPM/DEB 包进行升级操作即可，或者[编译 v{{nebula.release}}](../2.compile-and-install-nebula-graph/1.install-nebula-graph-by-compiling-the-source-code.md) 之后重新安装。 + +!!! caution + + 在升级部署了全文索引的 NebulaGraph 前，需要手动删除 Elasticsearch (ES) 中的全文索引。在升级后需要重新使用`SIGN IN`语句登录 ES 并重新创建全文索引。用户可通过 cURL 命令手动删除 ES 中全文索引。命令为`curl -XDELETE -u : ':/'`，例如`curl -XDELETE -u elastic:elastic 'http://192.168.8.223:9200/nebula_index_2534'`。如果 ES 没有设置用户名及密码，则无需指定`-u`选项。 + + ## RPM/DEB 包升级步骤 1. 下载 [RPM/DEB 包](https://github.com/vesoft-inc/nebula-graph/releases/tag/v{{nebula.release}})。 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 3a04eb3390f..adb323a274d 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 @@ -4,13 +4,12 @@ ## 适用版本 -本文适用于将 NebulaGraph 从 2.0.0 及之后的 2.x 版本升级到 {{nebula.release}} 版本。不适用于 2.0.0 之前的历史版本（含 1.x 版本）。如需升级历史版本，将其根据最新的 2.x 版本文档升级到最新的 2.x 版本，然后根据本文的说明升级到 3.x 版本。 +本文适用于将 NebulaGraph 从 2.5.0 及之后的 2.x 版本升级到 {{nebula.release}} 版本。不适用于 2.5.0 之前的历史版本（含 1.x 版本）。如需升级历史版本，将其根据最新的 2.x 版本文档升级到 2.5 版本，然后根据本文的说明升级到 {{nebula.release}} 版本。 !!! caution 如需从 2.0.0 之前的版本（含 1.x 版本）升级到 {{nebula.release}}，还需找到 {{nebula.release}} 版本文件中`share/resources`目录下的`date_time_zonespec.csv`文件，将其复制到 NebulaGraph 安装路径下的相同目录内。也可从 [GitHub](https://github.com/vesoft-inc/nebula/blob/master/resources/date_time_zonespec.csv) 下载该文件。 -## 升级限制 - 不支持轮转热升级，需完全停止整个集群服务。 @@ -54,6 +53,10 @@ - MATCH 语句中获取点属性时，必须指定 Tag，例如从`return v.name`变为`return v.player.name`。 +- 全文索引 + + 在升级部署了全文索引的 NebulaGraph 前，需要手动删除 Elasticsearch (ES) 中的全文索引。在升级后需要重新使用`SIGN IN`语句登录 ES 并重新创建全文索引。用户可通过 cURL 命令手动删除 ES 中全文索引。命令为`curl -XDELETE -u : ':/'`，例如`curl -XDELETE -u elastic:elastic 'http://192.168.8.223:9200/nebula_index_2534'`。如果 ES 没有设置用户名及密码，则无需指定`-u`选项。 + !!! caution 可能存在其它暂未发现的影响，建议升级前详细查看版本发布说明和产品手册，并密切关注[论坛](https://discuss.nebula-graph.com.cn/)与 [GitHub](https://github.com/vesoft-inc/nebula/issues) 的最新动态。 From 6ab4e420adabf1fe75ccbc5db3dac009ce6244ef Mon Sep 17 00:00:00 2001 From: "abby.huang" <78209557+abby-cyber@users.noreply.github.com> Date: Fri, 10 Feb 2023 14:01:38 +0800 Subject: [PATCH 025/137] Br updates (#2578) * br updates * Update 2.compile-br.md --- docs-2.0/backup-and-restore/nebula-br-ent/2.install-tools.md | 2 +- docs-2.0/backup-and-restore/nebula-br/1.what-is-br.md | 2 +- docs-2.0/backup-and-restore/nebula-br/2.compile-br.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs-2.0/backup-and-restore/nebula-br-ent/2.install-tools.md b/docs-2.0/backup-and-restore/nebula-br-ent/2.install-tools.md index 807be502aa8..80a8958677c 100644 --- a/docs-2.0/backup-and-restore/nebula-br-ent/2.install-tools.md +++ b/docs-2.0/backup-and-restore/nebula-br-ent/2.install-tools.md @@ -10,7 +10,7 @@ |NebulaGraph 企业版|BR 企业版|Agent | |:---|:---|:---| -|{{nebula.release}}|{{br_ent.release}}|{{agent.release}}| +|3.4.0|3.4.0|3.4.0| ## 安装 BR（企业版） 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 aa23886dae2..f09f071f1d9 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 @@ -13,7 +13,7 @@ Backup&Restore（简称 BR）是一款命令行界面（CLI）工具，可以帮 ## 限制 -- NebulaGraph 版本需要为 v{{ nebula.release }}。 +- NebulaGraph 版本需要为 v3.x。 - 数据备份仅支持全量备份，不支持增量备份。 - NebulaGraph Listener 暂时不支持备份，且全文索引也不支持备份。 - 如果备份数据到本地磁盘，备份的文件将会放置在每个服务器的本地路径中。也可以在本地挂载 NFS 文件系统，以便将备份数据还原到不同的主机上。 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 1e87ddcdfbb..cd98fc18209 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 @@ -10,7 +10,7 @@ |NebulaGraph 社区版|BR 社区版 |Agent | |:---|:---|:---| -|3.3.0|3.3.0|0.2.0| +|3.3.0 ~ 3.4.0|3.3.0|3.4.0、0.2.0| |3.0.x ~ 3.2.x|0.6.1|0.1.0 ~ 0.2.0| ## 安装 BR From 85d958653600063b2a4b0808e449b7148efa29e6 Mon Sep 17 00:00:00 2001 From: "abby.huang" <78209557+abby-cyber@users.noreply.github.com> Date: Fri, 10 Feb 2023 14:30:51 +0800 Subject: [PATCH 026/137] list-display-fix-for-insert-edge (#2579) --- docs-2.0/3.ngql-guide/13.edge-statements/1.insert-edge.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs-2.0/3.ngql-guide/13.edge-statements/1.insert-edge.md b/docs-2.0/3.ngql-guide/13.edge-statements/1.insert-edge.md index 2ca669b00e8..e05720dc24e 100644 --- a/docs-2.0/3.ngql-guide/13.edge-statements/1.insert-edge.md +++ b/docs-2.0/3.ngql-guide/13.edge-statements/1.insert-edge.md @@ -21,9 +21,9 @@ INSERT EDGE [IF NOT EXISTS] ( ) VALUES - `IF NOT EXISTS`：用户可以使用`IF NOT EXISTS`关键字检测待插入的边是否存在，只有不存在时，才会插入。 !!! Note - - `IF NOT EXISTS` 仅检测<边的类型、起始点、目的点和 rank>是否存在，不会检测属性值是否重合。 + - `IF NOT EXISTS` 仅检测<边的类型、起始点、目的点和 rank>是否存在，不会检测属性值是否重合。 - - `IF NOT EXISTS` 会先读取一次数据是否存在，因此对性能会有明显影响。 + - `IF NOT EXISTS` 会先读取一次数据是否存在，因此对性能会有明显影响。 - ``：边关联的 Edge type，只能指定一个 Edge type。Edge type 必须提前创建，详情请参见 [CREATE EDGE](../11.edge-type-statements/1.create-edge.md)。 From c6e49fb15dc16ca328553e0daa3ea618286d5044 Mon Sep 17 00:00:00 2001 From: cooper-lzy <78672629+cooper-lzy@users.noreply.github.com> Date: Mon, 13 Feb 2023 09:01:04 +0800 Subject: [PATCH 027/137] Update nebula-algorithm.md (#2580) --- docs-2.0/graph-computing/nebula-algorithm.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs-2.0/graph-computing/nebula-algorithm.md b/docs-2.0/graph-computing/nebula-algorithm.md index 01892f00a34..a0bf90888a4 100644 --- a/docs-2.0/graph-computing/nebula-algorithm.md +++ b/docs-2.0/graph-computing/nebula-algorithm.md @@ -56,7 +56,8 @@ NebulaGraph Algorithm 支持的图计算算法如下。 | DegreeStatic | 度统计 |图结构分析|degree,inDegree,outDegree| int/string | | ClusteringCoefficient | 聚集系数 |推荐、电信诈骗分析| clustercoefficient |double/string| | Jaccard | 杰卡德相似度计算| 相似度计算、推荐| jaccard | string | - | BFS | 广度优先遍历| 层序遍历、最短路径规划| bfs | string | + | BFS | 广度优先遍历| 层序遍历、最短路径规划 | bfs | string | + | DFS | 深度优先遍历| 层序遍历、最短路径规划 | dfs | string | | Node2Vec | - | 图分类 | node2vec | string | !!! note From 92b4cb315a7bf61832cbc1761cf2d4a37089255f Mon Sep 17 00:00:00 2001 From: foesa <35463247+foesa-yang@users.noreply.github.com> Date: Mon, 13 Feb 2023 14:13:06 +0800 Subject: [PATCH 028/137] Update 3.upsert-vertex.md --- .../3.ngql-guide/12.vertex-statements/3.upsert-vertex.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs-2.0/3.ngql-guide/12.vertex-statements/3.upsert-vertex.md b/docs-2.0/3.ngql-guide/12.vertex-statements/3.upsert-vertex.md index 4873fdbaf57..2dcb4861ddf 100644 --- a/docs-2.0/3.ngql-guide/12.vertex-statements/3.upsert-vertex.md +++ b/docs-2.0/3.ngql-guide/12.vertex-statements/3.upsert-vertex.md @@ -8,9 +8,9 @@ `UPSERT VERTEX`性能远低于`INSERT`，因为`UPSERT`是一组分片级别的读取、修改、写入操作。 -!!! danger +!!! caution - 禁止在高并发写操作的情况下使用`UPSERT`语句，请使用`UPDATE`或`INSERT`代替。 + 并发`UPSERT`同一个 TAG 或 EDGE TYPE 会报错。 ## 语法 @@ -161,4 +161,4 @@ nebula> UPSERT VERTEX ON player "player101" \ +---------------+-----+ | "Tony Parker" | 38 | +---------------+-----+ -``` \ No newline at end of file +``` From 31bc2d584be7c74f4d32e199fac866a2bac59629 Mon Sep 17 00:00:00 2001 From: foesa <35463247+foesa-yang@users.noreply.github.com> Date: Mon, 13 Feb 2023 14:56:46 +0800 Subject: [PATCH 029/137] Update 3.upsert-edge.md --- docs-2.0/3.ngql-guide/13.edge-statements/3.upsert-edge.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs-2.0/3.ngql-guide/13.edge-statements/3.upsert-edge.md b/docs-2.0/3.ngql-guide/13.edge-statements/3.upsert-edge.md index 0a4e85d7bdd..e3648de9de0 100644 --- a/docs-2.0/3.ngql-guide/13.edge-statements/3.upsert-edge.md +++ b/docs-2.0/3.ngql-guide/13.edge-statements/3.upsert-edge.md @@ -4,10 +4,10 @@ `UPSERT EDGE`性能远低于`INSERT`，因为`UPSERT`是一组分片级别的读取、修改、写入操作。 -!!! danger - - 禁止在高并发写操作的情况下使用`UPSERT`语句，请使用`UPDATE`或`INSERT`代替。 +!!! caution + 并发`UPSERT`同一个 TAG 或 EDGE TYPE 会报错。 + ## 语法 ```ngql From 3e373b946bd9f1e84eda5e49bdbdf82bdb036a45 Mon Sep 17 00:00:00 2001 From: "abby.huang" <78209557+abby-cyber@users.noreply.github.com> Date: Tue, 14 Feb 2023 14:47:16 +0800 Subject: [PATCH 030/137] [wip]Operator br (#2585) * add operator-br * add operator-br * more details --- .../1.introduction-to-nebula-operator.md | 5 +- .../10.backup-restore-using-operator.md | 216 ++++++++++++++++++ mkdocs.yml | 40 ++-- 3 files changed, 242 insertions(+), 19 deletions(-) create mode 100644 docs-2.0/nebula-operator/10.backup-restore-using-operator.md diff --git a/docs-2.0/nebula-operator/1.introduction-to-nebula-operator.md b/docs-2.0/nebula-operator/1.introduction-to-nebula-operator.md index b562f0e7392..5dd31982180 100644 --- a/docs-2.0/nebula-operator/1.introduction-to-nebula-operator.md +++ b/docs-2.0/nebula-operator/1.introduction-to-nebula-operator.md @@ -22,6 +22,8 @@ NebulaGraph Operator 已具备的功能如下： - **集群升级**：支持升级 {{operator.upgrade_from}} 版的 NebulaGraph 集群至 {{operator.upgrade_to}} 版。 +- **备份和恢复**：支持备份 NebulaGraph 集群的数据至兼容 S3 协议的存储服务中并支持恢复数据至集群中。更多信息参考[使用 NebulaGraph Operator 备份和恢复数据](10.backup-restore-using-operator.md)。 + - **故障自愈**：NebulaGraph Operator 调用 NebulaGraph 集群提供的接口，动态地感知服务状态。一旦发现异常，NebulaGraph Operator 自动进行容错处理。更多信息参考[故障自愈](5.operator-failover.md)。 - **均衡调度**：基于调度器扩展接口，NebulaGraph Operator 提供的调度器可以将应用 Pods 均匀地分布在 NebulaGraph 集群中。 @@ -34,8 +36,7 @@ NebulaGraph Operator 不支持 v1.x 版本的 NebulaGraph，其与 NebulaGraph | NebulaGraph 版本 |NebulaGraph Operator 版本 | | ------------------- | ---------------- | -| 3.0.0 ~ 3.4.0 |1.4.0| -| 3.0.0 ~ 3.3.x |1.3.0| +| 3.0.0 ~ 3.4.0 |1.3.0、1.4.0| | 3.0.0 ~ 3.3.x |1.0.0、1.1.0、1.2.0| | 2.5.x ~ 2.6.x |0.9.0| | 2.5.x |0.8.0| diff --git a/docs-2.0/nebula-operator/10.backup-restore-using-operator.md b/docs-2.0/nebula-operator/10.backup-restore-using-operator.md new file mode 100644 index 00000000000..f6eb46845f1 --- /dev/null +++ b/docs-2.0/nebula-operator/10.backup-restore-using-operator.md @@ -0,0 +1,216 @@ +# 使用 NebulaGraph Operator 备份和恢复数据 + +本文介绍如何对 Kubernetes 上的 NebulaGraph 集群进行数据备份和数据恢复。 + +!!! enterpriseonly + + 仅支持备份和恢复 Kubernetes 上的企业版 NebulaGraph 集群。 + +## 原理介绍 + +[NebulaGraph BR（企业版）](../backup-and-restore/nebula-br-ent/1.br-ent-overview.md)工具是 NebulaGraph 企业版数据备份和恢复的命令行工具。NebulaGraph Operator 基于 BR 工具来实现 Kubernetes 上的 NebulaGraph 集群数据的备份和恢复。 + +备份数据时，NebulaGraph Operator 会创建一个 Job，然后将 NebulaGraph 集群中的数据备份到指定的存储服务上。 + +恢复数据时，NebulaGraph Operator 会根据 NebulaRestore 资源对象定义的信息检查指定的备份 NebulaGraph 集群是否存在、远端存储的访问是否正常，并且会创建一个新的集群，然后将备份数据恢复到新创建的 NebulaGraph 集群中。更多信息参见[恢复流程图](https://github.com/vesoft-inc/nebula-operator/blob/v{{operator.release}}/doc/user/br_guide.md#restore-nebulagraph-cluster)。 + + +## 前提条件 + +使用 NebulaGraph Operator 备份和恢复数据，需要满足以下条件： + +- Nebula Operator 版本 >= 1.4.0。 +- Kubernetes 上部署的企业版 NebulaGraph 集群正在运行。 +- 在创建集群的 YAML 中，设置了`spec.enableBR`为`true`。详细信息参见[]()。 +- 只支持使用 S3 协议的存储服务（例如 AWS S3，Minio 等）备份和恢复数据。 +- 集群中有足够的计算资源以恢复数据。 + +## 备份数据 + +### 备份说明 + +- NebulaGraph Operator 支持全量备份和增量备份。 +- 数据备份过程中，指定图空间中的 DDL 和 DML 语句将会阻塞，我们建议在业务低峰期进行操作，例如凌晨 2 点至 5 点。 +- 执行增量备份的集群和指定的上一次备份的集群需为同一个，并且和指定的上一次备份的（存储桶）路径需相同。 +- 确保每次增量备份距离上一次备份的时间小于一个wal_ttl的时间。 +- 确保 Agent 有对应 NebulaGraph 安装目录和备份目录的读写权限。 +- 不支持备份指定图空间数据。 + +### 全量备份 + +当备份数据至兼容 S3 协议的存储服务上时，需要创建一个备份任务（Job），它会将全量 NebulaGraph 数据备份到指定的存储位置。 + +全量备份任务（Job）的 YAML 示例如下： + +```yaml +apiVersion: batch/v1 +kind: Job +metadata: + name: nebula-full-backup +spec: + parallelism: 1 + ttlSecondsAfterFinished: 60 + template: + spec: + restartPolicy: OnFailure + containers: + - image: vesoft/br-ent:v{{br_ent.release}} + imagePullPolicy: Always + name: backup + command: + - /bin/sh + - -ecx + - exec /usr/local/bin/nebula-br backup full + - --meta $META_ADDRESS:9559 + - --storage s3://$BUCKET + - --s3.access_key $ACCESS_KEY + - --s3.secret_key $SECRET_KEY + - --s3.region $REGION + - --s3.endpoint https://s3.$REGION.amazonaws.com +``` + +### 增量备份 + +除了`spec.template.spec.containers[0].command`指定的执行命令和 Job 名称不同外，增量备份的 YAML 文件与全量备份的 YAML 文件相同。增量备份的 YAML 示例： + +```yaml +apiVersion: batch/v1 +kind: Job +metadata: + name: nebula-incr-backup +spec: + parallelism: 1 + ttlSecondsAfterFinished: 60 + template: + spec: + restartPolicy: OnFailure + containers: + - image: vesoft/br-ent:v{{br_ent.release}} + imagePullPolicy: Always + name: backup + command: + - /bin/sh + - -ecx + - exec /usr/local/bin/nebula-br backup incr + - --meta $META_ADDRESS:9559 + - --base $BACKUP_NAME + - --storage s3://$BUCKET + - --s3.access_key $ACCESS_KEY + - --s3.secret_key $SECRET_KEY + - --s3.region $REGION + - --s3.endpoint https://s3.$REGION.amazonaws.com +``` + +### 参数说明 + +主要参数说明如下： + +| 参数 |默认值| 说明 | +| ------------- | ---- | ---- | +| `spec.parallelism` |1 |并行执行的任务数。 | +| `spec.ttlSecondsAfterFinished` | 60 | 在任务完成后，保留任务信息的时间。 | +| `spec.template.spec.containers[0].image` | `vesoft/br-ent:{{br_ent.release}}`|NebulaGraph BR 企业版工具的镜像地址。 | +| `spec.template.spec.containers[0].command`| - | 备份数据至兼容 S3 协议存储服务的命令。
有关命令中选项的描述，参见[参数说明](../backup-and-restore/nebula-br-ent/3.backup-data.md#_12)。 | + + +有关 Job 的更多设置，参见 [Kubernetes Jobs](https://kubernetes.io/docs/concepts/workloads/controllers/job/)。 + +设置完备份任务（Job）的 YAML 文件后，执行以下命令启动备份任务： + +```bash +kubectl apply -f .yaml +``` + +数据备份成功后，会在指定的存储位置生成备份文件，例如`BACKUP_2023_02_12_10_04_16`。 + +## 恢复数据 + +### 恢复说明 + +- 数据恢复执行成功后，会创建一个新的集群，老的集群不会被删除，用户可自行决定是否删除老的集群。 +- 数据恢复会有一段时间的服务不可用，建议在业务低峰期进行操作。 + + + +### 恢复过程 + +当恢复备份在兼容 S3 协议服务上的数据时，需要创建一个 Secret，用于存储访问兼容 S3 协议的服务的凭证。然后创建一个恢复数据的资源对象（NebulaRestore），它会告诉 Operator 基于此资源对象定义的信息创建一个新的 NebulaGraph 集群，将备份数据恢复到新创建的集群中。 + +基于备份文件`BACKUP_2023_02_12_10_04_16`恢复数据的 YAML 示例： + +```yaml +apiVersion: v1 +kind: Secret +metadata: + name: aws-s3-secret +type: Opaque +data: + access-key: QVNJQVE0WFlxxx + secret-key: ZFJ6OEdNcDdxenMwVGxxx +--- +apiVersion: apps.nebula-graph.io/v1alpha1 +kind: NebulaRestore +metadata: + name: restore1 +spec: + br: + clusterName: nebula + backupName: "BACKUP_2023_02_12_10_04_16" + concurrency: 5 + s3: + region: "us-west-2" + bucket: "nebula-br-test" + endpoint: "https://s3.us-west-2.amazonaws.com" + secretName: "aws-s3-secret" +``` + +### 参数说明 + +- Secret + + |参数|默认值|说明| + |:---|:---|:---| + |`metadata.name`|-|Secret 的名称。| + |`type`|`Opaque`|Secret 的类型。参见[Types of Secret](https://kubernetes.io/docs/concepts/configuration/secret/#secret-types)。| + |`data.access-key`|-|访问兼容 S3 协议的存储服务的 AccessKey。| + |`data.secret-key`|-|访问兼容 S3 协议的存储服务的 SecretKey。| + +- NebulaRestore + + |参数|默认值|说明| + |:---|:---|:---| + |`metadata.name`|-|资源对象 NebulaRestore 的名称。| + |`spec.br.clusterName`|-|备份集群的名称。| + |`spec.br.backupName`|-|备份文件的名称。基于这个备份文件恢复数据。| + |`spec.br.concurrency`|`5`|用来控制数据恢复时下载文件的并发数量。默认值`5`。| + |`spec.br.s3.region`|-| S3 存储桶所在的地理区域。| + |`spec.br.s3.bucket`|-|存储备份数据的 S3 存储桶路径。| + |`spec.br.s3.endpoint`|-|S3 存储桶的访问地址。| + |`spec.br.s3.secretName`|-|用于访问 S3 存储桶的凭证的 Secret 的名称。| + +设置完恢复数据的 YAML 文件后，执行以下命令启动恢复数据的任务： + +```bash +kubectl apply -f .yaml +``` + +执行以下命令查看 NebulaRestore 对象的状态。 + +```bash +kubectl get rt -w +``` + + diff --git a/mkdocs.yml b/mkdocs.yml index 85fec3f09de..49fa068b492 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -91,10 +91,13 @@ plugins: # - graph-computing/use-explorer.md # - nebula-exchange/use-exchange/ex-ug-export-from-nebula.md # - nebula-operator/8.custom-cluster-configurations/8.3.balance-data-when-scaling-storage.md +# - nebula-operator/10.backup-restore-using-operator.md # - synchronization-and-migration/replication-between-clusters.md # - 20.appendix/8.about-license/ # - nebula-dashboard-ent/4.cluster-operator/operator/scale.md -# - 6.monitor-and-metrics/3.bbox +# - 6.monitor-and-metrics/3.bbox/ +# - backup-and-restore/nebula-br-ent/ +# # ent.end # comm.begin # comm.end @@ -504,6 +507,7 @@ nav: - 安装 BR: backup-and-restore/nebula-br/2.compile-br.md - 使用 BR 备份数据: backup-and-restore/nebula-br/3.br-backup-data.md - 使用 BR 恢复数据: backup-and-restore/nebula-br/4.br-restore-data.md +#ent - NebulaGraph BR（企业版）: - BR（企业版）概述: backup-and-restore/nebula-br-ent/1.br-ent-overview.md - 安装 BR: backup-and-restore/nebula-br-ent/2.install-tools.md @@ -701,22 +705,24 @@ nav: - 导出 NebulaGraph 数据: nebula-exchange/use-exchange/ex-ug-export-from-nebula.md - Exchange 常见问题: nebula-exchange/ex-ug-FAQ.md -# - NebulaGraph Operator: -# - 什么是 NebulaGraph Operator: nebula-operator/1.introduction-to-nebula-operator.md -# - 使用流程: nebula-operator/6.get-started-with-operator.md -# - 部署 NebulaGraph Operator: nebula-operator/2.deploy-nebula-operator.md -# - 部署 NebulaGraph集群: -# - 使用 Kubectl 部署 NebulaGraph 集群: nebula-operator/3.deploy-nebula-graph-cluster/3.1create-cluster-with-kubectl.md -# - 使用 Helm 部署 NebulaGraph 集群: nebula-operator/3.deploy-nebula-graph-cluster/3.2create-cluster-with-helm.md -# - 配置 NebulaGraph 集群: -# - 自定义 NebulaGraph 集群的配置参数: nebula-operator/8.custom-cluster-configurations/8.1.custom-conf-parameter.md -# - 回收 PV: nebula-operator/8.custom-cluster-configurations/8.2.pv-reclaim.md -# #ent -# - 均衡扩容后的 Storage 数据: nebula-operator/8.custom-cluster-configurations/8.3.balance-data-when-scaling-storage.md -# - 升级 NebulaGraph 集群: nebula-operator/9.upgrade-nebula-cluster.md -# - 连接 NebulaGraph 数据库: nebula-operator/4.connect-to-nebula-graph-service.md -# - 故障自愈: nebula-operator/5.operator-failover.md -# - 常见问题: nebula-operator/7.operator-faq.md + - NebulaGraph Operator: + - 什么是 NebulaGraph Operator: nebula-operator/1.introduction-to-nebula-operator.md + - 使用流程: nebula-operator/6.get-started-with-operator.md + - 部署 NebulaGraph Operator: nebula-operator/2.deploy-nebula-operator.md + - 部署 NebulaGraph: + - 使用 Kubectl 部署 NebulaGraph 集群: nebula-operator/3.deploy-nebula-graph-cluster/3.1create-cluster-with-kubectl.md + - 使用 Helm 部署 NebulaGraph 集群: nebula-operator/3.deploy-nebula-graph-cluster/3.2create-cluster-with-helm.md + - 配置 NebulaGraph: + - 自定义 NebulaGraph 集群的配置参数: nebula-operator/8.custom-cluster-configurations/8.1.custom-conf-parameter.md + - 回收 PV: nebula-operator/8.custom-cluster-configurations/8.2.pv-reclaim.md +#ent + - 均衡扩容后的 Storage 数据: nebula-operator/8.custom-cluster-configurations/8.3.balance-data-when-scaling-storage.md + - 升级 NebulaGraph: nebula-operator/9.upgrade-nebula-cluster.md + - 连接 NebulaGraph: nebula-operator/4.connect-to-nebula-graph-service.md +#ent + - 备份与恢复: nebula-operator/10.backup-restore-using-operator.md + - 故障自愈: nebula-operator/5.operator-failover.md + - 常见问题: nebula-operator/7.operator-faq.md - 图计算: From e8f2d7c0fbb9243c3df48d8156e016165eabaf3e Mon Sep 17 00:00:00 2001 From: Abby <78209557+abby-cyber@users.noreply.github.com> Date: Wed, 15 Feb 2023 09:57:24 +0800 Subject: [PATCH 031/137] Update 10.backup-restore-using-operator.md --- .../10.backup-restore-using-operator.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/docs-2.0/nebula-operator/10.backup-restore-using-operator.md b/docs-2.0/nebula-operator/10.backup-restore-using-operator.md index f6eb46845f1..e4eb97697f9 100644 --- a/docs-2.0/nebula-operator/10.backup-restore-using-operator.md +++ b/docs-2.0/nebula-operator/10.backup-restore-using-operator.md @@ -21,7 +21,19 @@ - Nebula Operator 版本 >= 1.4.0。 - Kubernetes 上部署的企业版 NebulaGraph 集群正在运行。 -- 在创建集群的 YAML 中，设置了`spec.enableBR`为`true`。详细信息参见[]()。 +- 在创建集群的 YAML 中，设置了`spec.enableBR`为`true`。 + + ``` + // 集群 YAML 文件示例部分内容。 + apiVersion: apps.nebula-graph.io/v1alpha1 + kind: NebulaCluster + metadata: + name: nebula + spec: + enableBR: true // 设置为 true 时，启用备份和恢复功能。 + ... + ``` + - 只支持使用 S3 协议的存储服务（例如 AWS S3，Minio 等）备份和恢复数据。 - 集群中有足够的计算资源以恢复数据。 From 0c765b3d20bc1982389cffa6ac2d71fa2ba42a65 Mon Sep 17 00:00:00 2001 From: "abby.huang" <78209557+abby-cyber@users.noreply.github.com> Date: Wed, 15 Feb 2023 09:58:17 +0800 Subject: [PATCH 032/137] Update 10.backup-restore-using-operator.md (#2589) --- .../10.backup-restore-using-operator.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/docs-2.0/nebula-operator/10.backup-restore-using-operator.md b/docs-2.0/nebula-operator/10.backup-restore-using-operator.md index f6eb46845f1..e4eb97697f9 100644 --- a/docs-2.0/nebula-operator/10.backup-restore-using-operator.md +++ b/docs-2.0/nebula-operator/10.backup-restore-using-operator.md @@ -21,7 +21,19 @@ - Nebula Operator 版本 >= 1.4.0。 - Kubernetes 上部署的企业版 NebulaGraph 集群正在运行。 -- 在创建集群的 YAML 中，设置了`spec.enableBR`为`true`。详细信息参见[]()。 +- 在创建集群的 YAML 中，设置了`spec.enableBR`为`true`。 + + ``` + // 集群 YAML 文件示例部分内容。 + apiVersion: apps.nebula-graph.io/v1alpha1 + kind: NebulaCluster + metadata: + name: nebula + spec: + enableBR: true // 设置为 true 时，启用备份和恢复功能。 + ... + ``` + - 只支持使用 S3 协议的存储服务（例如 AWS S3，Minio 等）备份和恢复数据。 - 集群中有足够的计算资源以恢复数据。 From 62c4a9afad58cf54e584b1be36e7d209b5173d5a Mon Sep 17 00:00:00 2001 From: cooper-lzy <78672629+cooper-lzy@users.noreply.github.com> Date: Wed, 15 Feb 2023 10:07:36 +0800 Subject: [PATCH 033/137] exchange update export (#2588) * exchange update export * update * update --- .../about-exchange/ex-ug-what-is-exchange.md | 2 +- .../use-exchange/ex-ug-export-from-nebula.md | 251 ++++++++++++++---- 2 files changed, 206 insertions(+), 47 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 3765c2c08b4..5da48d40333 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 @@ -116,7 +116,7 @@ Exchange {{exchange.release}} 支持将以下格式或来源的数据转换为 N {{ ent.ent_begin }} -此外，企业版 Exchange 支持以 NebulaGraph 为源，将数据[导出到 CSV 文件](../use-exchange/ex-ug-export-from-nebula.md)。 +此外，企业版 Exchange 支持以 NebulaGraph 为源，将数据[导出到 CSV 文件或另一个图空间](../use-exchange/ex-ug-export-from-nebula.md)。 {{ ent.ent_end }} diff --git a/docs-2.0/nebula-exchange/use-exchange/ex-ug-export-from-nebula.md b/docs-2.0/nebula-exchange/use-exchange/ex-ug-export-from-nebula.md index 7c7ef51f6df..9240f1ddc91 100644 --- a/docs-2.0/nebula-exchange/use-exchange/ex-ug-export-from-nebula.md +++ b/docs-2.0/nebula-exchange/use-exchange/ex-ug-export-from-nebula.md @@ -1,10 +1,10 @@ # 导出 NebulaGraph 数据 -本文以一个示例说明如何使用 Exchange 将 NebulaGraph 中的数据导出到 CSV 文件中。 +Exchange 支持将 NebulaGraph 中的数据导出到 CSV 文件或另一个图空间（不同 NebulaGraph 集群也支持）中。本文介绍具体的操作步骤。 !!! enterpriseonly - 仅企业版 Exchange 支持导出 NebulaGraph 数据，且仅能导出到 CSV 文件。 + 仅企业版 Exchange 支持导出 NebulaGraph 数据。 ## 环境准备 @@ -49,81 +49,238 @@ CentOS 7.9.2009 2. 修改配置文件。 - 企业版 Exchange 提供了导出 NebulaGraph 数据专用的配置文件模板`export_application.conf`，其中各配置项的说明参见 [Exchange 配置](../parameter-reference/ex-ug-parameter.md)。本示例使用的配置文件核心内容如下： + 企业版 Exchange 提供了导出 NebulaGraph 数据专用的配置文件模板`export_to_csv.conf`和`export_to_nebula.conf`，其中各配置项的说明参见 [Exchange 配置](../parameter-reference/ex-ug-parameter.md)。本示例使用的配置文件核心内容如下： + - 导出到 CSV 文件： + ```conf - ... + # Use the command to submit the exchange job: + + # spark-submit \ + # --master "spark://master_ip:7077" \ + # --driver-memory=2G --executor-memory=30G \ + # --num-executors=3 --executor-cores=20 \ + # --class com.vesoft.nebula.exchange.Exchange \ + # nebula-exchange-3.0-SNAPSHOT.jar -c export_to_csv.conf + + { + # Spark config + spark: { + app: { + name: NebulaGraph Exchange + } + } + + # Nebula Graph config + # if you export nebula data to csv, please ignore these nebula config + nebula: { + address:{ + graph:["127.0.0.1:9669"] + + # the address of any of the meta services + meta:["127.0.0.1:9559"] + } + user: root + pswd: nebula + space: test + + # nebula client connection parameters + connection { + # socket connect & execute timeout, unit: millisecond + timeout: 30000 + } + + error: { + # max number of failures, if the number of failures is bigger than max, then exit the application. + max: 32 + # failed data will be recorded in output path, format with ngql + output: /tmp/errors + } + + # use google's RateLimiter to limit the requests send to NebulaGraph + rate: { + # the stable throughput of RateLimiter + limit: 1024 + # Acquires a permit from RateLimiter, unit: MILLISECONDS + # if it can't be obtained within the specified timeout, then give up the request. + timeout: 1000 + } + } # Processing tags - # There are tag config examples for different dataSources. tags: [ - # export NebulaGraph tag data to csv, only support export to CSV for now. { - name: player + # you can ignore the tag name when export nebula data to csv + name: tag-name-1 type: { - source: Nebula - sink: CSV + source: nebula + sink: csv } - # the path to save the NebulaGrpah data, make sure the path doesn't exist. - path:"hdfs://192.168.8.177:9000/vertex/player" - # if no need to export any properties when export NebulaGraph tag data - # if noField is configured true, just export vertexId - noField:false - # define properties to export from NebulaGraph tag data - # if return.fields is configured as empty list, then export all properties - return.fields:[] - # NebulaGraph space partition number - partition:10 - } - - ... + # config the fields you want to export from nebula + fields: [nebula-field-0, nebula-field-1, nebula-field-2] + noFields:false # default false, if true, just export id + partition: 60 + # config the path to save your csv file. if your file in not in hdfs, config "file:///path/ test.csv" + path: "hdfs://ip:port/path/person" + separator: "," + header: true + } ] - # Processing edges - # There are edge config examples for different dataSources. + # process edges edges: [ - # export NebulaGraph tag data to csv, only support export to CSV for now. { - name: follow + # you can ignore the edge name when export nebula data to csv + name: edge-name-1 type: { - source: Nebula - sink: CSV + source: nebula + sink: csv } - # the path to save the NebulaGrpah data, make sure the path doesn't exist. - path:"hdfs://192.168.8.177:9000/edge/follow" - # if no need to export any properties when export NebulaGraph edge data - # if noField is configured true, just export src,dst,rank - noField:false - # define properties to export from NebulaGraph edge data - # if return.fields is configured as empty list, then export all properties - return.fields:[] - # NebulaGraph space partition number - partition:10 + # config the fields you want to export from nebula + fields: [nebula-field-0, nebula-field-1, nebula-field-2] + noFields:false # default false, if true, just export id + partition: 60 + # config the path to save your csv file. if your file in not in hdfs, config "file:///path/ test.csv" + path: "hdfs://ip:port/path/friend" + separator: "," + header: true + } + ] + } + ``` + + - 导出到另一个图空间： + + ```conf + # Use the command to submit the exchange job: + + # spark-submit \ + # --master "spark://master_ip:7077" \ + # --driver-memory=2G --executor-memory=30G \ + # --num-executors=3 --executor-cores=20 \ + # --class com.vesoft.nebula.exchange.Exchange \ + # nebula-exchange-3.0-SNAPSHOT.jar -c export_to_nebula.conf + + { + # Spark config + spark: { + app: { + name: NebulaGraph Exchange } + } - ... + # Nebula Graph config, just config the sink nebula information + nebula: { + address:{ + graph:["127.0.0.1:9669"] + + # the address of any of the meta services + meta:["127.0.0.1:9559"] + } + user: root + pswd: nebula + space: test + + # nebula client connection parameters + connection { + # socket connect & execute timeout, unit: millisecond + timeout: 30000 + } + error: { + # max number of failures, if the number of failures is bigger than max, then exit the application. + max: 32 + # failed data will be recorded in output path, format with ngql + output: /tmp/errors + } + + # use google's RateLimiter to limit the requests send to NebulaGraph + rate: { + # the stable throughput of RateLimiter + limit: 1024 + # Acquires a permit from RateLimiter, unit: MILLISECONDS + # if it can't be obtained within the specified timeout, then give up the request. + timeout: 1000 + } + } + + # Processing tags + tags: [ + { + name: tag-name-1 + type: { + source: nebula + sink: client + } + # data source nebula config + metaAddress:"127.0.0.1:9559" + space:"test" + label:"person" + # mapping the fields of the original NebulaGraph to the fields of the target NebulaGraph. + fields: [source_nebula-field-0, source_nebula-field-1, source_nebula-field-2] + nebula.fields: [target_nebula-field-0, target_nebula-field-1, target_nebula-field-2] + limit:10000 + vertex: _vertexId # must be `_vertexId` + batch: 2000 + partition: 60 + } + ] + + # process edges + edges: [ + { + name: edge-name-1 + type: { + source: csv + sink: client + } + # data source nebula config + metaAddress:"127.0.0.1:9559" + space:"test" + label:"friend" + fields: [source_nebula-field-0, source_nebula-field-1, source_nebula-field-2] + nebula.fields: [target_nebula-field-0, target_nebula-field-1, target_nebula-field-2] + limit:1000 + source: _srcId # must be `_srcId` + target: _dstId # must be `_dstId` + ranking: source_nebula-field-2 + batch: 2000 + partition: 60 + } ] } ``` -3. 使用如下命令导出 NebulaGraph 中的数据。 +1. 使用如下命令导出 NebulaGraph 中的数据。 + !!! note + + Driver 和 Executor 进程的相关参数可以根据自身配置灵活修改。 + ```bash - /bin/spark-submit --master "local" --class com.vesoft.nebula.exchange.Exchange nebula-exchange-x.y.z.jar_path> -c + /bin/spark-submit --master "spark://:7077" \ + --driver-memory=2G --executor-memory=30G \ + --total-executor-cores=60 --executor-cores=20 \ + --class com.vesoft.nebula.exchange.Exchange nebula-exchange-x.y.z.jar_path> \ + -c ``` - 本示例使用的导出命令如下。 + 例如导出到 CSV 文件的示例命令如下。 ```bash - $ ./spark-submit --master "local" --class com.vesoft.nebula.exchange.Exchange \ - ~/exchange-ent/nebula-exchange-ent-{{exchange.release}}.jar -c ~/exchange-ent/export_application.conf + $ ./spark-submit --master "spark://192.168.10.100:7077" \ + --driver-memory=2G --executor-memory=30G \ + --total-executor-cores=60 --executor-cores=20 \ + --class com.vesoft.nebula.exchange.Exchange ~/exchange-ent/nebula-exchange-ent-{{exchange.release}}.jar \ + -c ~/exchange-ent/export_to_csv.conf ``` 4. 检查导出的数据。 - 1. 查看目标路径下是否成功生成了 CSV 文件。 + - 导出到 CSV 文件： + + 查看目标路径下是否成功生成了 CSV 文件，并检查文件内容。 ```bash $ hadoop fs -ls /vertex/player @@ -141,4 +298,6 @@ CentOS 7.9.2009 -rw-r--r-- 3 nebula supergroup 119 2021-11-05 07:36 /vertex/player/ part-00009-17293020-ba2e-4243-b834-34495c0536b3-c000.csv ``` - 2. 检查 CSV 文件内容，确定数据导出成功。 + - 导出到另一个图空间： + + 登录新的图空间，通过`SUBMIT JOB STATS`和`SHOW STATS`命令查看统计信息，确认是否导出成功。 From 982ada043af23dde3f1ba08744d84bd053a6ea81 Mon Sep 17 00:00:00 2001 From: cooper-lzy <78672629+cooper-lzy@users.noreply.github.com> Date: Wed, 15 Feb 2023 10:19:18 +0800 Subject: [PATCH 034/137] Update ex-ug-export-from-nebula.md --- .../nebula-exchange/use-exchange/ex-ug-export-from-nebula.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs-2.0/nebula-exchange/use-exchange/ex-ug-export-from-nebula.md b/docs-2.0/nebula-exchange/use-exchange/ex-ug-export-from-nebula.md index 9240f1ddc91..fbab8c6c1f9 100644 --- a/docs-2.0/nebula-exchange/use-exchange/ex-ug-export-from-nebula.md +++ b/docs-2.0/nebula-exchange/use-exchange/ex-ug-export-from-nebula.md @@ -252,7 +252,7 @@ CentOS 7.9.2009 } ``` -1. 使用如下命令导出 NebulaGraph 中的数据。 +3. 使用如下命令导出 NebulaGraph 中的数据。 !!! note From e62b2649526eed81c82a4505a92fe1690a7cd649 Mon Sep 17 00:00:00 2001 From: cooper-lzy <78672629+cooper-lzy@users.noreply.github.com> Date: Wed, 15 Feb 2023 10:20:04 +0800 Subject: [PATCH 035/137] Update ex-ug-export-from-nebula.md --- .../nebula-exchange/use-exchange/ex-ug-export-from-nebula.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs-2.0/nebula-exchange/use-exchange/ex-ug-export-from-nebula.md b/docs-2.0/nebula-exchange/use-exchange/ex-ug-export-from-nebula.md index fbab8c6c1f9..6953492cd32 100644 --- a/docs-2.0/nebula-exchange/use-exchange/ex-ug-export-from-nebula.md +++ b/docs-2.0/nebula-exchange/use-exchange/ex-ug-export-from-nebula.md @@ -59,7 +59,7 @@ CentOS 7.9.2009 # spark-submit \ # --master "spark://master_ip:7077" \ # --driver-memory=2G --executor-memory=30G \ - # --num-executors=3 --executor-cores=20 \ + # --total-executor-cores=60 --executor-cores=20 \ # --class com.vesoft.nebula.exchange.Exchange \ # nebula-exchange-3.0-SNAPSHOT.jar -c export_to_csv.conf @@ -158,7 +158,7 @@ CentOS 7.9.2009 # spark-submit \ # --master "spark://master_ip:7077" \ # --driver-memory=2G --executor-memory=30G \ - # --num-executors=3 --executor-cores=20 \ + # --total-executor-cores=60 --executor-cores=20 \ # --class com.vesoft.nebula.exchange.Exchange \ # nebula-exchange-3.0-SNAPSHOT.jar -c export_to_nebula.conf From 4786f3f5c10a0159336b14053165e92406f7b9bc Mon Sep 17 00:00:00 2001 From: cooper-lzy <78672629+cooper-lzy@users.noreply.github.com> Date: Wed, 15 Feb 2023 10:46:29 +0800 Subject: [PATCH 036/137] add comment for exchange (#2590) --- .../use-exchange/ex-ug-export-from-nebula.md | 6 ++++-- .../use-exchange/ex-ug-import-from-clickhouse.md | 3 +++ .../nebula-exchange/use-exchange/ex-ug-import-from-csv.md | 2 ++ .../nebula-exchange/use-exchange/ex-ug-import-from-hbase.md | 2 ++ .../nebula-exchange/use-exchange/ex-ug-import-from-hive.md | 2 ++ .../nebula-exchange/use-exchange/ex-ug-import-from-jdbc.md | 2 ++ .../nebula-exchange/use-exchange/ex-ug-import-from-json.md | 2 ++ .../nebula-exchange/use-exchange/ex-ug-import-from-kafka.md | 2 ++ .../use-exchange/ex-ug-import-from-maxcompute.md | 2 ++ .../nebula-exchange/use-exchange/ex-ug-import-from-mysql.md | 2 ++ .../nebula-exchange/use-exchange/ex-ug-import-from-neo4j.md | 2 ++ .../use-exchange/ex-ug-import-from-oracle.md | 2 ++ .../nebula-exchange/use-exchange/ex-ug-import-from-orc.md | 2 ++ .../use-exchange/ex-ug-import-from-parquet.md | 2 ++ .../use-exchange/ex-ug-import-from-pulsar.md | 2 ++ .../nebula-exchange/use-exchange/ex-ug-import-from-sst.md | 2 ++ 16 files changed, 35 insertions(+), 2 deletions(-) diff --git a/docs-2.0/nebula-exchange/use-exchange/ex-ug-export-from-nebula.md b/docs-2.0/nebula-exchange/use-exchange/ex-ug-export-from-nebula.md index 6953492cd32..8c0e220e0b1 100644 --- a/docs-2.0/nebula-exchange/use-exchange/ex-ug-export-from-nebula.md +++ b/docs-2.0/nebula-exchange/use-exchange/ex-ug-export-from-nebula.md @@ -77,7 +77,8 @@ CentOS 7.9.2009 address:{ graph:["127.0.0.1:9669"] - # the address of any of the meta services + # the address of any of the meta services. + # if your NebulaGraph server is in virtual network like k8s, please config the leader address of meta. meta:["127.0.0.1:9559"] } user: root @@ -175,7 +176,8 @@ CentOS 7.9.2009 address:{ graph:["127.0.0.1:9669"] - # the address of any of the meta services + # the address of any of the meta services. + # if your NebulaGraph server is in virtual network like k8s, please config the leader address of meta. meta:["127.0.0.1:9559"] } user: root diff --git a/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-clickhouse.md b/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-clickhouse.md index c2065ddbfa0..6e11f9f0dae 100644 --- a/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-clickhouse.md +++ b/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-clickhouse.md @@ -109,6 +109,9 @@ # 如果有多个地址，格式为 "ip1:port","ip2:port","ip3:port"。 # 不同地址之间以英文逗号 (,) 隔开。 graph:["127.0.0.1:9669"] + + #任意一个 Meta 服务的地址。 + #如果您的 NebulaGraph 在虚拟网络中，如k8s，请配置 Leader Meta的地址。 meta:["127.0.0.1:9559"] } # 填写的账号必须拥有 NebulaGraph 相应图空间的写数据权限。 diff --git a/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-csv.md b/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-csv.md index b1476d46534..2127423a12d 100644 --- a/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-csv.md +++ b/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-csv.md @@ -127,6 +127,8 @@ # 如果有多台服务器，地址之间用英文逗号（,）分隔。 # 格式："ip1:port","ip2:port","ip3:port" graph:["127.0.0.1:9669"] + #任意一个 Meta 服务的地址。 + #如果您的 NebulaGraph 在虚拟网络中，如k8s，请配置 Leader Meta的地址。 meta:["127.0.0.1:9559"] } diff --git a/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-hbase.md b/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-hbase.md index 46ae75487b1..a98d04152df 100644 --- a/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-hbase.md +++ b/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-hbase.md @@ -146,6 +146,8 @@ ROW COLUMN+CELL # 如果有多个地址，格式为 "ip1:port","ip2:port","ip3:port"。 # 不同地址之间以英文逗号 (,) 隔开。 graph:["127.0.0.1:9669"] + #任意一个 Meta 服务的地址。 + #如果您的 NebulaGraph 在虚拟网络中，如k8s，请配置 Leader Meta的地址。 meta:["127.0.0.1:9559"] } # 填写的账号必须拥有 NebulaGraph 相应图空间的写数据权限。 diff --git a/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-hive.md b/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-hive.md index 57ef8eb6d1c..56bd7dad855 100644 --- a/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-hive.md +++ b/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-hive.md @@ -186,6 +186,8 @@ scala> sql("select playerid, teamid, start_year, end_year from basketball.serve" # 如果有多个地址，格式为 "ip1:port","ip2:port","ip3:port"。 # 不同地址之间以英文逗号 (,) 隔开。 graph:["127.0.0.1:9669"] + #任意一个 Meta 服务的地址。 + #如果您的 NebulaGraph 在虚拟网络中，如k8s，请配置 Leader Meta的地址。 meta:["127.0.0.1:9559"] } # 填写的账号必须拥有 NebulaGraph 相应图空间的写数据权限。 diff --git a/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-jdbc.md b/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-jdbc.md index 0187f70d113..6aa87aa2858 100644 --- a/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-jdbc.md +++ b/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-jdbc.md @@ -153,6 +153,8 @@ mysql> desc serve; # 如果有多台服务器，地址之间用英文逗号（,）分隔。 # 格式："ip1:port","ip2:port","ip3:port" graph:["127.0.0.1:9669"] + #任意一个 Meta 服务的地址。 + #如果您的 NebulaGraph 在虚拟网络中，如k8s，请配置 Leader Meta的地址。 meta:["127.0.0.1:9559"] } diff --git a/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-json.md b/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-json.md index 40dce62282f..0057d0b91f4 100644 --- a/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-json.md +++ b/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-json.md @@ -155,6 +155,8 @@ # 如果有多台服务器，地址之间用英文逗号（,）分隔。 # 格式："ip1:port","ip2:port","ip3:port" graph:["127.0.0.1:9669"] + #任意一个 Meta 服务的地址。 + #如果您的 NebulaGraph 在虚拟网络中，如k8s，请配置 Leader Meta的地址。 meta:["127.0.0.1:9559"] } diff --git a/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-kafka.md b/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-kafka.md index f44726f1be1..cae551a0634 100644 --- a/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-kafka.md +++ b/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-kafka.md @@ -101,6 +101,8 @@ # 如果有多个地址，格式为 "ip1:port","ip2:port","ip3:port"。 # 不同地址之间以英文逗号 (,) 隔开。 graph:["127.0.0.1:9669"] + #任意一个 Meta 服务的地址。 + #如果您的 NebulaGraph 在虚拟网络中，如k8s，请配置 Leader Meta的地址。 meta:["127.0.0.1:9559"] } # 填写的账号必须拥有 NebulaGraph 相应图空间的写数据权限。 diff --git a/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-maxcompute.md b/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-maxcompute.md index 80f41c30026..48debdfc6d4 100644 --- a/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-maxcompute.md +++ b/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-maxcompute.md @@ -109,6 +109,8 @@ # 如果有多个地址，格式为 "ip1:port","ip2:port","ip3:port"。 # 不同地址之间以英文逗号 (,) 隔开。 graph:["127.0.0.1:9669"] + #任意一个 Meta 服务的地址。 + #如果您的 NebulaGraph 在虚拟网络中，如k8s，请配置 Leader Meta的地址。 meta:["127.0.0.1:9559"] } # 填写的账号必须拥有 NebulaGraph 相应图空间的写数据权限。 diff --git a/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-mysql.md b/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-mysql.md index a191cd9c8e3..41f660e637d 100644 --- a/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-mysql.md +++ b/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-mysql.md @@ -149,6 +149,8 @@ mysql> desc serve; # 如果有多个地址，格式为 "ip1:port","ip2:port","ip3:port"。 # 不同地址之间以英文逗号 (,) 隔开。 graph:["127.0.0.1:9669"] + #任意一个 Meta 服务的地址。 + #如果您的 NebulaGraph 在虚拟网络中，如k8s，请配置 Leader Meta的地址。 meta:["127.0.0.1:9559"] } # 填写的账号必须拥有 NebulaGraph 相应图空间的写数据权限。 diff --git a/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-neo4j.md b/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-neo4j.md index 6c72c863d44..9d8d93deff1 100644 --- a/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-neo4j.md +++ b/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-neo4j.md @@ -135,6 +135,8 @@ Exchange 读取 Neo4j 数据时需要完成以下工作： nebula: { address:{ graph:["127.0.0.1:9669"] + #任意一个 Meta 服务的地址。 + #如果您的 NebulaGraph 在虚拟网络中，如k8s，请配置 Leader Meta的地址。 meta:["127.0.0.1:9559"] } user: root diff --git a/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-oracle.md b/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-oracle.md index 6a83fd056e2..fa4a60e0847 100644 --- a/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-oracle.md +++ b/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-oracle.md @@ -151,6 +151,8 @@ oracle> desc serve; # 如果有多个地址，格式为 "ip1:port","ip2:port","ip3:port"。 # 不同地址之间以英文逗号 (,) 隔开。 graph:["127.0.0.1:9669"] + #任意一个 Meta 服务的地址。 + #如果您的 NebulaGraph 在虚拟网络中，如k8s，请配置 Leader Meta的地址。 meta:["127.0.0.1:9559"] } # 填写的账号必须拥有 NebulaGraph 相应图空间的写数据权限。 diff --git a/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-orc.md b/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-orc.md index 0af63712c32..b172c5e94df 100644 --- a/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-orc.md +++ b/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-orc.md @@ -123,6 +123,8 @@ # 如果有多台服务器，地址之间用英文逗号（,）分隔。 # 格式："ip1:port","ip2:port","ip3:port" graph:["127.0.0.1:9669"] + #任意一个 Meta 服务的地址。 + #如果您的 NebulaGraph 在虚拟网络中，如k8s，请配置 Leader Meta的地址。 meta:["127.0.0.1:9559"] } diff --git a/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-parquet.md b/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-parquet.md index b3c5929391e..b5520c91715 100644 --- a/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-parquet.md +++ b/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-parquet.md @@ -123,6 +123,8 @@ # 如果有多台服务器，地址之间用英文逗号（,）分隔。 # 格式："ip1:port","ip2:port","ip3:port" graph:["127.0.0.1:9669"] + #任意一个 Meta 服务的地址。 + #如果您的 NebulaGraph 在虚拟网络中，如k8s，请配置 Leader Meta的地址。 meta:["127.0.0.1:9559"] } diff --git a/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-pulsar.md b/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-pulsar.md index 2467f8d66af..316e45171ac 100644 --- a/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-pulsar.md +++ b/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-pulsar.md @@ -101,6 +101,8 @@ # 如果有多个地址，格式为 "ip1:port","ip2:port","ip3:port"。 # 不同地址之间以英文逗号 (,) 隔开。 graph:["127.0.0.1:9669"] + #任意一个 Meta 服务的地址。 + #如果您的 NebulaGraph 在虚拟网络中，如k8s，请配置 Leader Meta的地址。 meta:["127.0.0.1:9559"] } # 填写的账号必须拥有 NebulaGraph 相应图空间的写数据权限。 diff --git a/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-sst.md b/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-sst.md index 0edae34e7c0..7e034e27e41 100644 --- a/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-sst.md +++ b/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-sst.md @@ -193,6 +193,8 @@ SST 文件是一个内部包含了任意长度的有序键值对集合的文件 nebula: { address:{ graph:["127.0.0.1:9669"] + #任意一个 Meta 服务的地址。 + #如果您的 NebulaGraph 在虚拟网络中，如k8s，请配置 Leader Meta的地址。 meta:["127.0.0.1:9559"] } user: root From d8d296acf1e9887c1c096480a469978ff25ce634 Mon Sep 17 00:00:00 2001 From: "abby.huang" <78209557+abby-cyber@users.noreply.github.com> Date: Wed, 15 Feb 2023 14:19:34 +0800 Subject: [PATCH 037/137] 3.4.0-upgrade-link-fix (#2591) --- .../upgrade-nebula-from-300-to-latest.md | 2 +- docs-2.0/nebula-operator/10.backup-restore-using-operator.md | 3 +-- 2 files changed, 2 insertions(+), 3 deletions(-) diff --git a/docs-2.0/4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-from-300-to-latest.md b/docs-2.0/4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-from-300-to-latest.md index 124fcff8bf2..eb25c8be89c 100644 --- a/docs-2.0/4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-from-300-to-latest.md +++ b/docs-2.0/4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-from-300-to-latest.md @@ -10,7 +10,7 @@ NebulaGraph v3.x 升级至 v{{nebula.release}}，只需要使用 v{{nebula.relea ## RPM/DEB 包升级步骤 -1. 下载 [RPM/DEB 包](https://github.com/vesoft-inc/nebula-graph/releases/tag/v{{nebula.release}})。 +1. 下载 [RPM/DEB 包](https://www.nebula-graph.com.cn/download)。 2. 停止所有 NebulaGraph 服务。详情请参见[管理 NebulaGraph 服务](../../2.quick-start/3.quick-start-on-premise/5.start-stop-service.md)。建议更新前备份配置文件。 diff --git a/docs-2.0/nebula-operator/10.backup-restore-using-operator.md b/docs-2.0/nebula-operator/10.backup-restore-using-operator.md index e4eb97697f9..e434f27b17f 100644 --- a/docs-2.0/nebula-operator/10.backup-restore-using-operator.md +++ b/docs-2.0/nebula-operator/10.backup-restore-using-operator.md @@ -44,8 +44,7 @@ - NebulaGraph Operator 支持全量备份和增量备份。 - 数据备份过程中，指定图空间中的 DDL 和 DML 语句将会阻塞，我们建议在业务低峰期进行操作，例如凌晨 2 点至 5 点。 - 执行增量备份的集群和指定的上一次备份的集群需为同一个，并且和指定的上一次备份的（存储桶）路径需相同。 -- 确保每次增量备份距离上一次备份的时间小于一个wal_ttl的时间。 -- 确保 Agent 有对应 NebulaGraph 安装目录和备份目录的读写权限。 +- 确保每次增量备份距离上一次备份的时间小于一个`wal_ttl`的时间。 - 不支持备份指定图空间数据。 ### 全量备份 From e410832767a9d06a350afd22e395a3e7a4f03bae Mon Sep 17 00:00:00 2001 From: "abby.huang" <78209557+abby-cyber@users.noreply.github.com> Date: Wed, 15 Feb 2023 14:30:08 +0800 Subject: [PATCH 038/137] pv-reclaiming-opts (#2581) --- .../8.custom-cluster-configurations/8.2.pv-reclaim.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) 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 ea03ebe9ec0..60a1b3be2ee 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 @@ -1,10 +1,9 @@ # 回收 PV -NebulaGraph Operator 使用持久化卷 PV（Persistent Volume）和持久化卷声明 PVC（Persistent Volume Claim）来存储持久化数据。如果用户不小心删除了一个 NebulaGraph 集群，PV 和 PVC 对象及其数据仍可保留，以确保数据安全。 +NebulaGraph Operator 使用持久化卷 PV（Persistent Volume）和持久化卷声明 PVC（Persistent Volume Claim）来存储持久化数据。如果用户不小心删除了一个 NebulaGraph 集群，默认 PV 和 PVC 对象及其数据仍可保留，以确保数据安全。 -用户可以在集群的 CR 实例的配置文件中通过参数`enablePVReclaim`定义是否回收 PV。 +用户也可以在集群实例的配置文件中通过设置参数`spec.enablePVReclaim`为`true`来定义在删除集群后自动删除 PVC 以释放数据。至于在删除 PVC 后是否删除 PV，用户需要自定义 PV 的回收策略。参见 [StorageClass 中设置 reclaimPolicy](https://kubernetes.io/docs/concepts/storage/storage-classes/#reclaim-policy)和 [PV Reclaiming](https://kubernetes.io/docs/concepts/storage/persistent-volumes/#reclaiming) 了解 PV 回收策略。 -如果用户需要删除图空间并想保留相关数据，可以更新 NebulaGraph 集群，即设置`enablePVReclaim`为`true`。 ## 前提条件 @@ -102,3 +101,5 @@ NebulaGraph Operator 使用持久化卷 PV（Persistent Volume）和持久化卷 ``` 3. 执行`kubectl apply -f nebula_cluster.yaml`使上述更新生效。 + +当集群删除后，系统将会自动删除 PVC 以回收存储资源。是否删除 PV，取决于 PV 的回收策略。 From 8c1e547ae6d1f0657d2c62d8f1a5624cf58e22fb Mon Sep 17 00:00:00 2001 From: randomJoe211 <69501902+randomJoe211@users.noreply.github.com> Date: Wed, 15 Feb 2023 14:51:39 +0800 Subject: [PATCH 039/137] Update DB version of Alibaba Cloud to 3.4.0 (#2592) --- docs-2.0/nebula-cloud/1.what-is-cloud.md | 31 ++-- .../1.create-service-instance.md | 157 +++++++++++++----- .../2.use-cloud-services.md | 50 +++--- .../4.scaling-services.md | 46 +++++ .../reuse/source_create_instance_aliyun.md | 123 +++++++++----- mkdocs.yml | 56 +++---- 6 files changed, 298 insertions(+), 165 deletions(-) create mode 100644 docs-2.0/nebula-cloud/nebula-cloud-on-alibabacloud/4.scaling-services.md diff --git a/docs-2.0/nebula-cloud/1.what-is-cloud.md b/docs-2.0/nebula-cloud/1.what-is-cloud.md index 580809498a9..ff913ca8fb8 100644 --- a/docs-2.0/nebula-cloud/1.what-is-cloud.md +++ b/docs-2.0/nebula-cloud/1.what-is-cloud.md @@ -6,29 +6,17 @@ NebulaGraph Cloud（简称 Cloud）是一套集成了 NebulaGraph 数据库和 NebulaGraph Cloud 支持： - 基于 Azure 的全托管云服务，即 [NebulaGraph Cloud Azure 版](https://docs.nebula-graph.com.cn/{{cloud.azureRelease}}/nebula-cloud/1.what-is-cloud/) 。 -- 基于阿里云的自管云服务，即 [NebulaGraph Cloud 阿里云版](nebula-cloud-on-alibabacloud/1.create-service-instance.md)。 ---> - -NebulaGraph Cloud 支持基于阿里云的自管云服务，因此又名 [NebulaGraph Cloud 阿里云版](nebula-cloud-on-alibabacloud/1.create-service-instance.md)。 - -## 内核版本 - -Cloud 支持的最新 NebulaGraph 内核版本为 {{cloud.aliyunRelease}}。 - - + ## 产品功能 - 即买即用。用户可以根据自己的业务发展随时创建或停止 NebulaGraph 实例，业务提供充分的灵活性。 -- 集成可视化图数据库管理工具 Nebula Dashboard、Nebula Explorer。可以使用它们导入图数据集、执行 nGQL 语句查询、探索图数据、监控数据等。即使没有图数据库操作经验，也可以快速成为图专家。详情参见 [配套的应用](../nebula-cloud/5.solution/5.1.supporting-application.md)。 -- 创建私有链接。用户可直接使用 Nebula Console 连接到云上数据库，而不需要先访问云平台。详情参见 [Private Link](../nebula-cloud/5.solution/5.2.connection-configuration-and-use.md)。 +- 集成可视化图数据库管理工具 Nebula Dashboard、Nebula Explorer。可以使用它们导入图数据集、执行 nGQL 语句查询、探索图数据、监控数据等。即使没有图数据库操作经验，也可以快速成为图专家。 +- 用户可直接使用 Nebula Console 等客户端连接到云上数据库，而不需要先访问云平台。 - 权限控制。用户可以为指定图空间增加不同角色权限的数据库用户，保证业务数据安全。 - 官方支持。用户可以快速创建工单，咨询使用过程中遇到的问题。 @@ -38,7 +26,10 @@ Cloud 支持的最新 NebulaGraph 内核版本如下： - 高可用性：Cloud 上创建的 NebulaGraph 集群采用 Raft 协议，结合云厂商提供的同城多机房实现数据冗余备份，保证云计算基础框架的高可用性、数据的可靠性以及云服务器的高可用性。 - 操作易用：Cloud 提供 Web 页面对 NebulaGraph 集群进行在线管理，同时提供配套的可视化软件，降低用户使用门槛，快速上手。 -### 视频 +## 视频 + +用户也可以观看视频了解 NebulaGraph Cloud。 + +[NebulaGraph Cloud 阿里云版介绍](https://www.bilibili.com/video/BV1BY411K7QJ)（05 分 37 秒） -* [NebulaGraph Cloud 阿里云版介绍](https://www.bilibili.com/video/BV1BY411K7QJ)（5 分 38 秒） diff --git a/docs-2.0/nebula-cloud/nebula-cloud-on-alibabacloud/1.create-service-instance.md b/docs-2.0/nebula-cloud/nebula-cloud-on-alibabacloud/1.create-service-instance.md index 8fb9cf88b14..55ac76dd57f 100644 --- a/docs-2.0/nebula-cloud/nebula-cloud-on-alibabacloud/1.create-service-instance.md +++ b/docs-2.0/nebula-cloud/nebula-cloud-on-alibabacloud/1.create-service-instance.md @@ -2,14 +2,9 @@ 在使用 NebulaGraph Cloud 阿里云版服务前，要先在阿里云控制台创建服务实例。 -!!! caution - - 通过 NebulaGraph Cloud 阿里云版创建的 NebulaGraph、NebulaGraph Dashboard 和 NebulaGraph Explorer 服务都是企业版，试用期 3 天。如需长期使用，[联系我们](https://www.nebula-graph.com.cn/contact)申请正式许可证，之后[续期许可证](../../4.deployment-and-installation/deploy-license.md#nebula_graph_license_3)。 - -## 前提条件 - -- 准备[阿里云账号](https://help.aliyun.com/document_detail/324606.html)。 +## 账号与权限 +- 准备[阿里云账号](http://c.nxw.so/bC0B2 "https://help.aliyun.com/document_detail/324606.html")。 - 如果使用 RAM 用户创建实例，需为其添加以下权限： - AliyunECSFullAccess @@ -18,71 +13,143 @@ - AliyunCloudMonitorFullAccess - AliyunComputeNestUserFullAccess -## 操作步骤 +## 资源与费用 -1. 登录[创建服务实例](https://computenest.console.aliyun.com/user/cn-hangzhou/serviceInstanceCreate?ServiceId=service-39f4f251e9484369a778)页面。 +NebulaGraph Cloud 阿里云版支持免费试用和付费使用，二者的详细说明如下表。 -2. 选中**同意授权并创建关联角色**。 +| 项目 | 免费试用版 | 付费版 | +| - | - | - | +| 云资源归属 | 阿里云官方账号 | 用户账号 | +| 云资源费用 | **阿里云承担** | 用户承担 | +| 云资源使用时长 | 30 天（不可续期） | 用户创建实例时选择 | +| NebulaGraph 许可证费用 | **试用期内免费** | 用户承担 | +| NebulaGraph 服务许可证有效期 | 30 天 | 用户创建实例时选择 | +| 许可证过期后数据是否保留 | 否（因云资源会同时到期） | 是 | +| 云资源到期后数据是否保留 | 否 | 否 | +| 数据盘快照费用 | **阿里云承担** | 用户承担（可关闭功能） | - ![选中同意授权并创建关联角色](https://docs-cdn.nebula-graph.com.cn/figures/authorize-compute-nest_cn_2022.05.30.png) +## 数据备份 -3. 选择要创建实例的**地域**。 +在创建服务实例时，系统会默认开启数据盘自动快照备份，用于周期性备份 NebulaGraph 数据。 -4. 进行**基本信息配置**。 - - 1. 选择 **NebulaGraph版本**。默认为 **3.1.0**。 - 当前仅能选择 **3.1.0**。 - - 2. 设置 **NebulaGraph集群名**。默认为`nebula`。 - - 3. 设置实例密码。 - - - 密码长度为 8-30 个字符。 - - 密码中必须包含大写字母、小写字母、数字、特殊符号中的三种。 - - 特殊符号包括：()`~!@#$%^&*_-+=|{}[]:;'<>,.?/ +创建付费版服务实例前需[开通快照](https://help.aliyun.com/document_detail/108381.html)。免费试用实例使用的是阿里云官方账号下的资源，已开通快照，无需用户手动开通。 + +默认的快照备份策略为每天 00:00 创建快照。 + +创建快照会产生费用，详情参见[快照计费](https://help.aliyun.com/document_detail/56159.htm)。 + +如需删除快照、修改或删除自动快照策略，参见[快照文档](https://help.aliyun.com/document_detail/108376.html)。 + +## 套餐版本 + +NebulaGraph Cloud 阿里云版支持如下套餐版本。 + +| 套餐版本 | 说明 | +| - | - | +| 基础版 | 将所有 NebulaGraph 服务节点部署在 1 台 ECS 服务器上。 | +| 标准版 | 将 Graph 服务和 Storage 服务分别部署在不同的 ECS 服务器上，每个服务都是单节点（1 台 ECS）。将 Explorer 等生态工具混合部署在 1 台 ECS 服务器上。 | +| 高可用版 | 将 Graph 服务和 Storage 服务分别部署在不同的 ECS 服务器上，每个服务都包含 3 节点（3 台 ECS）。将 Explorer 等生态工具混合部署在 1 台 ECS 服务器上。 | + +付费版和免费试用版服务实例支持的套餐版本有所不同，详情参见创建实例页面。 -5. 进行**付费模式设置**，指定 ECS 服务器的付费方式。默认为**按量付费**。 +## 创建付费版服务实例 + +1. 登录[阿里云控制台](https://home.console.aliyun.com/home/dashboard/ProductAndService)。 + +2. 打开云市场的 [NebulaGraph 产品页](https://market.aliyun.com/products/56024006/cmgj00059955.html?#sku=yuncode5395500004)。 + +3. 选择**套餐版本**和**购买时长**（即 NebulaGraph 服务的许可证有效期），并单击**立即购买**。 + + !!! caution + + 当前云市场显示的部分价格并非实际售价，购买时需通过右侧的钉钉客服确认实际价格。 + +4. 在**创建服务实例**页，保持**选择模板**处的选择不变。如需切换部署架构，可改变选中的选项，重新选择模板。 + + !!! note + + 改变模板会改变之前选择的套餐版本，软件费用（NebulaGraph 许可证费用）和创建服务实例需要的资源也会改变。 + +5. （可选）设置**服务实例名称**。默认值为服务实例 ID。 + +6. 选择要创建服务实例的**地域**。 + +7. 在**付费模式设置**区域，指定 ECS 服务器的付费方式。默认为**按量付费**。 - **按量付费**：按照计费周期计费，在每个结算周期生成账单并从账户中扣除相应费用。详情参见[按量付费](https://help.aliyun.com/document_detail/40653.html)。 - - **预付费，包年包月**：先付费后使用。详情参见[包年包月](https://help.aliyun.com/document_detail/56220.html)。 - - 选择包年包月模式需要指定**购买时长周期**和**购买时长**。**购买时长周期**当前仅支持 **Month**，即按月购买，**购买时间**选择范围为 1-60 月。 - -6. 进行**基础设施配置**。 + - **包年包月**：先付费后使用。详情参见[包年包月](https://help.aliyun.com/document_detail/56220.html)。选择包年包月模式需要指定**购买时长周期**和**购买时长**。**购买时长周期**当前仅支持 **Month**，即按月购买。 - 1. 选择**专有网络VPC实例ID**。 +8. 在 **NebulaGraph 配置**区域，完成数据盘和 ECS 服务器密码设置。 +9. 在**基础设施配置**区域，完成以下设置。 + + 1. 选择**专有网络 VPC 实例 ID**。 + 如果下拉列表为空，先单击其右侧的**新建专有网络**，完成专有网络创建。 2. 选择**交换机可用区**。 - 3. 选择**业务网络交换机的实例ID**。 - + 3. 选择**业务网络交换机的实例 ID**。 + 如果下拉列表为空，先单击其右侧的**新建交换机**，完成交换机创建。 -7. 进行**集群节点配置**，根据业务需求配置 NebulaGraph 内核服务的节点。 +10. 完成**权限确认**，并选中**我同意授权服务商（杭州悦数科技有限公司）获取上述权限以提供代运维服务**。 - NebulaGraph 内核包含 Graph、Meta、Storage 服务，因此需要为这些服务分别选择**节点数量**、**节点实例类型**、**数据盘类型**和**数据盘空间**。 +11. 在页面底部，单击**下一步：确认订单**。 - !!! caution - 建议按照页面推荐信息配置集群节点以提升服务的可用性，例如配置 3 个 Meta 节点和至少 3 个 Storage 节点。 +12. 在**服务条款**区域，勾选**我已阅读并同意《商品在线协议》《云市场平台服务协议》《计算巢服务协议》**。 + +13. 在页面底部，单击**立即支付**。 + +14. 在**支付**页面，选择支付方式，之后单击页面底部的**支付**。 + +15. 在**支付完成**页面，单击**管理控制台**。 + +16. 在**已购买的服务**页面，单击要创建的实例右侧的**立即进入计算巢部署或查看部署详情**。 + + !!! note + + 如果已购买的服务列表中未显示要创建的实例，刷新页面。 -8. 进行**可视化产品配置**，选择要部署的可视化产品。 +17. 在**服务实例详情**页查看实例的**状态**，确保状态为**部署中**。 + + 部署的平均耗时为 10 分钟。完成后实例的状态变为**已部署**。 + +## 创建免费版试用版服务实例 + +!!! danger + 免费试用实例不可在生产环境中使用。 + +1. 登录阿里云计算巢[推荐服务](http://c.nxw.so/bC0C0 "https://computenest.console.aliyun.com/user/cn-hangzhou/recommendService")页面，搜索 **NebulaGraph**。 + +2. 在 **NebulaGraph 集群版**卡片上，单击**免费试用**。 + +3. 系统会为首次创建 NebulaGraph 服务实例的用户弹出申请对话框。在**申请权限**对话框中填写申请人信息。带有红色星号（*）的为必填项。 + + !!! note - 可选用的产品包括 [Dashboard](../../nebula-dashboard-ent/1.what-is-dashboard-ent.md) 和 [Explorer](../../nebula-explorer/about-explorer/ex-ug-what-is-explorer.md)，默认都处于**开启**状态，此时需要为其选择**实例类型**。选中**关闭**表示不部署相应产品。 + 申请通过后需从第 1 步重新开始。 -9. 根据需要配置**标签和资源组**。详情参见[什么是资源管理](https://help.aliyun.com/document_detail/94475.html)。 +4. （可选）设置**服务实例名称**。默认值为服务实例 ID。 -10. 完成**权限确认**，并选中**我同意授权服务商（杭州悦数科技有限公司）获取上述权限以提供代运维服务**。 +5. 选择要创建实例的**地域**。 + +6. 在 **NebulaGraph 配置**区域，完成数据盘和 ECS 服务器密码设置。 + +7. 在**基础设施配置**区域，选择**交换机可用区**。 + +8. 完成**权限确认**，并选中**我同意授权服务商（杭州悦数科技有限公司）获取上述权限以提供代运维服务**。 + +9. 在页面底部，单击**下一步：确认订单**。 -11. 在页面底部，选中**我已阅读并同意《计算巢服务协议》**，并单击**创建**。 +10. 在**服务条款**区域，勾选**我已阅读并同意《计算巢服务协议》**。 -12. 在**创建**对话框，完成**信息确认**并**支付费用**。 +11. 在页面底部，单击**开始免费试用**。 -13. 在**提交成功**页面，单击去列表查看。 +12. 在**提交成功**页面，单击**去列表查看**。 -14. 在实例列表中查看目标实例的**状态**，确保状态为**部署中**。 +13. 在实例列表中查看目标实例的**状态**，确保状态为**部署中**。 部署的平均耗时为 10 分钟。完成后实例的状态变为**已部署**。 diff --git a/docs-2.0/nebula-cloud/nebula-cloud-on-alibabacloud/2.use-cloud-services.md b/docs-2.0/nebula-cloud/nebula-cloud-on-alibabacloud/2.use-cloud-services.md index 0de35f409fa..6f4e3e8a732 100644 --- a/docs-2.0/nebula-cloud/nebula-cloud-on-alibabacloud/2.use-cloud-services.md +++ b/docs-2.0/nebula-cloud/nebula-cloud-on-alibabacloud/2.use-cloud-services.md @@ -2,41 +2,23 @@ 创建好服务实例后，即可查看服务信息，并开始使用 NebulaGraph 服务。 -## 试用期与续期 - -NebulaGraph Cloud 阿里云版中的 NebulaGraph、NebulaGraph Dashboard 和 NebulaGraph Explorer 服务都是企业版，需要有效的许可证才能正常运行。创建实例时默认赠送有效期为 3 天的试用版许可证。 - -试用版许可证到期时，服务无法使用。如需继续使用，请[联系我们](https://www.nebula-graph.com.cn/contact)。 - -获取有效的许可证后，使用新的许可证[替换旧许可证](../../4.deployment-and-installation/deploy-license.md#nebula_graph_license_3)，即可继续使用服务。 - -!!! note - - 替换许可证时需要连接 Meta 服务所在的阿里云 ECS 实例，方法参见[连接方式概述](https://help.aliyun.com/document_detail/71529.html)。 - -正式版许可证的续期方法与试用版相同。 - ## 查看服务实例 在计算巢控制台可以查看服务实例的详细信息，详情参见[查看服务实例](https://help.aliyun.com/document_detail/290838.html)。 -## 查看连接地址 +## 查看连接信息 连接服务前，需要在阿里云计算巢的实例详情中查看各服务的连接地址。查看方式如下： -1. 登录[服务实例管理](https://computenest.console.aliyun.com/user/cn-hangzhou/serviceInstance/private)页面。 - -2. 在实例列表中，单击目标实例的**服务实例ID**，或其右侧**操作**列的**详情**。 - -3. 在**概览**页的**基本信息**区域，可以查看 Graph 服务、Meta 服务、Storage 服务，以及 Explorer 和 Dashboard 的连接地址。 +1. 登录[服务实例管理](http://c.nxw.so/9huj4 "https://computenest.console.aliyun.com/user/cn-hangzhou/serviceInstance/private")页面。 -常用的连接地址有： + !!! note -- **graph_private_ip** 与 **graph_public_ip**，即 Graph 服务的私网与公网 IP 地址，可用于连接 NebulaGraph。 + 如果要寻找的是免费试用版服务实例，需先在**服务实例管理**页面单击**试用服务**标签。 -- **explorer_portal**，即 NebulaGraph Explorer 的连接地址，单击地址即可在浏览器中打开 NebulaGraph Explorer。 +2. 在实例列表中，单击目标实例的**服务实例ID**，或其右侧**操作**列的**详情**。 -- **dashboard_portal**，即 NebulaGraph Dashboard 的连接地址，单击地址即可在浏览器中打开 NebulaGraph Dashboard。 +3. 在**概览**标签页的**基本信息**区域，可以查看 Graph 服务、Storage 服务，以及 Explorer、Dashboard 等周边工具的连接信息。 ## 连接 NebulaGraph @@ -48,7 +30,23 @@ NebulaGraph Cloud 阿里云版提供多种连接方式。 连接方式： -直连 **graph_private_ip** 或 **graph_public_ip** 地址。详细连接方式参见[客户端文档](https://docs.nebula-graph.com.cn/{{nebula.release}}/14.client/1.nebula-client/)。 +直连 Graph 服务的私网或公网 IP 地址。详细连接方式参见[客户端文档](https://docs.nebula-graph.com.cn/{{nebula.release}}/14.client/1.nebula-client/)。 + +如需通过公网连接 NebulaGraph 数据库： + +1. 到 Graph 服务部署的 ECS 实例详情中找到其公网 IP 地址。 + +2. （仅付费版需执行该步骤）在 NebulaGraph 服务实例加入的安全组中，[添加安全组规则](https://help.aliyun.com/document_detail/25471.html)，允许从指定的公网 IP 地址访问 TCP 9669 端口。 + + !!! note + + 免费试用版默认允许从公网访问 Graph 服务的 9669 端口。 + +3. 使用 Graph 服务的公网 IP 地址和 9669 端口访问 NebulaGraph 数据库。 + +!!! caution + + 建议仅通过私网 IP 连接，提高网络和数据的安全性。 ### 使用 Explorer 连接 NebulaGraph @@ -56,7 +54,7 @@ NebulaGraph Cloud 阿里云版提供多种连接方式。 连接方式： -1. 在浏览器中使用 **explorer_portal** 地址打开 NebulaGraph Explorer。 +1. 在浏览器中使用 **Explorer 服务访问地址**打开 Nebula Explorer。 2. 使用 Explorer 连接 NebulaGraph。详情参见[连接数据库](https://docs.nebula-graph.com.cn/{{nebula.release}}/nebula-explorer/deploy-connect/ex-ug-connect/)。 ## 监控 NebulaGraph diff --git a/docs-2.0/nebula-cloud/nebula-cloud-on-alibabacloud/4.scaling-services.md b/docs-2.0/nebula-cloud/nebula-cloud-on-alibabacloud/4.scaling-services.md new file mode 100644 index 00000000000..ec6bae7468e --- /dev/null +++ b/docs-2.0/nebula-cloud/nebula-cloud-on-alibabacloud/4.scaling-services.md @@ -0,0 +1,46 @@ +# 扩缩容服务 + +NebulaGraph Cloud 阿里云版的弹性扩缩容功能支持根据需求扩缩容服务节点，灵活调整集群规模。 + +## 使用限制 + +- 弹性扩缩容功能支持 Storage 扩容，不支持 Storage 缩容。 +- 使用弹性扩缩容功能缩容 Graph 服务时，需先使用集群中 NebulaGraph Dashboard 服务的扩缩容功能删除不再需要的 Graph 服务节点。扩容 Graph 服务时无此限制。 + +## 操作步骤 + +1. 登录阿里云计算巢的[服务实例管理页面](http://c.nxw.so/9huj4 "https://computenest.console.aliyun.com/user/cn-hangzhou/serviceInstance/private")。 + +2. 在服务实例列表中，单击目标实例的 ID 或其右侧**操作**列的**详情**。 + + !!! note + + 免费试用版服务实例列表在**试用服务**标签页中。 + +3. 在**服务实例详情**页面，单击**运维管理**标签。 + +4. 在**应用运维**区域，单击**弹性扩缩容**。 + +5. 在**弹性扩缩容**对话框，完成如下操作。 + + 1. 确认**将要调整的资源类型**为 **ESS**。 + + 2. 选择**伸缩组 ID**。 + + - 如需扩缩容 Storage 服务，选择名称以 **ng-storage** 开头的伸缩组。 + - 如需扩缩容 Graph 服务，选择名称以 **ng-graph** 开头的伸缩组。 + + 3. 选择**伸缩规则的调整方式**。 + + - 如果选择**扩容**或**缩容**，下方的**伸缩组 ECS 实例调整的数量**指定的是要增加或减少的节点数量。 + - 如果选择**调整至指定数量**，下方的**伸缩组 ECS 实例调整的数量**指定的是节点调整之后剩余的数量，而不是增加或减少的数量。 + + 4. 输入**伸缩组 ECS 实例调整的数量**。 + + 5. 单击**下一步**。 + + 6. 检查任务信息，确认无误后单击**创建**。 + +6. 等候数分钟，直到**运维管理**标签页中的**执行状态**显示**成功**。 + +7. 单击**概览**标签页，查看**服务资源**区域的 ECS 实例数量，如果符合预期的调整效果，则扩缩容完成。 diff --git a/docs-2.0/reuse/source_create_instance_aliyun.md b/docs-2.0/reuse/source_create_instance_aliyun.md index bc1454452bc..7af8ddfe77c 100644 --- a/docs-2.0/reuse/source_create_instance_aliyun.md +++ b/docs-2.0/reuse/source_create_instance_aliyun.md @@ -1,12 +1,6 @@ -在使用 NebulaGraph Cloud 阿里云版服务前，要先在阿里云控制台创建服务实例。 - -!!! caution - - 通过 NebulaGraph Cloud 阿里云版创建的 NebulaGraph、Nebula Dashboard 和 Nebula Explorer 等服务都是企业版，试用期 14 天。如需长期使用，发送邮件[申请正式许可证](mailto:inquiry@vesoft.com)，之后[续期许可证](../../4.deployment-and-installation/deploy-license.md#nebula_graph_license_3)。 - ## 账号与权限 -- 准备[阿里云账号](https://help.aliyun.com/document_detail/324606.html)。 +- 准备[阿里云账号](http://c.nxw.so/bC0B2 "https://help.aliyun.com/document_detail/324606.html")。 - 如果使用 RAM 用户创建实例，需为其添加以下权限： - AliyunECSFullAccess @@ -17,43 +11,74 @@ ## 资源与费用 -NebulaGraph Cloud 阿里云版支持免费试用和付费使用。两种使用方式有不同的资源归属和费用消耗。 +NebulaGraph Cloud 阿里云版支持免费试用和付费使用，二者的详细说明如下表。 + +| 项目 | 免费试用版 | 付费版 | +| - | - | - | +| 云资源归属 | 阿里云官方账号 | 用户账号 | +| 云资源费用 | **阿里云承担** | 用户承担 | +| 云资源使用时长 | 30 天（不可续期） | 用户创建实例时选择 | +| NebulaGraph 许可证费用 | **试用期内免费** | 用户承担 | +| NebulaGraph 服务许可证有效期 | 30 天 | 用户创建实例时选择 | +| 许可证过期后数据是否保留 | 否（因云资源会同时到期） | 是 | +| 云资源到期后数据是否保留 | 否 | 否 | +| 数据盘快照费用 | **阿里云承担** | 用户承担（可关闭功能） | + +## 数据备份 + +在创建服务实例时，系统会默认开启数据盘自动快照备份，用于周期性备份 NebulaGraph 数据。 + +创建付费版服务实例前需[开通快照](https://help.aliyun.com/document_detail/108381.html)。免费试用实例使用的是阿里云官方账号下的资源，已开通快照，无需用户手动开通。 -付费版服务实例创建在用户的阿里云账号下，资源费用由用户承担。实例内 NebulaGraph 相关服务的许可证到期后，其中的数据仍然保留在用户的阿里云资源中，直到资源被用户删除。 +默认的快照备份策略为每天 00:00 创建快照。 -免费试用版服务实例使用的资源属于阿里云，资源费用由阿里云承担。实例内 NebulaGraph 相关服务的许可证到期后，其中的数据仍然保留在试用的阿里云资源中，直到资源过期或被用户删除。资源的试用时间为 30 天，到期后资源内保存的数据不保留。 +创建快照会产生费用，详情参见[快照计费](https://help.aliyun.com/document_detail/56159.htm)。 -!!! note +如需删除快照、修改或删除自动快照策略，参见[快照文档](https://help.aliyun.com/document_detail/108376.html)。 - 基础版套餐将所有 NebulaGraph 服务节点部署在同一台 ECS 服务器上。 +## 套餐版本 + +NebulaGraph Cloud 阿里云版支持如下套餐版本。 + +| 套餐版本 | 说明 | +| - | - | +| 基础版 | 将所有 NebulaGraph 服务节点部署在 1 台 ECS 服务器上。 | +| 标准版 | 将 Graph 服务和 Storage 服务分别部署在不同的 ECS 服务器上，每个服务都是单节点（1 台 ECS）。将 Explorer 等生态工具混合部署在 1 台 ECS 服务器上。 | +| 高可用版 | 将 Graph 服务和 Storage 服务分别部署在不同的 ECS 服务器上，每个服务都包含 3 节点（3 台 ECS）。将 Explorer 等生态工具混合部署在 1 台 ECS 服务器上。 | + +付费版和免费试用版服务实例支持的套餐版本有所不同，详情参见创建实例页面。 ## 创建付费版服务实例 -1. 登录阿里云计算巢[推荐服务](https://computenest.console.aliyun.com/user/cn-hangzhou/recommendService)页面，搜索 **NebulaGraph**。 +1. 登录[阿里云控制台](https://home.console.aliyun.com/home/dashboard/ProductAndService)。 -2. 在 **NebulaGraph 集群版**卡片上，单击**云市场购买**。 +2. 打开云市场的 [NebulaGraph 产品页](https://market.aliyun.com/products/56024006/cmgj00059955.html?#sku=yuncode5395500004)。 -3. 在云市场的 **NebulaGraph Enterprise** 产品页，选择**套餐版本**和**购买时长**（即 NebulaGraph 服务的许可证有效期），并单击**立即购买**。 +3. 选择**套餐版本**和**购买时长**（即 NebulaGraph 服务的许可证有效期），并单击**立即购买**。 !!! caution 当前云市场显示的部分价格并非实际售价，购买时需通过右侧的钉钉客服确认实际价格。 -4. 在**确认订单**页面，选择要创建实例的**地域**。 +4. 在**创建服务实例**页，保持**选择模板**处的选择不变。如需切换部署架构，可改变选中的选项，重新选择模板。 -5. 在**付费模式设置**区域，指定 ECS 服务器的付费方式。默认为**按量付费**。 + !!! note - - **按量付费**：按照计费周期计费，在每个结算周期生成账单并从账户中扣除相应费用。详情参见[按量付费](https://help.aliyun.com/document_detail/40653.html)。 + 改变模板会改变之前选择的套餐版本，软件费用（NebulaGraph 许可证费用）和创建服务实例需要的资源也会改变。 - - **包年包月**：先付费后使用。详情参见[包年包月](https://help.aliyun.com/document_detail/56220.html)。选择包年包月模式需要指定**购买时长周期**和**购买时长**。**购买时长周期**当前仅支持 **Month**，即按月购买。 +5. （可选）设置**服务实例名称**。默认值为服务实例 ID。 + +6. 选择要创建服务实例的**地域**。 -6. 在**套餐选择**区域，根据需要选择套餐版本。 +7. 在**付费模式设置**区域，指定 ECS 服务器的付费方式。默认为**按量付费**。 - + - **按量付费**：按照计费周期计费，在每个结算周期生成账单并从账户中扣除相应费用。详情参见[按量付费](https://help.aliyun.com/document_detail/40653.html)。 + + - **包年包月**：先付费后使用。详情参见[包年包月](https://help.aliyun.com/document_detail/56220.html)。选择包年包月模式需要指定**购买时长周期**和**购买时长**。**购买时长周期**当前仅支持 **Month**，即按月购买。 -7. 在 **NebulaGraph 配置**区域，完成数据盘和 ECS 服务器密码设置。 +8. 在 **NebulaGraph 配置**区域，完成数据盘和 ECS 服务器密码设置。 -8. 在**基础设施配置**区域，完成以下设置。 +9. 在**基础设施配置**区域，完成以下设置。 1. 选择**专有网络 VPC 实例 ID**。 @@ -65,56 +90,62 @@ NebulaGraph Cloud 阿里云版支持免费试用和付费使用。两种使用 如果下拉列表为空，先单击其右侧的**新建交换机**，完成交换机创建。 -9. 在**温馨提示**区域，选中**我同意告知服务商我的联系方式**，以便购买后发放许可证。 +10. 完成**权限确认**，并选中**我同意授权服务商（杭州悦数科技有限公司）获取上述权限以提供代运维服务**。 + +11. 在页面底部，单击**下一步：确认订单**。 + +12. 在**服务条款**区域，勾选**我已阅读并同意《商品在线协议》《云市场平台服务协议》《计算巢服务协议》**。 + +13. 在页面底部，单击**立即支付**。 -10. 在页面底部，单击**我已接受协议，前往支付**。 +14. 在**支付**页面，选择支付方式，之后单击页面底部的**支付**。 -11. 在**支付**页面，选择支付方式，之后单击页面底部的**支付**。 +15. 在**支付完成**页面，单击**管理控制台**。 -12. 在**支付完成**页面，单击**管理控制台**。 +16. 在**已购买的服务**页面，单击要创建的实例右侧的**立即进入计算巢部署或查看部署详情**。 -13. 在**已购买的服务**页面，单击要创建的实例右侧的**立即进入计算巢部署或查看部署详情**。 + !!! note -14. 在计算巢的**服务实例详情**页面，单击**基本信息**区域**状态**右侧的**部署**，并在弹出的对话框中单击**确定部署**。 + 如果已购买的服务列表中未显示要创建的实例，刷新页面。 -15. 监控实例状态，直到部署完成。平均部署耗时为 10 分钟。 +17. 在**服务实例详情**页查看实例的**状态**，确保状态为**部署中**。 + + 部署的平均耗时为 10 分钟。完成后实例的状态变为**已部署**。 ## 创建免费版试用版服务实例 !!! danger 免费试用实例不可在生产环境中使用。 -1. 登录阿里云计算巢[推荐服务](https://computenest.console.aliyun.com/user/cn-hangzhou/recommendService)页面，搜索 **NebulaGraph**。 +1. 登录阿里云计算巢[推荐服务](http://c.nxw.so/bC0C0 "https://computenest.console.aliyun.com/user/cn-hangzhou/recommendService")页面，搜索 **NebulaGraph**。 2. 在 **NebulaGraph 集群版**卡片上，单击**免费试用**。 3. 系统会为首次创建 NebulaGraph 服务实例的用户弹出申请对话框。在**申请权限**对话框中填写申请人信息。带有红色星号（*）的为必填项。 - 申请通过后才能继续执行以下步骤。 + !!! note + + 申请通过后需从第 1 步重新开始。 -4. 设置**服务实例名称**。 +4. （可选）设置**服务实例名称**。默认值为服务实例 ID。 5. 选择要创建实例的**地域**。 -6. 在**套餐选择**区域，根据需要选择套餐版本。 - - - -7. 在 **NebulaGraph 配置**区域，完成数据盘相关设置。 +6. 在 **NebulaGraph 配置**区域，完成数据盘和 ECS 服务器密码设置。 -8. 在**基础设施配置**区域，选择**交换机可用区**。 +7. 在**基础设施配置**区域，选择**交换机可用区**。 -9. 根据需要配置**标签和资源组**。详情参见[什么是资源管理](https://help.aliyun.com/document_detail/94475.html)。 +8. 完成**权限确认**，并选中**我同意授权服务商（杭州悦数科技有限公司）获取上述权限以提供代运维服务**。 -10. 完成**权限确认**，并选中**我同意授权服务商（杭州悦数科技有限公司）获取上述权限以提供代运维服务**。 +9. 在页面底部，单击**下一步：确认订单**。 -11. 在页面底部，选中**我已阅读并同意《计算巢服务协议》**，并单击**开始免费试用**。 +10. 在**服务条款**区域，勾选**我已阅读并同意《计算巢服务协议》**。 -12. 在**创建**对话框，完成信息确认并单击**确定**。 +11. 在页面底部，单击**开始免费试用**。 -13. 在**提交成功**页面，单击去列表查看。 +12. 在**提交成功**页面，单击**去列表查看**。 -14. 在实例列表中查看目标实例的**状态**，确保状态为**部署中**。 +13. 在实例列表中查看目标实例的**状态**，确保状态为**部署中**。 部署的平均耗时为 10 分钟。完成后实例的状态变为**已部署**。 @@ -124,4 +155,4 @@ Q：服务实例的状态显示为**部署失败**怎么处理？ 1. 如果使用 RAM 账号创建的实例，确认为该账号授予了本文前提条件中指定的权限。 2. 如果权限符合要求，[删除](https://help.aliyun.com/document_detail/290837.html)创建失败的实例，尝试重新创建。 -3. 如果仍然创建失败，到 [NebulaGraph 论坛](https://discuss.nebula-graph.com.cn/)寻求帮助。 \ No newline at end of file +3. 如果仍然创建失败，到 [NebulaGraph 论坛](https://discuss.nebula-graph.com.cn/)寻求帮助。 diff --git a/mkdocs.yml b/mkdocs.yml index 49fa068b492..d4370c82b94 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -75,29 +75,28 @@ plugins: # Exclude all files in a directory. The path starts with the directory name in docs-2.0, such as `20.appendix/*`. - nebula-flink/* - CHANGELOG.md - - nebula-cloud/* + # - nebula-cloud/* + - nebula-cloud.md + - nebula-cloud/nebula-cloud-on-azure/* - spark-connector/* - 4.deployment-and-installation/5.zone.md - 4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-from-200-to-latest.md - - # 仅发布包含企业版功能的文档版本时，注释以下页面 # ent.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 -# - graph-computing/0.deploy-controller-analytics.md -# - graph-computing/nebula-analytics.md -# - graph-computing/use-explorer.md -# - nebula-exchange/use-exchange/ex-ug-export-from-nebula.md -# - nebula-operator/8.custom-cluster-configurations/8.3.balance-data-when-scaling-storage.md -# - nebula-operator/10.backup-restore-using-operator.md -# - synchronization-and-migration/replication-between-clusters.md -# - 20.appendix/8.about-license/ -# - nebula-dashboard-ent/4.cluster-operator/operator/scale.md -# - 6.monitor-and-metrics/3.bbox/ -# - backup-and-restore/nebula-br-ent/ -# + - 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 + - graph-computing/0.deploy-controller-analytics.md + - graph-computing/nebula-analytics.md + - graph-computing/use-explorer.md + - nebula-exchange/use-exchange/ex-ug-export-from-nebula.md + - nebula-operator/8.custom-cluster-configurations/8.3.balance-data-when-scaling-storage.md + - nebula-operator/10.backup-restore-using-operator.md + - synchronization-and-migration/replication-between-clusters.md + - 20.appendix/8.about-license/ + - nebula-dashboard-ent/4.cluster-operator/operator/scale.md + - 6.monitor-and-metrics/3.bbox/ + - backup-and-restore/nebula-br-ent/ # ent.end # comm.begin # comm.end @@ -262,9 +261,9 @@ extra: tag: v3.4.0 cloud: azureRelease: 3.1.1 # Azure云兼容的最新内核版本 - aliyunRelease: 3.1.1 # 阿里云兼容的最新内核版本 + aliyunRelease: 3.4.0 # 阿里云兼容的最新内核版本 azureLatestRelease: 3.1.0 # 支持Azure云的最新文档版本 - aliyunLatestRelease: 3.1.0 # 支持阿里云的最新文档版本 + aliyunLatestRelease: 3.4.0 # 支持阿里云的最新文档版本 ent: ent_begin: #文档包含企业版时需补全该注释（），只包含社区版时只保留注释头（ #文档包含企业版时需补全该注释（），只包含社区版时只保留注释尾（-->） @@ -538,11 +537,16 @@ nav: - NebulaGraph Python: 14.client/5.nebula-python-client.md - NebulaGraph Go: 14.client/6.nebula-go-client.md - - NebulaGraph Cloud: nebula-cloud.md +# - NebulaGraph Cloud: nebula-cloud.md #ent -# - NebulaGraph Cloud: -# - 什么是 NebulaGraph Cloud: nebula-cloud/1.what-is-cloud.md + - NebulaGraph Cloud: + - 什么是 NebulaGraph Cloud: nebula-cloud/1.what-is-cloud.md + - Nebula Graph Cloud 阿里云版: + - 创建服务实例: nebula-cloud/nebula-cloud-on-alibabacloud/1.create-service-instance.md + - 使用服务实例: nebula-cloud/nebula-cloud-on-alibabacloud/2.use-cloud-services.md + - 扩缩容服务: nebula-cloud/nebula-cloud-on-alibabacloud/4.scaling-services.md + - 删除服务实例: nebula-cloud/nebula-cloud-on-alibabacloud/3.delete-service-instance.md # - NebulaGraph Cloud Azure版: # - 创建订阅: nebula-cloud/nebula-cloud-on-azure/2.how-to-create-subsciption.md # - 配置Solution: nebula-cloud/nebula-cloud-on-azure/3.how-to-set-solution.md @@ -555,10 +559,6 @@ nav: # - 价格: nebula-cloud/nebula-cloud-on-azure/6.pricing.md # - 用户服务条款: nebula-cloud/nebula-cloud-on-azure/7.terms-and-conditions.md # - 隐私政策条款: nebula-cloud/nebula-cloud-on-azure/8.privacy-policy.md -# - NebulaGraph Cloud 阿里云版: -# - 创建服务实例: nebula-cloud/nebula-cloud-on-alibabacloud/1.create-service-instance.md -# - 使用服务实例: nebula-cloud/nebula-cloud-on-alibabacloud/2.use-cloud-services.md -# - 删除服务实例: nebula-cloud/nebula-cloud-on-alibabacloud/3.delete-service-instance.md - NebulaGraph Studio: - 认识 NebulaGraph Studio: From 261ead998465461e90030ddc53212d1cdeb51970 Mon Sep 17 00:00:00 2001 From: "abby.huang" <78209557+abby-cyber@users.noreply.github.com> Date: Wed, 15 Feb 2023 16:00:32 +0800 Subject: [PATCH 040/137] Update 1.get-subgraph.md (#2594) --- .../16.subgraph-and-path/1.get-subgraph.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) 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 499f8cce750..68fe7459074 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 @@ -114,12 +114,12 @@ nebula> INSERT EDGE serve(start_year, end_year) VALUES "player101" -> "team204": nebula> GET SUBGRAPH WITH PROP 2 STEPS FROM "player101" \ WHERE follow.degree > 90 AND $$.player.age > 30 \ YIELD VERTICES AS nodes, EDGES AS relationships; - +-------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | nodes | relationships | - +-------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | [("player101" :player{age: 36, name: "Tony Parker"})] | [[:follow "player101"->"player100" @0 {degree: 95}], [:follow "player101"->"player125" @0 {degree: 95}], [:follow "player100"->"player101" @0 {degree: 95}]] | - | [("player125" :player{age: 41, name: "Manu Ginobili"}), ("player100" :player{age: 42, name: "Tim Duncan"})] | [[:follow "player100"->"player125" @0 {degree: 95}]] | - +-------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------------------------------+------------------------------------------------------+ + | nodes | relationships | + +-------------------------------------------------------+------------------------------------------------------+ + | [("player101" :player{age: 36, name: "Tony Parker"})] | [[:follow "player101"->"player100" @0 {degree: 95}]] | + | [("player100" :player{age: 42, name: "Tim Duncan"})] | [] | + +-------------------------------------------------------+------------------------------------------------------+ ``` ## FAQ From 51cfb499a1a0dec06741e19ae51bcb8c67e47f4e Mon Sep 17 00:00:00 2001 From: cooper-lzy <78672629+cooper-lzy@users.noreply.github.com> Date: Wed, 15 Feb 2023 17:56:25 +0800 Subject: [PATCH 041/137] dashboard release 3.4.1 (#2595) --- .../release-notes/dashboard-ent-release-note.md | 8 ++++++++ docs-2.0/nebula-dashboard-ent/1.what-is-dashboard-ent.md | 2 +- mkdocs.yml | 4 ++-- 3 files changed, 11 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 a9146290b98..265a91fc1b4 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,13 @@ # NebulaGraph Dashboard 企业版更新说明 +## 企业版 v3.4.1 + +- 缺陷修复 + + - 修复 RPM 包因为权限问题无法执行 `nebula-agent` 的问题。 + - 修复 goconfig 文件夹权限问题导致无法查看集群导入信息的问题。 + - 修复当许可证过期时间小于`30`天且`gracePeriod`大于`0`时页面提示错误的问题。 + ## 企业版 v3.4.0 - 功能 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 b08e428dab9..b4a890c4025 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 @@ -45,7 +45,7 @@ NebulaGraph 的版本和 Dashboard 企业版的版本对应关系如下。 |NebulaGraph 版本|Dashboard 版本| |:---|:---| -|3.4.0 |3.4.0、3.2.4、3.2.3、3.2.2、3.2.1、3.2.0| +|3.4.0 |3.4.1、3.4.0、3.2.4、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| diff --git a/mkdocs.yml b/mkdocs.yml index d4370c82b94..c0a4f623db5 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -204,8 +204,8 @@ extra: base100: 1.0.0 branch: release-3.4 dashboard_ent: - release: 3.4.0 - tag: v3.4.0 + release: 3.4.1 + tag: v3.4.1 branch: release-3.4 console: release: 3.4.0 From 53fa3a7b4ff8f25d1ace7969c7c15d48287ec768 Mon Sep 17 00:00:00 2001 From: "abby.huang" <78209557+abby-cyber@users.noreply.github.com> Date: Thu, 16 Feb 2023 09:45:37 +0800 Subject: [PATCH 042/137] Update 2.user-defined-variables.md (#2596) * Update 2.user-defined-variables.md * Update 2.user-defined-variables.md --- .../2.user-defined-variables.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs-2.0/3.ngql-guide/4.variable-and-composite-queries/2.user-defined-variables.md b/docs-2.0/3.ngql-guide/4.variable-and-composite-queries/2.user-defined-variables.md index b41cce31060..c56b4ec360b 100644 --- a/docs-2.0/3.ngql-guide/4.variable-and-composite-queries/2.user-defined-variables.md +++ b/docs-2.0/3.ngql-guide/4.variable-and-composite-queries/2.user-defined-variables.md @@ -31,7 +31,8 @@ nGQL 扩展的自定义变量可以表示为`$var_name`，`var_name`由字母、 !!! Note - 自定义变量区分大小写。 + - 自定义变量区分大小写。 + - 在包含扩展的自定义变量的复合语句中，用英文分号`;`结束定义变量的语句。详情参见 [nGQL 风格指南](../../3.ngql-guide/1.nGQL-overview/ngql-style-guide.md)。 ## 示例 From 236503eb1eabe25ba7522c31b7d9ea67c166a80f Mon Sep 17 00:00:00 2001 From: "abby.huang" <78209557+abby-cyber@users.noreply.github.com> Date: Fri, 17 Feb 2023 13:57:06 +0800 Subject: [PATCH 043/137] delete outdated limitation for a tag name (#2597) --- docs-2.0/3.ngql-guide/10.tag-statements/1.create-tag.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs-2.0/3.ngql-guide/10.tag-statements/1.create-tag.md b/docs-2.0/3.ngql-guide/10.tag-statements/1.create-tag.md index 60350185114..ed95702abfe 100644 --- a/docs-2.0/3.ngql-guide/10.tag-statements/1.create-tag.md +++ b/docs-2.0/3.ngql-guide/10.tag-statements/1.create-tag.md @@ -31,7 +31,7 @@ CREATE TAG [IF NOT EXISTS] |参数|说明| |:---|:---| |`IF NOT EXISTS`|检测待创建的 Tag 是否存在，只有不存在时，才会创建 Tag。仅检测 Tag 的名称，不会检测具体属性。| -|``|1、每个图空间内的 Tag 必须是唯一的。
2、Tag 名称设置后无法修改。
3、Tag 名称以英文字母开头，支持 1~4 字节的 UTF-8 编码字符，包括英文字母（区分大小写）、数字、中文等，但是不包括除下划线外的特殊字符。使用特殊字符或保留关键字时，需要用反引号（\`）包围且不能使用英文句号（`.`），详情参见[关键字和保留字](../../3.ngql-guide/1.nGQL-overview/keywords-and-reserved-words.md)。| +|``|1、每个图空间内的 Tag 必须是唯一的。
2、Tag 名称设置后无法修改。
3、支持 1~4 字节的 UTF-8 编码字符，包括英文字母（区分大小写）、数字、中文、日文、韩文等，但是不包括除下划线外的特殊字符。使用特殊字符或保留关键字时，需要用反引号（\`）包围且不能使用英文句号（`.`），详情参见[关键字和保留字](../../3.ngql-guide/1.nGQL-overview/keywords-and-reserved-words.md)。| |``|属性名称。每个 Tag 中的属性名称必须唯一。属性的命名规则与 Tag 相同。| |``|属性的数据类型，目前支持[数值](../3.data-types/1.numeric.md)、[布尔](../3.data-types/2.boolean.md)、[字符串](../3.data-types/3.string.md)以及[日期与时间](../3.data-types/4.date-and-time.md)。| |`NULL \| NOT NULL`|指定属性值是否支持为`NULL`。默认值为`NULL`。当指定属性值为`NOT NULL`时，必需指定属性的默认值，也就是`DEFAULT`的值。| From a66e07ce50c9b028b6de82f653657f5c39d3b653 Mon Sep 17 00:00:00 2001 From: Cheng Xuntao <7731943+xtcyclist@users.noreply.github.com> Date: Fri, 17 Feb 2023 17:46:32 +0800 Subject: [PATCH 044/137] =?UTF-8?q?=E6=8A=8A=20NebulaGraph=20=E6=94=B9?= =?UTF-8?q?=E6=88=90=E5=9B=BE=E7=A9=BA=E9=97=B4=EF=BC=88space)=20(#2582)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit VID 是在一个 space 中唯一，不是在一个 NebulaGraph 中。后者可能包含多个 space。 --- docs-2.0/1.introduction/3.vid.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs-2.0/1.introduction/3.vid.md b/docs-2.0/1.introduction/3.vid.md index 6cdea6b2792..86d60813fcd 100644 --- a/docs-2.0/1.introduction/3.vid.md +++ b/docs-2.0/1.introduction/3.vid.md @@ -1,6 +1,6 @@ # 点 VID -在 NebulaGraph 中，一个点由点的 ID 唯一标识，即 VID 或 Vertex ID。 +在一个图空间中，一个点由点的 ID 唯一标识，即 VID 或 Vertex ID。 ## VID 的特点 From 91e5a19b727ce75a7696c44bf6824e0215b082fd Mon Sep 17 00:00:00 2001 From: foesa <35463247+foesa-yang@users.noreply.github.com> Date: Mon, 20 Feb 2023 11:03:59 +0800 Subject: [PATCH 045/137] Update README.md (#2598) --- docs-2.0/README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs-2.0/README.md b/docs-2.0/README.md index 3055611c65c..9994e1143e5 100644 --- a/docs-2.0/README.md +++ b/docs-2.0/README.md @@ -17,6 +17,10 @@ NebulaGraph 是一款开源的、分布式的、易扩展的原生图数据库，能够承载数千亿个点和数万亿条边的超大规模数据集，并且提供毫秒级查询。 --> +* [NebulaGraph 3.4.0 内核及周边工具新发布](https://www.bilibili.com/video/BV12R4y1e7U7)（05 分 24 秒） + + + ## 快速开始 From 7e28ec628c8adb7c2f5968edd09e21f7e68e281f Mon Sep 17 00:00:00 2001 From: cooper-lzy <78672629+cooper-lzy@users.noreply.github.com> Date: Mon, 20 Feb 2023 16:07:39 +0800 Subject: [PATCH 046/137] Enable AutoFDO (#2599) * Enable AutoFDO * Update enable_autofdo_for_nebulagraph.md * Update enable_autofdo_for_nebulagraph.md --- .../enable_autofdo_for_nebulagraph.md | 197 ++++++++++++++++++ mkdocs.yml | 1 + 2 files changed, 198 insertions(+) create mode 100644 docs-2.0/8.service-tuning/enable_autofdo_for_nebulagraph.md diff --git a/docs-2.0/8.service-tuning/enable_autofdo_for_nebulagraph.md b/docs-2.0/8.service-tuning/enable_autofdo_for_nebulagraph.md new file mode 100644 index 00000000000..96dbaffdf7e --- /dev/null +++ b/docs-2.0/8.service-tuning/enable_autofdo_for_nebulagraph.md @@ -0,0 +1,197 @@ +# 启用 AutoFDO + +AutoFDO 可以对优化过的程序进行性能分析，并使用性能信息来指导编译器再次优化程序。本文将帮助您为 NebulaGraph 启用AutoFDO。 + +关于 AutoFDO 的更多信息，请参见 [AutoFDO Wiki](https://gcc.gnu.org/wiki/AutoFDO)。 + +## 准备资源 + +### 安装依赖 + +- 安装 perf + + ```bash + sudo apt-get update + sudo apt-get install -y linux-tools-common \ + linux-tools-generic \ + linux-tools-`uname -r` + ``` + +- 安装 autofdo tool + + ```bash + sudo apt-get update + sudo apt-get install -y autofdo + ``` + + 或者你可以从[源代码](https://github.com/google/autofdo.git)编译 **autofdo tool**。 + +### 编译 NebulaGraph 二进制文件 + +关于如何从源码编译 NebulaGraph，请参考[使用源码安装 NebulaGraph](../4.deployment-and-installation/2.compile-and-install-nebula-graph/1.install-nebula-graph-by-compiling-the-source-code.md)。 + +在配置步骤中，将`CMAKE_BUILD_TYPE=Release`替换为`CMAKE_BUILD_TYPE=RelWithDebInfo`： + +```bash +$ cmake -DCMAKE_INSTALL_PREFIX=/usr/local/nebula -DENABLE_TESTING=OFF -DCMAKE_BUILD_TYPE=RelWithDebInfo .. +``` + +## 准备测试数据 + +在测试环境中，我们使用 [NebulaGraph Bench](https://github.com/nebula-contrib/NebulaGraph-Bench) 来准备测试数据，并通过运行 **FindShortestPath**、**Go1Step**、**Go2Step**、**Go3Step**、**InsertPersonScenario** 这5个场景脚本来收集性能数据。 + +!!! note + + 可以在生产环境中使用 **TopN** 查询来收集性能数据，在你的环境中可以提高更多性能。 + +## 准备性能数据 + +### 收集 AutoFDO 工具的性能数据 + +1. 测试数据准备完成后，收集不同场景的性能数据。首先获取 `storaged`、`graphd`、`metad`的`pid`。 + + ```bash + $ nebula.service status all + [INFO] nebula-metad: Running as 305422, Listening on 9559 + [INFO] nebula-graphd: Running as 305516, Listening on 9669 + [INFO] nebula-storaged: Running as 305707, Listening on 9779 + ``` + +2. 为`nebula-graphd`和`nebula-storaged`启动`perf record`。 + + ```bash + perf record -p 305516,305707 -b -e br_inst_retired.near_taken:pp -o ~/FindShortestPath.data + ``` + + !!! note + + 因为与`nebula-graphd`和`nebula-storaged`相比，`nebula-metad`的贡献率很小。为了减少工作量，我们没有收集 `nebula-metad` 的性能数据。 + +3. 启动 **FindShortestPath** 场景的基准测试。 + + ```bash + cd NebulaGraph-Bench + python3 run.py stress run -s benchmark -scenario find_path.FindShortestPath -a localhost:9669 --args='-u 100 -i 100000' + ``` + +4. 测试完成后，按 **Ctrl + C** 结束`perf record`。 + +5. 重复上述步骤为 **Go1Step**、**Go2Step**、**Go3Step**、**InsertPersonScenario** 这4个场景收集性能数据。 + +### 创建 Gcov 文件 + +```bash +create_gcov --binary=$NEBULA_HOME/bin/nebula-storaged \ +--profile=~/FindShortestPath.data \ +--gcov=~/FindShortestPath-storaged.gcov \ +-gcov_version=1 + +create_gcov --binary=$NEBULA_HOME/bin/nebula-graphd \ +--profile=~/FindShortestPath.data \ +--gcov=~/FindShortestPath-graphd.gcov \ +-gcov_version=1 +``` + +按照上面 **FindShortestPath** 的例子，为 **Go1Step**、**Go2Step**、**Go3Step**、**InsertPersonScenario** 这4个场景也创建 Gcov 文件。 + +### 合并性能数据 + +```bash +profile_merger ~/FindShortestPath-graphd.gcov \ +~/FindShortestPath-storaged.gcov \ +~/go1step-storaged.gcov \ +~/go1step-graphd.gcov \ +~/go2step-storaged.gcov \ +~/go2step-graphd.gcov \ +~/go3step-storaged.gcov \ +~/go3step-master-graphd.gcov \ +~/InsertPersonScenario-storaged.gcov \ +~/InsertPersonScenario-graphd.gcov +``` + +合并后的配置文件名称为`fbdata.afdo`。 + +## 使用合并的性能数据文件重新编译 NebulaGraph 二进制文件 + +使用编译选项`-fauto-profile`重新编译 NebulaGraph 二进制文件。 + +```diff +diff --git a/cmake/nebula/GeneralCompilerConfig.cmake b/cmake/nebula/GeneralCompilerConfig.cmake +@@ -20,6 +20,8 @@ add_compile_options(-Wshadow) + add_compile_options(-Wnon-virtual-dtor) + add_compile_options(-Woverloaded-virtual) + add_compile_options(-Wignored-qualifiers) ++add_compile_options(-fauto-profile=~/fbdata.afdo) +``` + +!!! note + + 当你使用多个`fbdata.afdo`多次编译时，请在重新编译之前执行`make clean`操作，因为只是修改`fbdata.afdo`不会触发重新编译。 + +## 性能测试结果 + +### 软硬件环境 + +|类型|环境| +|:---|:---| +|CPU Processor#|2| +|Sockets|2| +|NUMA|2| +|CPU Type|Intel(R) Xeon(R) Platinum 8380 CPU @ 2.30GHz| +|Cores per Processor|40C80T| +|Cache|L1 data: 48KB L1 i: 32KB L2: 1.25MB per physical core L3: shared 60MB per processor| +|Memory|Micron DDR4 3200MT/s 16GB*16Micron DDR4 3200MT/s 16GB*16| +|SSD Disk|INTEL SSDPE2KE016T8| +|SSD R/W Sequential|3200 MB/s (read) / 2100 MB/s(write)| +|Nebula Version|master with commit id 51d84a4ed7d2a032a337e3b996c927e3bc5d1415| +|Kernel|4.18.0-408.el8.x86_64| + +### 测试结果 + +|场景|Average Latency(LiB)|Default Binary|Optimized Binary with AutoFDO|P95 Latency (LiB)|Default Binary|Optimized Binary with AutoFDO| +|:---|:---:|:---:|:---:|:---:|:---:|---:| +|***FindShortestPath***|**1**|8072.52|7260.10|**1**|22102.00|19108.00| +||**2**|8034.32|7218.59|**2**|22060.85|19006.00| +||**3**|8079.27|7257.24|**3**|22147.00|19053.00| +||**4**|8087.66|7221.39|**4**|22143.00|19050.00| +||**5**|8044.77|7239.85|**5**|22181.00|19055.00| +||**STDDEVP**|20.57|17.34|**STDDEVP**|41.41|32.36| +||**Mean**|8063.71|7239.43|**Mean**|22126.77|19054.40| +||**STDDEVP/Mean**|0.26%|0.24%|**STDDEVP/Mean**|0.19%|0.17%| +||**Opt/Default**|100.00%|***10.22%***|**Opt/Default**|100.00%|***13.89%***| +|***Go1Step***|**1**|422.53|418.37|**1**|838.00|850.00| +||**2**|432.37|402.44|**2**|866.00|815.00| +||**3**|437.45|407.98|**3**|874.00|836.00| +||**4**|429.16|408.38|**4**|858.00|838.00| +||**5**|446.38|411.32|**5**|901.00|837.00| +||**STDDEVP**|8.02|5.20|**STDDEVP**|20.63|11.30| +||**Mean**|433.58|409.70|**Mean**|867.40|835.20| +||**STDDEVP/Mean**|1.85%|1.27%|**STDDEVP/Mean**|2.38%|1.35%| +||**Opt/Default**|100.00%|***5.51%***|**Opt/Default**|100.00%|***3.71%***| +|***Go2Step***|**1**|2989.93|2824.29|**1**|10202.00|9656.95| +||**2**|2957.22|2834.55|**2**|10129.00|9632.40| +||**3**|2962.74|2818.62|**3**|10168.40|9624.70| +||**4**|2992.39|2817.27|**4**|10285.10|9647.50| +||**5**|2934.85|2834.91|**5**|10025.00|9699.65| +||**STDDEVP**|21.53|7.57|**STDDEVP**|85.62|26.25| +||**Mean**|2967.43|2825.93|**Mean**|10161.90|9652.24| +||**STDDEVP/Mean**|0.73%|0.27%|**STDDEVP/Mean**|0.84%|0.27%| +||**Opt/Default**|100.00%|***4.77%***|**Opt/Default**|100.00%|***5.02%***| +|***Go3Step***|**1**|93551.97|89406.96|**1**|371359.55|345433.50| +||**2**|92418.43|89977.25|**2**|368868.00|352375.20| +||**3**|92587.67|90339.25|**3**|365390.15|356198.55| +||**4**|93371.64|92458.95|**4**|373578.15|365177.75| +||**5**|94046.05|89943.44|**5**|373392.25|352576.00| +||**STDDEVP**|609.07|1059.54|**STDDEVP**|3077.38|6437.52| +||**Mean**|93195.15|90425.17|**Mean**|370517.62|354352.20| +||**STDDEVP/Mean**|0.65%|1.17%|**STDDEVP/Mean**|0.83%|1.82%| +||**Opt/Default**|100.00%|***2.97%***|**Opt/Default**|100.00%|***4.36%***| +|***InsertPerson***|**1**|2022.86|1937.36|**1**|2689.00|2633.45| +||**2**|1966.05|1935.41|**2**|2620.45|2555.00| +||**3**|1985.25|1953.58|**3**|2546.00|2593.00| +||**4**|2026.73|1887.28|**4**|2564.00|2394.00| +||**5**|2007.55|1964.41|**5**|2676.00|2581.00| +||**STDDEVP**|23.02|26.42|**STDDEVP**|57.45|82.62| +||**Mean**|2001.69|1935.61|**Mean**|2619.09|2551.29| +||**STDDEVP/Mean**|1.15%|1.37%|**STDDEVP/Mean**|2.19%|3.24%| +||**Opt/Default**|100.00%|***3.30%***|**Opt/Default**|100.00%|***2.59%***| diff --git a/mkdocs.yml b/mkdocs.yml index c0a4f623db5..2beaa624b03 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -526,6 +526,7 @@ nav: - 系统建模: 8.service-tuning/3.system-design.md - 执行计划: 8.service-tuning/4.plan.md - 超级节点(稠密点): 8.service-tuning/super-node.md + - 启用 AutoFDO: 8.service-tuning/enable_autofdo_for_nebulagraph.md - 实践案例: 8.service-tuning/practice.md From f51e72dcfcfd1ddaa649d5898787b9a8db4a7525 Mon Sep 17 00:00:00 2001 From: foesa <35463247+foesa-yang@users.noreply.github.com> Date: Mon, 20 Feb 2023 17:56:21 +0800 Subject: [PATCH 047/137] Update README.md --- docs-2.0/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs-2.0/README.md b/docs-2.0/README.md index 9994e1143e5..d0acbf08178 100644 --- a/docs-2.0/README.md +++ b/docs-2.0/README.md @@ -19,7 +19,7 @@ NebulaGraph 是一款开源的、分布式的、易扩展的原生图数据库 * [NebulaGraph 3.4.0 内核及周边工具新发布](https://www.bilibili.com/video/BV12R4y1e7U7)（05 分 24 秒） - +![3.4.0发布](https://docs-cdn.nebula-graph.com.cn/figures/picture1.png) ## 快速开始 From 5976d79469e24facfa2f3a33812d31bc98535434 Mon Sep 17 00:00:00 2001 From: cooper-lzy <78672629+cooper-lzy@users.noreply.github.com> Date: Tue, 21 Feb 2023 09:46:42 +0800 Subject: [PATCH 048/137] update explorer api (#2600) --- .../workflow/workflow-api/workflow-api-overview.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs-2.0/nebula-explorer/workflow/workflow-api/workflow-api-overview.md b/docs-2.0/nebula-explorer/workflow/workflow-api/workflow-api-overview.md index 5a46893a525..cf9aaadaa11 100644 --- a/docs-2.0/nebula-explorer/workflow/workflow-api/workflow-api-overview.md +++ b/docs-2.0/nebula-explorer/workflow/workflow-api/workflow-api-overview.md @@ -39,7 +39,7 @@ curl http://:/?{} curl -i -X POST -H "Content-Type: application/json" -H "Authorization: Bearer " -d '{"address":"","port":}' http://:/api-open/v1/connect ``` -- ``：Base64 编码后的 NebulaGraph 账号和密码。编码前格式为`账号:密码`，下文示例为`root:123`，编码后为`cm9vdDoxMjM=`。 +- ``：Base64 编码后的 NebulaGraph 账号和密码。编码前格式为 `JSON.stringify([用户名, 密码])`。以用户名`root`、密码`123`为例，`JSON.stringify`函数处理后的字符串为`["root","123"]`，Base64 编码后为`WyJyb290IiwiMTIzIl0=`。 - ``：NebulaGraph 访问地址。 - ``：NebulaGraph 访问端口。 - ``：NebulaGraph Explorer 访问地址。 @@ -48,7 +48,7 @@ curl -i -X POST -H "Content-Type: application/json" -H "Authorization: Bearer Date: Tue, 21 Feb 2023 10:03:59 +0800 Subject: [PATCH 049/137] Update README.md --- docs-2.0/README.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/docs-2.0/README.md b/docs-2.0/README.md index d0acbf08178..715caa42476 100644 --- a/docs-2.0/README.md +++ b/docs-2.0/README.md @@ -17,9 +17,7 @@ NebulaGraph 是一款开源的、分布式的、易扩展的原生图数据库，能够承载数千亿个点和数万亿条边的超大规模数据集，并且提供毫秒级查询。 --> -* [NebulaGraph 3.4.0 内核及周边工具新发布](https://www.bilibili.com/video/BV12R4y1e7U7)（05 分 24 秒） - -![3.4.0发布](https://docs-cdn.nebula-graph.com.cn/figures/picture1.png) +3.4.0发布 ## 快速开始 From 8e795c4a28e715f5354ec4c5c997e3d47021efa4 Mon Sep 17 00:00:00 2001 From: "abby.huang" <78209557+abby-cyber@users.noreply.github.com> Date: Tue, 21 Feb 2023 17:02:42 +0800 Subject: [PATCH 050/137] delete the note that yield is optional (#2603) --- docs-2.0/3.ngql-guide/5.operators/4.pipe.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/docs-2.0/3.ngql-guide/5.operators/4.pipe.md b/docs-2.0/3.ngql-guide/5.operators/4.pipe.md index 5071514fb7d..a7f36628911 100644 --- a/docs-2.0/3.ngql-guide/5.operators/4.pipe.md +++ b/docs-2.0/3.ngql-guide/5.operators/4.pipe.md @@ -31,8 +31,6 @@ nebula> GO FROM "player100" OVER follow \ +-------------+ ``` -用户可以使用`YIELD`显式声明需要返回的结果，如果不使用`YIELD`，默认返回目标点 ID。 - 必须在`YIELD`子句中为需要的返回结果设置别名，才能在管道符右侧使用引用符`$-`，例如示例中的`$-.dstid`。 ## 性能提示 From 8338f513ae9ac74a88128b9f0a71bbbd39dafeae Mon Sep 17 00:00:00 2001 From: cooper-lzy <78672629+cooper-lzy@users.noreply.github.com> Date: Wed, 22 Feb 2023 16:37:54 +0800 Subject: [PATCH 051/137] Update workflow-api-overview.md (#2605) * Update workflow-api-overview.md * Update workflow-api-overview.md --- .../workflow/workflow-api/workflow-api-overview.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs-2.0/nebula-explorer/workflow/workflow-api/workflow-api-overview.md b/docs-2.0/nebula-explorer/workflow/workflow-api/workflow-api-overview.md index cf9aaadaa11..901e05f7600 100644 --- a/docs-2.0/nebula-explorer/workflow/workflow-api/workflow-api-overview.md +++ b/docs-2.0/nebula-explorer/workflow/workflow-api/workflow-api-overview.md @@ -39,7 +39,7 @@ curl http://:/?{} curl -i -X POST -H "Content-Type: application/json" -H "Authorization: Bearer " -d '{"address":"","port":}' http://:/api-open/v1/connect ``` -- ``：Base64 编码后的 NebulaGraph 账号和密码。编码前格式为 `JSON.stringify([用户名, 密码])`。以用户名`root`、密码`123`为例，`JSON.stringify`函数处理后的字符串为`["root","123"]`，Base64 编码后为`WyJyb290IiwiMTIzIl0=`。 +- ``：Base64 编码后的 NebulaGraph 账号和密码字符串。以用户名`root`、密码`123`为例，序列化后的字符串为`["root","123"]`，Base64 编码后为`WyJyb290IiwiMTIzIl0=`。 - ``：NebulaGraph 访问地址。 - ``：NebulaGraph 访问端口。 - ``：NebulaGraph Explorer 访问地址。 From d4a715dd6c845c790902cf5b9e3e0b5a4a840cce Mon Sep 17 00:00:00 2001 From: foesa <35463247+foesa-yang@users.noreply.github.com> Date: Thu, 23 Feb 2023 13:56:37 +0800 Subject: [PATCH 052/137] Update config-with-header.md --- docs-2.0/nebula-importer/config-with-header.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs-2.0/nebula-importer/config-with-header.md b/docs-2.0/nebula-importer/config-with-header.md index af41480b354..8c4a7a1d103 100644 --- a/docs-2.0/nebula-importer/config-with-header.md +++ b/docs-2.0/nebula-importer/config-with-header.md @@ -75,8 +75,7 @@ ## 配置示例 ```yaml -# 连接的 NebulaGraph 版本，连接 3.x 时设置为 v3。 -version: v3 +version: v2 description: example From dcba3cbb9d194e45c055f112e2bd40dc2abeeca2 Mon Sep 17 00:00:00 2001 From: foesa <35463247+foesa-yang@users.noreply.github.com> Date: Thu, 23 Feb 2023 13:57:02 +0800 Subject: [PATCH 053/137] Update config-without-header.md --- docs-2.0/nebula-importer/config-without-header.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs-2.0/nebula-importer/config-without-header.md b/docs-2.0/nebula-importer/config-without-header.md index cc93446c281..b82f4459956 100644 --- a/docs-2.0/nebula-importer/config-without-header.md +++ b/docs-2.0/nebula-importer/config-without-header.md @@ -34,8 +34,7 @@ ## 配置示例 ```yaml -# 连接的 NebulaGraph 版本，连接 3.x 时设置为 v3。 -version: v3 +version: v2 description: example From a992accc216988f99686f1c8a68698fcc71efa82 Mon Sep 17 00:00:00 2001 From: randomJoe211 <69501902+randomJoe211@users.noreply.github.com> Date: Thu, 23 Feb 2023 15:31:47 +0800 Subject: [PATCH 054/137] Enable algolia search for 3.4.0 (#2610) --- mkdocs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/mkdocs.yml b/mkdocs.yml index 2beaa624b03..2d07f7b9d4c 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -64,7 +64,7 @@ markdown_extensions: # Plugins plugins: - - search # 这个是原有的 mkdocs 搜索插件， 如果想使用algolia搜索，请注释掉这个插件 +# - search # 这个是原有的 mkdocs 搜索插件， 如果想使用algolia搜索，请注释掉这个插件 - macros: include_dir: docs-2.0/reuse/ - git-revision-date-localized From b03baf50354b352d16169122a9065213287bb496 Mon Sep 17 00:00:00 2001 From: "abby.huang" <78209557+abby-cyber@users.noreply.github.com> Date: Fri, 24 Feb 2023 10:06:51 +0800 Subject: [PATCH 055/137] Update 4.storage-config.md (#2612) --- .../1.configurations/4.storage-config.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs-2.0/5.configurations-and-logs/1.configurations/4.storage-config.md b/docs-2.0/5.configurations-and-logs/1.configurations/4.storage-config.md index a7edddac966..cc27fe64c60 100644 --- a/docs-2.0/5.configurations-and-logs/1.configurations/4.storage-config.md +++ b/docs-2.0/5.configurations-and-logs/1.configurations/4.storage-config.md @@ -55,7 +55,7 @@ Storage 服务提供了两份初始配置文件`nebula-storaged.conf.default`和 | :----------------------- | :---------------- | :---------------------------------------------------- | | `meta_server_addrs` | `127.0.0.1:9559` | 全部 Meta 服务的 IP 地址和端口。多个 Meta 服务用英文逗号（,）分隔。 | |`local_ip` | `127.0.0.1` | Storage 服务的本地 IP 地址。本地 IP 地址用于识别 nebula-storaged 进程，如果是分布式集群或需要远程访问，请修改为对应地址。| -| `port` | `9779` | Storage 服务的 RPC 守护进程监听端口。Storage 服务对外端口为`9779`，对内端口为`9777`、`9778`和`9780`，NebulaGraph 使用内部端口进行多副本间的交互。 | +| `port` | `9779` | Storage 服务的 RPC 守护进程监听端口。Storage 服务对外端口为`9779`，对内端口为`9777`、`9778`和`9780`，NebulaGraph 使用内部端口进行多副本间的交互。
`9777`：drainer 服务占用端口，仅在企业版集群中暴露；`9778`：Admin 服务（Storage 接收 Meta 命令的服务）占用的端口；`9780`：Raft 通信端口。| | `ws_ip` | `0.0.0.0` | HTTP 服务的 IP 地址。 | | `ws_http_port` | `19779` | HTTP 服务的端口。 | |`heartbeat_interval_secs` | `10` | 默认心跳间隔。请确保所有服务的`heartbeat_interval_secs`取值相同，否则会导致系统无法正常工作。单位：秒。 | From b42ca97a8bf83e4e354d2dd238b5a24b49b229e1 Mon Sep 17 00:00:00 2001 From: cooper-lzy <78672629+cooper-lzy@users.noreply.github.com> Date: Mon, 27 Feb 2023 09:28:27 +0800 Subject: [PATCH 056/137] Update mkdocs.yml --- mkdocs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/mkdocs.yml b/mkdocs.yml index 2d07f7b9d4c..bdf0c614b45 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -141,7 +141,7 @@ extra: # Google Analytics. analytics: provider: google - property: UA-60523578-7 + property: UA-60523578-15 # branch represents code names (git clone). release represents version number used in texts. version: method: mike From 0025533aa100ea6d98a463889b2a0c4bd3cd1889 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Tue, 28 Feb 2023 10:44:45 +0800 Subject: [PATCH 057/137] Add docker desktop (#2615) (#2617) * Add docker desktop * Update 1.quick-start-overview.md * Update 1.quick-start-overview.md * Update docs-2.0/2.quick-start/1.quick-start-overview.md * Update 1.quick-start-overview.md * Update 1.quick-start-overview.md * Update 1.quick-start-overview.md --------- Co-authored-by: foesa <35463247+foesa-yang@users.noreply.github.com> Co-authored-by: abby.huang <78209557+abby-cyber@users.noreply.github.com> --- .../2.quick-start/1.quick-start-overview.md | 25 ++++++++++++++++++- 1 file changed, 24 insertions(+), 1 deletion(-) diff --git a/docs-2.0/2.quick-start/1.quick-start-overview.md b/docs-2.0/2.quick-start/1.quick-start-overview.md index 98188832fcd..bc72c14a7c4 100644 --- a/docs-2.0/2.quick-start/1.quick-start-overview.md +++ b/docs-2.0/2.quick-start/1.quick-start-overview.md @@ -1,6 +1,29 @@ # 快速入门概览 -用户可通过云及本地两种部署方式快速入门 NebulaGraph。快速入门将介绍如何通过云和本地两种部署方式简单地使用 NebulaGraph，包括部署、连接 NebulaGraph，以及基础的增删改查操作。 +用户可通过 Docker Desktop、云、本地三种部署方式快速入门 NebulaGraph。快速入门将介绍如何通过 Docker Desktop、云、本地三种部署方式简单地使用 NebulaGraph，包括部署、连接 NebulaGraph，以及基础的增删改查操作。 + +## 使用 Docker Desktop 一键部署 + +按照以下步骤可以快速在 Docker Desktop 中部署 NebulaGraph。 + +1. 安装 [Docker Desktop](https://www.docker.com/products/docker-desktop/)。 + + !!! caution + + 如果在 Windows 端安装 Docker Desktop 需[安装 WSL 2](https://docs.docker.com/desktop/install/windows-install/)。 + +2. 在仪表盘中单击`Extensions`或`Add Extensions`打开Extensions Marketplace 搜索 NebulaGraph ，也可以点击 [NebulaGraph](https://hub.docker.com/extensions/weygu/nebulagraph-dd-ext) 在 Docker Desktop 打开。 +3. 导航到 NebulaGraph 的扩展市场。 +4. 点击`Install`下载 NebulaGraph。 + + ![docker](https://docs-cdn.nebula-graph.com.cn/figures/docker.png) + +5. 可以点击`Update`快速更新新版本。 + + ![docker-update](https://docs-cdn.nebula-graph.com.cn/figures/docker-update.png) + + + ## 云上部署 From 4abb32e19c05326ee8a30f35e0850d017debc05f Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Tue, 28 Feb 2023 10:46:30 +0800 Subject: [PATCH 058/137] fix bilibili video iframe (#2618) Co-authored-by: Wey Gu --- docs-2.0/2.quick-start/1.quick-start-overview.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/docs-2.0/2.quick-start/1.quick-start-overview.md b/docs-2.0/2.quick-start/1.quick-start-overview.md index bc72c14a7c4..0df2ae90f49 100644 --- a/docs-2.0/2.quick-start/1.quick-start-overview.md +++ b/docs-2.0/2.quick-start/1.quick-start-overview.md @@ -18,12 +18,14 @@ ![docker](https://docs-cdn.nebula-graph.com.cn/figures/docker.png) -5. 可以点击`Update`快速更新新版本。 +5. 在有 NebulaGraph 更新的时候，可以点击`Update`更新到最新版本。 ![docker-update](https://docs-cdn.nebula-graph.com.cn/figures/docker-update.png) +视频介绍 + + - ## 云上部署 From b61d1b6c7f6f02e1c18a54eadb880a61e4a5dd6b Mon Sep 17 00:00:00 2001 From: randomJoe211 <69501902+randomJoe211@users.noreply.github.com> Date: Tue, 28 Feb 2023 11:01:10 +0800 Subject: [PATCH 059/137] Update pricing note (#2619) --- .../nebula-cloud-on-alibabacloud/1.create-service-instance.md | 4 ---- 1 file changed, 4 deletions(-) diff --git a/docs-2.0/nebula-cloud/nebula-cloud-on-alibabacloud/1.create-service-instance.md b/docs-2.0/nebula-cloud/nebula-cloud-on-alibabacloud/1.create-service-instance.md index 55ac76dd57f..7f02f8f6e82 100644 --- a/docs-2.0/nebula-cloud/nebula-cloud-on-alibabacloud/1.create-service-instance.md +++ b/docs-2.0/nebula-cloud/nebula-cloud-on-alibabacloud/1.create-service-instance.md @@ -60,10 +60,6 @@ NebulaGraph Cloud 阿里云版支持如下套餐版本。 3. 选择**套餐版本**和**购买时长**（即 NebulaGraph 服务的许可证有效期），并单击**立即购买**。 - !!! caution - - 当前云市场显示的部分价格并非实际售价，购买时需通过右侧的钉钉客服确认实际价格。 - 4. 在**创建服务实例**页，保持**选择模板**处的选择不变。如需切换部署架构，可改变选中的选项，重新选择模板。 !!! note From f69a12b747e80b3fd89e3944b8c6e7a950287c06 Mon Sep 17 00:00:00 2001 From: "abby.huang" <78209557+abby-cyber@users.noreply.github.com> Date: Tue, 28 Feb 2023 11:17:44 +0800 Subject: [PATCH 060/137] dynamic-changes-to-configs (#2613) * dynamic-changes-to-configs * add des that whether to support dynamic changes * Update 1.configurations.md * Update 1.configurations.md * Update 3.graph-config.md * Update 1.configurations.md --- .../1.configurations/1.configurations.md | 25 +++ .../1.configurations/2.meta-config.md | 92 +++++----- .../1.configurations/3.graph-config.md | 161 +++++++++--------- .../1.configurations/4.storage-config.md | 160 ++++++++--------- 4 files changed, 237 insertions(+), 201 deletions(-) diff --git a/docs-2.0/5.configurations-and-logs/1.configurations/1.configurations.md b/docs-2.0/5.configurations-and-logs/1.configurations/1.configurations.md index b124db55c06..08ace1f7558 100644 --- a/docs-2.0/5.configurations-and-logs/1.configurations/1.configurations.md +++ b/docs-2.0/5.configurations-and-logs/1.configurations/1.configurations.md @@ -77,6 +77,7 @@ NebulaGraph 为每个服务都提供了两份初始配置文件`.c 初始配置文件中的配置值仅供参考，使用时可根据实际需求调整。如需使用初始配置文件，从上述两个文件选择其一，删除后缀`.default`或`.production`使其生效。 !!! caution + 为确保服务的可用性，同类服务的配置需保持一致，本机 IP 地址`local_ip`除外。例如，一个 NebulaGraph 集群中部署了 3 个 Storage 服务器，3 者除 IP 地址外的其它配置需相同。 下表列出了各服务对应的初始配置文件。 @@ -90,6 +91,7 @@ NebulaGraph 为每个服务都提供了两份初始配置文件`.c 所有服务的初始配置文件中都包含`local_config`参数，预设值为`true`，表示 NebulaGraph 服务会从其配置文件获取配置并启动。 !!! caution + 不建议修改`local_config`的值为`false`。修改后 NebulaGraph 服务启动后会先尝试从 Meta 服务获取缓存的配置信息，可能导致集群配置不一致，造成未知风险。 ### Docker Compose 集群的配置文件 @@ -108,6 +110,14 @@ NebulaGraph 为每个服务都提供了两份初始配置文件`.c ## 修改配置 +用户可以在配置文件中修改 NebulaGraph 的配置，或使用命令动态修改配置。 + +!!! caution + + 同时使用两种方式修改配置会导致配置信息失去统一的管理方式，可能造成配置混乱。建议仅使用配置文件管理配置，或在通过命令动态更新配置后对配置文件做相同的修改，以保证一致性。 + +### 在配置文件中修改配置 + 默认情况下，所有 NebulaGraph 服务从配置文件获取配置。用户可以按照以下步骤修改配置并使其生效。 * 针对使用源码、RPM/DEB、TAR 包安装的集群： @@ -124,3 +134,18 @@ NebulaGraph 为每个服务都提供了两份初始配置文件`.c * 针对使用 Kubectl 方式创建的集群： 具体操作，参见[自定义集群的配置参数](../../nebula-operator/8.custom-cluster-configurations/8.1.custom-conf-parameter.md)。 + +### 使用命令动态修改配置 + +用户可以通过`curl`命令动态修改 NebulaGraph 服务的配置。例如，修改 Storage 服务的`wal_ttl`参数为`600`，命令如下： + +```bash +curl -X PUT -H "Content-Type: application/json" -d'{"wal_ttl":"600"}' -s "http://192.168.15.6:19779/flags" +``` + +其中，`{"wal_ttl":"600"}`为待修改的配置参数及其值；`192.168.15.6:19779`为 Storage 服务的 IP 地址和 HTTP 端口号。 + +!!! caution + + - 动态修改配置功能仅适用于原型验证和测试环境，不建议在生产环境中使用。因为当`local_config`值设置为`true`时，动态修改的配置不会持久化，重启服务后配置会恢复为初始配置。 + - 仅支持动态修改**部分**配置参数，具体支持的参数列表，参见各服务配置中**是否支持运行时动态修改**的描述。 diff --git a/docs-2.0/5.configurations-and-logs/1.configurations/2.meta-config.md b/docs-2.0/5.configurations-and-logs/1.configurations/2.meta-config.md index cf51409dd1b..13f493f3d98 100644 --- a/docs-2.0/5.configurations-and-logs/1.configurations/2.meta-config.md +++ b/docs-2.0/5.configurations-and-logs/1.configurations/2.meta-config.md @@ -15,21 +15,25 @@ Meta 服务提供了两份初始配置文件`nebula-metad.conf.default`和`nebul 配置文件内没有设置某个参数表示参数使用的是默认值。文件内只预设了部分参数的值，而且两份初始配置文件内的参数值也略有不同，本文的预设值以`nebula-metad.conf.default`为准。 +!!! caution + + 配置文件中的部分参数值可以在运行时动态修改。本文将这些参数标记为支持运行时动态修改，并当`local_config`值设置为`true`时重启服务后配置会恢复为初始配置。详情参见[修改配置](1.configurations.md)。 + 如需查看所有的参数及其当前值，参见[配置管理](1.configurations.md)。 ## basics 配置 -| 名称 | 预设值 | 说明 | -| :----------- | :----------------------- | :------------------| -| `daemonize` | `true` | 是否启动守护进程。 | -| `pid_file` | `pids/nebula-metad.pid` | 记录进程 ID 的文件。 | -| `timezone_name` | - | 指定 NebulaGraph 的时区。初始配置文件中未设置该参数，如需使用请手动添加。系统默认值为`UTC+00:00:00`。格式请参见 [Specifying the Time Zone with TZ](https://www.gnu.org/software/libc/manual/html_node/TZ-Variable.html "Click to view the timezone-related content in the GNU C Library manual")。例如，东八区的设置方式为`--timezone_name=UTC+08:00`。 | +| 名称 | 预设值 | 说明 |是否支持运行时动态修改| +| :----------- | :----------------------- | :------------------|:------------------| +| `daemonize` | `true` | 是否启动守护进程。 |不支持| +| `pid_file` | `pids/nebula-metad.pid` | 记录进程 ID 的文件。 |不支持| +| `timezone_name` | - | 指定 NebulaGraph 的时区。初始配置文件中未设置该参数，如需使用请手动添加。系统默认值为`UTC+00:00:00`。格式请参见 [Specifying the Time Zone with TZ](https://www.gnu.org/software/libc/manual/html_node/TZ-Variable.html "Click to view the timezone-related content in the GNU C Library manual")。例如，东八区的设置方式为`--timezone_name=UTC+08:00`。 |不支持| {{ ent.ent_begin }} -| 名称 | 预设值 | 说明 | -| :----------- | :----------------------- | :------------------| -|`license_path`|`share/resources/nebula.license`|企业版 License 路径。企业版需要用户[设置 License](../../4.deployment-and-installation/deploy-license.md) 才可以正常启动并使用企业版功能。仅企业版 NebulaGraph 需要设置本参数，其他周边工具如何设置 License，请参见相应周边工具的部署文档。| +| 名称 | 预设值 | 说明 |是否支持运行时动态修改| +| :----------- | :----------------------- | :------------------|:------------------| +|`license_path`|`share/resources/nebula.license`|企业版 License 路径。企业版需要用户[设置 License](../../4.deployment-and-installation/deploy-license.md) 才可以正常启动并使用企业版功能。仅企业版 NebulaGraph 需要设置本参数，其他周边工具如何设置 License，请参见相应周边工具的部署文档。|不支持| {{ ent.ent_end }} @@ -40,29 +44,29 @@ Meta 服务提供了两份初始配置文件`nebula-metad.conf.default`和`nebul ## logging 配置 -| 名称 | 预设值 | 说明 | -| :------------- | :------------------------ | :------------------------------------------------ | -| `log_dir` | `logs` | 存放 Meta 服务日志的目录，建议和数据保存在不同硬盘。 | -| `minloglevel` | `0` | 最小日志级别，即记录此级别或更高级别的日志。可选值为`0`（INFO）、`1`（WARNING）、`2`（ERROR）、`3`（FATAL）。建议在调试时设置为`0`，生产环境中设置为`1`。如果设置为`4`，NebulaGraph 不会记录任何日志。 | -| `v` | `0` | VLOG 日志详细级别，即记录小于或等于此级别的所有 VLOG 消息。可选值为`0`、`1`、`2`、`3`、`4`、`5`。glog 提供的 VLOG 宏允许用户定义自己的数字日志记录级别，并用参数`v`控制记录哪些详细消息。详情参见 [Verbose Logging](https://github.com/google/glog#verbose-logging)。 | -| `logbufsecs` | `0` | 缓冲日志的最大时间，超时后输出到日志文件。`0`表示实时输出。单位：秒。 | -|`redirect_stdout`|`true` |是否将标准输出和标准错误重定向到单独的输出文件。 | -|`stdout_log_file` |`metad-stdout.log` | 标准输出日志文件名称。 | -|`stderr_log_file` |`metad-stderr.log` | 标准错误日志文件名称。 | -|`stderrthreshold` | `3` | 要复制到标准错误中的最小日志级别（`minloglevel`）。 | -| `timestamp_in_logfile_name` | `true` | 日志文件名称中是否包含时间戳。`true`表示包含，`false`表示不包含。 | +| 名称 | 预设值 | 说明 |是否支持运行时动态修改| +| :------------- | :------------------------ | :------------------------------------------------ |:------------------| +| `log_dir` | `logs` | 存放 Meta 服务日志的目录，建议和数据保存在不同硬盘。 |不支持| +| `minloglevel` | `0` | 最小日志级别，即记录此级别或更高级别的日志。可选值为`0`（INFO）、`1`（WARNING）、`2`（ERROR）、`3`（FATAL）。建议在调试时设置为`0`，生产环境中设置为`1`。如果设置为`4`，NebulaGraph 不会记录任何日志。 |支持| +| `v` | `0` | VLOG 日志详细级别，即记录小于或等于此级别的所有 VLOG 消息。可选值为`0`、`1`、`2`、`3`、`4`、`5`。glog 提供的 VLOG 宏允许用户定义自己的数字日志记录级别，并用参数`v`控制记录哪些详细消息。详情参见 [Verbose Logging](https://github.com/google/glog#verbose-logging)。 |支持| +| `logbufsecs` | `0` | 缓冲日志的最大时间，超时后输出到日志文件。`0`表示实时输出。单位：秒。 |不支持| +|`redirect_stdout`|`true` |是否将标准输出和标准错误重定向到单独的输出文件。 |不支持| +|`stdout_log_file` |`metad-stdout.log` | 标准输出日志文件名称。 |不支持| +|`stderr_log_file` |`metad-stderr.log` | 标准错误日志文件名称。 |不支持| +|`stderrthreshold` | `3` | 要复制到标准错误中的最小日志级别（`minloglevel`）。 |不支持| +| `timestamp_in_logfile_name` | `true` | 日志文件名称中是否包含时间戳。`true`表示包含，`false`表示不包含。 |不支持| ## networking 配置 -| 名称 | 预设值 | 说明 | -| :----------------------- | :---------------- | :---------------------------------------------------- | -| `meta_server_addrs` | `127.0.0.1:9559` | 全部 Meta 服务的 IP 地址和端口。多个 Meta 服务用英文逗号（,）分隔。 | -|`local_ip` | `127.0.0.1` | Meta 服务的本地 IP 地址。本地 IP 地址用于识别 nebula-metad 进程，如果是分布式集群或需要远程访问，请修改为对应地址。| -| `port` | `9559` | Meta 服务的 RPC 守护进程监听端口。Meta 服务对外端口为`9559`，对内端口为`对外端口+1`，即`9560`，NebulaGraph 使用内部端口进行多副本间的交互。 | -| `ws_ip` | `0.0.0.0` | HTTP 服务的 IP 地址。 | -| `ws_http_port` | `19559` | HTTP 服务的端口。 | -|`ws_storage_http_port`|`19779`| HTTP 协议监听 Storage 服务的端口，需要和 Storage 服务配置文件中的`ws_http_port`保持一致。仅存算合并版 NebulaGraph 需要设置本参数。| -|`heartbeat_interval_secs` | `10` | 默认心跳间隔。请确保所有服务的`heartbeat_interval_secs`取值相同，否则会导致系统无法正常工作。单位：秒。 | +| 名称 | 预设值 | 说明 |是否支持运行时动态修改| +| :----------------------- | :---------------- | :---------------------------- |:------------------| +| `meta_server_addrs` | `127.0.0.1:9559` | 全部 Meta 服务的 IP 地址和端口。多个 Meta 服务用英文逗号（,）分隔。 |不支持| +|`local_ip` | `127.0.0.1` | Meta 服务的本地 IP 地址。本地 IP 地址用于识别 nebula-metad 进程，如果是分布式集群或需要远程访问，请修改为对应地址。|不支持| +| `port` | `9559` | Meta 服务的 RPC 守护进程监听端口。Meta 服务对外端口为`9559`，对内端口为`对外端口+1`，即`9560`，NebulaGraph 使用内部端口进行多副本间的交互。 |不支持| +| `ws_ip` | `0.0.0.0` | HTTP 服务的 IP 地址。 |不支持| +| `ws_http_port` | `19559` | HTTP 服务的端口。 |不支持| +|`ws_storage_http_port`|`19779`| HTTP 协议监听 Storage 服务的端口，需要和 Storage 服务配置文件中的`ws_http_port`保持一致。仅存算合并版 NebulaGraph 需要设置本参数。|不支持| +|`heartbeat_interval_secs` | `10` | 默认心跳间隔。请确保所有服务的`heartbeat_interval_secs`取值相同，否则会导致系统无法正常工作。单位：秒。 |支持| !!! caution @@ -70,22 +74,22 @@ Meta 服务提供了两份初始配置文件`nebula-metad.conf.default`和`nebul ## storage 配置 -| 名称 | 预设值 | 说明 | -| :------------------- | :------------------------ | :------------------------------------------ | -|`data_path`|`data/meta`|meta 数据存储路径。| +| 名称 | 预设值 | 说明 |是否支持运行时动态修改| +| :------------------- | :------------------------ | :------------------------------------------ |:------------------| +|`data_path`|`data/meta`|meta 数据存储路径。|不支持| ## misc 配置 -| 名称 | 预设值 | 说明 | -| :------------------------- | :-------- | :------------------------ | -|`default_parts_num` | `100` | 创建图空间时的默认分片数量。 | -|`default_replica_factor` | `1` | 创建图空间时的默认副本数量。 | +| 名称 | 预设值 | 说明 |是否支持运行时动态修改| +| :------------------------- | :-------- | :------------------------ |:------------------| +|`default_parts_num` | `100` | 创建图空间时的默认分片数量。 |不支持| +|`default_replica_factor` | `1` | 创建图空间时的默认副本数量。 |不支持| ## rocksdb options 配置 -| 名称 | 预设值 | 说明 | -| :------------------- | :------------------------ | :------------------------------------------ | -|`rocksdb_wal_sync` |`true` |是否同步 RocksDB 的 WAL 日志。| +| 名称 | 预设值 | 说明 |是否支持运行时动态修改| +| :------------------- | :------------------------ | :------------------------------------------ |:------------------| +|`rocksdb_wal_sync` |`true` |是否同步 RocksDB 的 WAL 日志。|不支持| {{ ent.ent_begin }} @@ -95,11 +99,11 @@ Meta 服务提供了两份初始配置文件`nebula-metad.conf.default`和`nebul 仅企业版支持黑匣子功能配置。 -| 名称 | 预设值 | 说明 | -| :------------------- | :------------------------ | :------------------------------------------ | -|`ng_black_box_switch` |`true` |是否开启黑匣子功能。| -|`ng_black_box_home` |`black_box` |存储黑匣子数据的目录名称。| -|`ng_black_box_dump_period_seconds` |`5` |黑匣子采集指标的时间间隔。单位：秒。| -|`ng_black_box_file_lifetime_seconds` |`1800` |采集指标后生成文件的保存时间。单位：秒| +| 名称 | 预设值 | 说明 |是否支持运行时动态修改| +| :------------------- | :------------------------ | :--------------------------- |:------------------| +|`ng_black_box_switch` |`true` |是否开启黑匣子功能。|不支持| +|`ng_black_box_home` |`black_box` |存储黑匣子数据的目录名称。|不支持| +|`ng_black_box_dump_period_seconds` |`5` |黑匣子采集指标的时间间隔。单位：秒。|不支持| +|`ng_black_box_file_lifetime_seconds` |`1800` |采集指标后生成文件的保存时间。单位：秒|支持| {{ ent.ent_end }} \ No newline at end of file diff --git a/docs-2.0/5.configurations-and-logs/1.configurations/3.graph-config.md b/docs-2.0/5.configurations-and-logs/1.configurations/3.graph-config.md index 8a1836eb956..3fa2971c8ff 100644 --- a/docs-2.0/5.configurations-and-logs/1.configurations/3.graph-config.md +++ b/docs-2.0/5.configurations-and-logs/1.configurations/3.graph-config.md @@ -15,17 +15,20 @@ Graph 服务提供了两份初始配置文件`nebula-graphd.conf.default`和`neb 配置文件内没有设置某个参数表示参数使用的是默认值。文件内只预设了部分参数的值，而且两份初始配置文件内的参数值也略有不同，本文的预设值以`nebula-graphd.conf.default`为准。 +!!! caution + 配置文件中的部分参数值可以在运行时动态修改。本文将这些参数标记为支持运行时动态修改，并当`local_config`值设置为`true`时重启服务后配置会恢复为初始配置。详情参见[修改配置](1.configurations.md)。 + 如需查看所有的参数及其当前值，参见[配置管理](1.configurations.md)。 ## basics 配置 -| 名称 | 预设值 | 说明 | -| ----------------- | ----------------------- | ------------------| -| `daemonize` | `true` | 是否启动守护进程。 | -| `pid_file` | `pids/nebula-graphd.pid`| 记录进程 ID 的文件。 | -|`enable_optimizer` |`true` | 是否启用优化器。| -| `timezone_name` | - | 指定 NebulaGraph 的时区。初始配置文件中未设置该参数，使用需手动添加。系统默认值为`UTC+00:00:00`。格式请参见 [Specifying the Time Zone with TZ](https://www.gnu.org/software/libc/manual/html_node/TZ-Variable.html "Click to view the timezone-related content in the GNU C Library manual")。例如，东八区的设置方式为`--timezone_name=UTC+08:00`。 | -| `local_config` | `true` | 是否从配置文件获取配置信息。 | +| 名称 | 预设值 | 说明 |是否支持运行时动态修改| +| ----------------- | ----------------------- | ------------------|---------------------| +| `daemonize` | `true` | 是否启动守护进程。 |不支持| +| `pid_file` | `pids/nebula-graphd.pid`| 记录进程 ID 的文件。 |不支持| +|`enable_optimizer` |`true` | 是否启用优化器。|不支持| +| `timezone_name` | - | 指定 NebulaGraph 的时区。初始配置文件中未设置该参数，使用需手动添加。系统默认值为`UTC+00:00:00`。格式请参见 [Specifying the Time Zone with TZ](https://www.gnu.org/software/libc/manual/html_node/TZ-Variable.html "Click to view the timezone-related content in the GNU C Library manual")。例如，东八区的设置方式为`--timezone_name=UTC+08:00`。 |不支持| +| `local_config` | `true` | 是否从配置文件获取配置信息。 |不支持| !!! Note @@ -34,49 +37,49 @@ Graph 服务提供了两份初始配置文件`nebula-graphd.conf.default`和`neb ## logging 配置 -| 名称 | 预设值 | 说明 | -| ------------- | ------------------------ | ------------------------------------------------ | -| `log_dir` | `logs` | 存放 Graph 服务日志的目录，建议和数据保存在不同硬盘。 | -| `minloglevel` | `0` | 最小日志级别，即记录此级别或更高级别的日志。可选值为`0`（INFO）、`1`（WARNING）、`2`（ERROR）、`3`（FATAL）。建议在调试时设置为`0`，生产环境中设置为`1`。如果设置为`4`，NebulaGraph 不会记录任何日志。 | -| `v` | `0` | VLOG 日志详细级别，即记录小于或等于此级别的所有 VLOG 消息。可选值为`0`、`1`、`2`、`3`、`4`、`5`。glog 提供的 VLOG 宏允许用户定义自己的数字日志记录级别，并用参数`v`控制记录哪些详细消息。详情参见 [Verbose Logging](https://github.com/google/glog#verbose-logging)。 | -| `logbufsecs` | `0` | 缓冲日志的最大时间，超时后输出到日志文件。`0`表示实时输出。单位：秒。 | -|`redirect_stdout`|`true` |是否将标准输出和标准错误重定向到单独的输出文件。 | -|`stdout_log_file` |`graphd-stdout.log` | 标准输出日志文件名称。 | -|`stderr_log_file` |`graphd-stderr.log` | 标准错误日志文件名称。 | -|`stderrthreshold` | `3` | 要复制到标准错误中的最小日志级别（`minloglevel`）。 | -| `timestamp_in_logfile_name` | `true` | 日志文件名称中是否包含时间戳。`true`表示包含，`false`表示不包含。 | +| 名称 | 预设值 | 说明 |是否支持运行时动态修改| +| ------------- | ------------------------ | ------------------------------------------------ |---------------------| +| `log_dir` | `logs` | 存放 Graph 服务日志的目录，建议和数据保存在不同硬盘。 |不支持| +| `minloglevel` | `0` | 最小日志级别，即记录此级别或更高级别的日志。可选值为`0`（INFO）、`1`（WARNING）、`2`（ERROR）、`3`（FATAL）。建议在调试时设置为`0`，生产环境中设置为`1`。如果设置为`4`，NebulaGraph 不会记录任何日志。 |支持| +| `v` | `0` | VLOG 日志详细级别，即记录小于或等于此级别的所有 VLOG 消息。可选值为`0`、`1`、`2`、`3`、`4`、`5`。glog 提供的 VLOG 宏允许用户定义自己的数字日志记录级别，并用参数`v`控制记录哪些详细消息。详情参见 [Verbose Logging](https://github.com/google/glog#verbose-logging)。 |支持| +| `logbufsecs` | `0` | 缓冲日志的最大时间，超时后输出到日志文件。`0`表示实时输出。单位：秒。 |不支持| +|`redirect_stdout`|`true` |是否将标准输出和标准错误重定向到单独的输出文件。 |不支持| +|`stdout_log_file` |`graphd-stdout.log` | 标准输出日志文件名称。 |不支持| +|`stderr_log_file` |`graphd-stderr.log` | 标准错误日志文件名称。 |不支持| +|`stderrthreshold` | `3` | 要复制到标准错误中的最小日志级别（`minloglevel`）。 |不支持| +| `timestamp_in_logfile_name` | `true` | 日志文件名称中是否包含时间戳。`true`表示包含，`false`表示不包含。 |不支持| ## query 配置 -| 名称 | 预设值 | 说明 | -| ------------------- | ------------------------ | ------------------------------------------ | -|`accept_partial_success` |`false` |是否将部分成功视为错误。此配置仅适用于只读请求，写请求总是将部分成功视为错误。| -|`session_reclaim_interval_secs`|`60`| 将 Session 信息发送给 Meta 服务的间隔。单位：秒。| -|`max_allowed_query_size`|`4194304`|最大查询语句长度。单位：字节。默认为`4194304`，即 4MB。| +| 名称 | 预设值 | 说明 |是否支持运行时动态修改| +| ------------------- | ------------------------ | ------------------------------------------ |---------------------| +|`accept_partial_success` |`false` |是否将部分成功视为错误。此配置仅适用于只读请求，写请求总是将部分成功视为错误。|支持| +|`session_reclaim_interval_secs`|`60`| 将 Session 信息发送给 Meta 服务的间隔。单位：秒。|支持| +|`max_allowed_query_size`|`4194304`|最大查询语句长度。单位：字节。默认为`4194304`，即 4MB。|支持| ## networking 配置 -| 名称 | 预设值 | 说明 | -| ----------------------- | ---------------- | ---------------------------------------------------- | -| `meta_server_addrs` | `127.0.0.1:9559` | 全部 Meta 服务的 IP 地址和端口。多个 Meta 服务用英文逗号（,）分隔。 | -|`local_ip` | `127.0.0.1` | Graph 服务的本地 IP 地址。本地 IP 地址用于识别 nebula-graphd 进程，如果是分布式集群或需要远程访问，请修改为对应地址。| -|`listen_netdev` |`any` |监听的网络设备。 | -| `port` | `9669` | Graph 服务的 RPC 守护进程监听端口。 | -|`reuse_port` |`false` | 是否启用 SO_REUSEPORT。 | -|`listen_backlog` |`1024` | socket 监听的连接队列最大长度，调整本参数需要同时调整`net.core.somaxconn`。 | -|`client_idle_timeout_secs` |`28800` | 空闲连接的超时时间。默认 8 小时。`0`表示永不超时。单位：秒。 | -|`session_idle_timeout_secs` |`28800` | 空闲会话的超时时间。取值范围为 1~604800。默认 8 小时。单位：秒。 | -|`num_accept_threads` |`1` | 接受传入连接的线程数。 | -|`num_netio_threads` |`0` | 网络 IO 线程数。`0`表示 CPU 核数。 | -|`num_worker_threads` |`0` | 执行用户查询的线程数。`0`表示 CPU 核数。 | -| `ws_ip` | `0.0.0.0` | HTTP 服务的 IP 地址。 | -| `ws_http_port` | `19669` | HTTP 服务的端口。 | -|`heartbeat_interval_secs` | `10` | 默认心跳间隔。请确保所有服务的`heartbeat_interval_secs`取值相同，否则会导致系统无法正常工作。单位：秒。 | -|`storage_client_timeout_ms`|-| Graph 服务与 Storage 服务的 RPC 连接超时时间。初始配置文件中未设置该参数，使用需手动添加。默认值为`60000`毫秒。| -|`enable_record_slow_query`|`true`|是否启用慢查询记录。
仅企业版 NebulaGraph 支持设置该参数。| -|`slow_query_limit`|`100`|慢查询记录的最大条数。
仅企业版 NebulaGraph 支持设置该参数。| -|`slow_query_threshold_us`|`200000`|定义超过多长时间的查询为慢查询。单位：微秒。| -|`ws_meta_http_port`|`19559`|HTTP 协议监听 Meta 服务的端口，需要和 Meta 服务配置文件中的`ws_http_port`保持一致。| +| 名称 | 预设值 | 说明 |是否支持运行时动态修改| +| ----------------------- | ---------------- | ---------------------------------------------------- |---------------------| +| `meta_server_addrs` | `127.0.0.1:9559` | 全部 Meta 服务的 IP 地址和端口。多个 Meta 服务用英文逗号（,）分隔。 |不支持| +|`local_ip` | `127.0.0.1` | Graph 服务的本地 IP 地址。本地 IP 地址用于识别 nebula-graphd 进程，如果是分布式集群或需要远程访问，请修改为对应地址。|不支持| +|`listen_netdev` |`any` |监听的网络设备。 |不支持| +| `port` | `9669` | Graph 服务的 RPC 守护进程监听端口。 |不支持| +|`reuse_port` |`false` | 是否启用 SO_REUSEPORT。 |不支持| +|`listen_backlog` |`1024` | socket 监听的连接队列最大长度，调整本参数需要同时调整`net.core.somaxconn`。 |不支持| +|`client_idle_timeout_secs` |`28800` | 空闲连接的超时时间。默认 8 小时。`0`表示永不超时。单位：秒。 |不支持| +|`session_idle_timeout_secs` |`28800` | 空闲会话的超时时间。取值范围为 1~604800。默认 8 小时。单位：秒。 |不支持| +|`num_accept_threads` |`1` | 接受传入连接的线程数。 |不支持| +|`num_netio_threads` |`0` | 网络 IO 线程数。`0`表示 CPU 核数。 |不支持| +|`num_worker_threads` |`0` | 执行用户查询的线程数。`0`表示 CPU 核数。 |不支持| +| `ws_ip` | `0.0.0.0` | HTTP 服务的 IP 地址。 |不支持| +| `ws_http_port` | `19669` | HTTP 服务的端口。 |不支持| +|`heartbeat_interval_secs` | `10` | 默认心跳间隔。请确保所有服务的`heartbeat_interval_secs`取值相同，否则会导致系统无法正常工作。单位：秒。 |支持| +|`storage_client_timeout_ms`|-| Graph 服务与 Storage 服务的 RPC 连接超时时间。初始配置文件中未设置该参数，使用需手动添加。默认值为`60000`毫秒。|不支持| +|`enable_record_slow_query`|`true`|是否启用慢查询记录。
仅企业版 NebulaGraph 支持设置该参数。|不支持| +|`slow_query_limit`|`100`|慢查询记录的最大条数。
仅企业版 NebulaGraph 支持设置该参数。|不支持| +|`slow_query_threshold_us`|`200000`|定义超过多长时间的查询为慢查询。单位：微秒。|不支持| +|`ws_meta_http_port`|`19559`|HTTP 协议监听 Meta 服务的端口，需要和 Meta 服务配置文件中的`ws_http_port`保持一致。|不支持| !!! caution @@ -84,23 +87,23 @@ Graph 服务提供了两份初始配置文件`nebula-graphd.conf.default`和`neb ## charset and collate 配置 -| 名称 | 预设值 | 说明 | -| ------------------- | ---------------- | ------------------------------------------ | -| `default_charset` | `utf8` | 创建图空间时的默认字符集。 | -| `default_collate` | `utf8_bin` | 创建图空间时的默认排序规则。 | +| 名称 | 预设值 | 说明 |是否支持运行时动态修改| +| ------------------- | ---------------- | ------------------------------------------ |---------------------| +| `default_charset` | `utf8` | 创建图空间时的默认字符集。 |不支持| +| `default_collate` | `utf8_bin` | 创建图空间时的默认排序规则。 |不支持| ## authorization 配置 -| 名称 | 预设值 | 说明 | -| ------------------- | ---------------- | ------------------------------------------ | -|`enable_authorize` |`false` |用户登录时是否进行身份验证。身份验证详情请参见[身份验证](../../7.data-security/1.authentication/1.authentication.md)。| -|`auth_type` |`password` |用户登录的身份验证方式。取值为`password`、`ldap`、`cloud`。| +| 名称 | 预设值 | 说明 |是否支持运行时动态修改| +| ------------------- | ---------------- | ------------------------------------------ |---------------------| +|`enable_authorize` |`false` |用户登录时是否进行身份验证。身份验证详情请参见[身份验证](../../7.data-security/1.authentication/1.authentication.md)。|不支持| +|`auth_type` |`password` |用户登录的身份验证方式。取值为`password`、`ldap`、`cloud`。|不支持| ## memory 配置 -| 名称 | 预设值 | 说明 | -| ------------------- | ------------------------ | ------------------------------------------ | -| `system_memory_high_watermark_ratio` | `0.8` |内存高水位报警机制的触发阈值。系统内存占用率高于该值会触发报警机制，NebulaGraph 会停止接受查询。| +| 名称 | 预设值 | 说明 |是否支持运行时动态修改| +| ------------------- | ------------------------ | ------------------------------------------ |---------------------| +| `system_memory_high_watermark_ratio` | `0.8` |内存高水位报警机制的触发阈值。系统内存占用率高于该值会触发报警机制，NebulaGraph 会停止接受查询。|支持| {{ ent.ent_begin }} ## audit 配置 @@ -115,22 +118,22 @@ Graph 服务提供了两份初始配置文件`nebula-graphd.conf.default`和`neb ## metrics 配置 -| 名称 | 预设值 | 说明 | -| ------------------- | ------------------------ | ------------------------------------------ | -| `enable_space_level_metrics` | `false` | 开启后可打开图空间级别的监控，对应的监控指标名称中包含图空间的名称，例如`query_latency_us{space=basketballplayer}.avg.3600`。支持的监控指标可用`curl`命令查看，详细说明参见[查询监控指标](../../6.monitor-and-metrics/1.query-performance-metrics.md)。 | +| 名称 | 预设值 | 说明 |是否支持运行时动态修改| +| ------------------- | ------------------------ | ------------------------------------------ |---------------------| +| `enable_space_level_metrics` | `false` | 开启后可打开图空间级别的监控，对应的监控指标名称中包含图空间的名称，例如`query_latency_us{space=basketballplayer}.avg.3600`。支持的监控指标可用`curl`命令查看，详细说明参见[查询监控指标](../../6.monitor-and-metrics/1.query-performance-metrics.md)。 |不支持| ## session 配置 -| 名称 | 预设值 | 说明 | -| ------------------- | ------------------------ | ------------------------------------------ | -|`max_sessions_per_ip_per_user`|`300` | 相同用户和 IP 地址可以创建的最大活跃会话数。| +| 名称 | 预设值 | 说明 |是否支持运行时动态修改| +| ------------------- | ------------------------ | ------------------------------------------ |---------------------| +|`max_sessions_per_ip_per_user`|`300` | 相同用户和 IP 地址可以创建的最大活跃会话数。|不支持| ## experimental 配置 -| 名称 | 预设值 | 说明 | -| ------------------- | ------------------------ | ------------------------------------------ | -|`enable_experimental_feature`|`false`|实验性功能开关。可选值为`true`和`false`。| -|`enable_data_balance`|`true`|是否开启[均衡分片](../../8.service-tuning/load-balance.md)功能。仅当`enable_experimental_feature`为`true`时生效。 | +| 名称 | 预设值 | 说明 |是否支持运行时动态修改| +| ------------------- | ------------------------ | ------------------------------------------ |---------------------| +|`enable_experimental_feature`|`false`|实验性功能开关。可选值为`true`和`false`。|不支持| +|`enable_data_balance`|`true`|是否开启[均衡分片](../../8.service-tuning/load-balance.md)功能。仅当`enable_experimental_feature`为`true`时生效。 |不支持| {{ ent.ent_begin }} @@ -141,12 +144,12 @@ Graph 服务提供了两份初始配置文件`nebula-graphd.conf.default`和`neb 仅企业版支持黑匣子功能配置。 -| 名称 | 预设值 | 说明 | -| :------------------- | :------------------------ | :------------------------------------------ | -|`ng_black_box_switch` |`true` |是否开启黑匣子功能。| -|`ng_black_box_home` |`black_box` |存储黑匣子数据的目录名称。| -|`ng_black_box_dump_period_seconds` |`5` |黑匣子采集指标的时间间隔。单位：秒。| -|`ng_black_box_file_lifetime_seconds` |`1800` |采集指标后生成文件的保存时间。单位：秒| +| 名称 | 预设值 | 说明 |是否支持运行时动态修改| +| :------------------- | :------------------------ | :------------------------------------------ |---------------------| +|`ng_black_box_switch` |`true` |是否开启黑匣子功能。|不支持| +|`ng_black_box_home` |`black_box` |存储黑匣子数据的目录名称。|不支持| +|`ng_black_box_dump_period_seconds` |`5` |黑匣子采集指标的时间间隔。单位：秒。|不支持| +|`ng_black_box_file_lifetime_seconds` |`1800` |采集指标后生成文件的保存时间。单位：秒|支持| {{ ent.ent_end }} @@ -154,12 +157,12 @@ Graph 服务提供了两份初始配置文件`nebula-graphd.conf.default`和`neb ## memory tracker 配置 -| 名称 | 预设值 | 说明 | -| :------------------- | :------------------------ | :------------------------------------------ | -|`memory_tracker_limit_ratio` |`0.8` |可用内存的百分比，当可用内存低于该值时，NebulaGraph 会停止接受查询。
计算公式：可用内存/(总内存 - 保留内存)。
**注意**：对于混合部署的集群，需要根据实际情况**调小**该参数。例如，当预期 Graphd 只占用 50% 的内存时，该参数的值可设置为小于`0.5`。| -|`memory_tracker_untracked_reserved_memory_mb` |`50`|保留内存的大小，单位：MB。| -|`memory_tracker_detail_log` |`false` | 是否定期生成较详细的内存跟踪日志。当值为`true`时，会定期生成内存跟踪日志。| -|`memory_tracker_detail_log_interval_ms` |`60000`|内存跟踪日志的生成时间间隔，单位：毫秒。仅当`memory_tracker_detail_log`为`true`时，该参数生效。| -|`memory_purge_enabled` |`true` |是否定期开启内存清理功能。当值为`true`时，会定期清理内存。| -|`memory_purge_interval_seconds` |`10` |内存清理的时间间隔，单位：秒。`memory_purge_enabled`为`true`时，该参数生效。| +| 名称 | 预设值 | 说明 |是否支持运行时动态修改| +| :------------------- | :------------------------ | :------------------------------------------ |---------------------| +|`memory_tracker_limit_ratio` |`0.8` |可用内存的百分比，当可用内存低于该值时，NebulaGraph 会停止接受查询。
计算公式：可用内存/(总内存 - 保留内存)。
**注意**：对于混合部署的集群，需要根据实际情况**调小**该参数。例如，当预期 Graphd 只占用 50% 的内存时，该参数的值可设置为小于`0.5`。|支持| +|`memory_tracker_untracked_reserved_memory_mb` |`50`|保留内存的大小，单位：MB。|支持| +|`memory_tracker_detail_log` |`false` | 是否定期生成较详细的内存跟踪日志。当值为`true`时，会定期生成内存跟踪日志。|支持| +|`memory_tracker_detail_log_interval_ms` |`60000`|内存跟踪日志的生成时间间隔，单位：毫秒。仅当`memory_tracker_detail_log`为`true`时，该参数生效。|支持| +|`memory_purge_enabled` |`true` |是否定期开启内存清理功能。当值为`true`时，会定期清理内存。|支持| +|`memory_purge_interval_seconds` |`10` |内存清理的时间间隔，单位：秒。`memory_purge_enabled`为`true`时，该参数生效。|支持| diff --git a/docs-2.0/5.configurations-and-logs/1.configurations/4.storage-config.md b/docs-2.0/5.configurations-and-logs/1.configurations/4.storage-config.md index cc27fe64c60..0c1fdd94df0 100644 --- a/docs-2.0/5.configurations-and-logs/1.configurations/4.storage-config.md +++ b/docs-2.0/5.configurations-and-logs/1.configurations/4.storage-config.md @@ -15,6 +15,10 @@ Storage 服务提供了两份初始配置文件`nebula-storaged.conf.default`和 配置文件内没有设置某个参数表示参数使用的是默认值。文件内只预设了部分参数的值，而且两份初始配置文件内的参数值也略有不同，本文的预设值以`nebula-storaged.conf.default`文件为准，其中没有的参数则以`nebula-storaged.conf.production`文件为准。 +!!! caution + + 配置文件中的部分参数值可以在运行时动态修改。本文将这些参数标记为支持运行时动态修改，并当`local_config`值设置为`true`时重启服务后配置会恢复为初始配置。详情参见[修改配置](1.configurations.md)。 + !!! Note Raft Listener 的配置和 Storage 服务配置不同，详情请参见[部署 Raft listener](../../4.deployment-and-installation/6.deploy-text-based-index/3.deploy-listener.md)。 @@ -23,12 +27,12 @@ Storage 服务提供了两份初始配置文件`nebula-storaged.conf.default`和 ## basics 配置 -| 名称 | 预设值 | 说明 | -| :----------- | :----------------------- | :------------------| -| `daemonize` | `true` | 是否启动守护进程。 | -| `pid_file` | `pids/nebula-storaged.pid` | 记录进程 ID 的文件。 | -| `timezone_name` | `UTC+00:00:00` | 指定 NebulaGraph 的时区。初始配置文件中未设置该参数，如需使用请手动添加。格式请参见 [Specifying the Time Zone with TZ](https://www.gnu.org/software/libc/manual/html_node/TZ-Variable.html "Click to view the timezone-related content in the GNU C Library manual")。例如，东八区的设置方式为`--timezone_name=UTC+08:00`。 | -| `local_config` | `true` | 是否从配置文件获取配置信息。 | +| 名称 | 预设值 | 说明 |是否支持运行时动态修改| +| :----------- | :----------------------- | :------------------|:----------------------- | +| `daemonize` | `true` | 是否启动守护进程。 |不支持| +| `pid_file` | `pids/nebula-storaged.pid` | 记录进程 ID 的文件。 |不支持| +| `timezone_name` | `UTC+00:00:00` | 指定 NebulaGraph 的时区。初始配置文件中未设置该参数，如需使用请手动添加。格式请参见 [Specifying the Time Zone with TZ](https://www.gnu.org/software/libc/manual/html_node/TZ-Variable.html "Click to view the timezone-related content in the GNU C Library manual")。例如，东八区的设置方式为`--timezone_name=UTC+08:00`。 |不支持| +| `local_config` | `true` | 是否从配置文件获取配置信息。 |不支持| !!! Note @@ -37,28 +41,28 @@ Storage 服务提供了两份初始配置文件`nebula-storaged.conf.default`和 ## logging 配置 -| 名称 | 预设值 | 说明 | -| :------------- | :------------------------ | :------------------------------------------------ | -| `log_dir` | `logs` | 存放 Storage 服务日志的目录，建议和数据保存在不同硬盘。 | -| `minloglevel` | `0` | 最小日志级别，即记录此级别或更高级别的日志。可选值：`0`（INFO）、`1`（WARNING）、`2`（ERROR）、`3`（FATAL）。建议在调试时设置为`0`，生产环境中设置为`1`。如果设置为`4`，NebulaGraph 不会记录任何日志。 | -| `v` | `0` | VLOG 日志详细级别，即记录小于或等于此级别的所有 VLOG 消息。可选值为`0`、`1`、`2`、`3`、`4`、`5`。glog 提供的 VLOG 宏允许用户定义自己的数字日志记录级别，并用参数`v`控制记录哪些详细消息。详情参见 [Verbose Logging](https://github.com/google/glog#verbose-logging)。 | -| `logbufsecs` | `0` | 缓冲日志的最大时间，超时后输出到日志文件。`0`表示实时输出。单位：秒。 | -|`redirect_stdout`|`true` |是否将标准输出和标准错误重定向到单独的输出文件。 | -|`stdout_log_file` |`storaged-stdout.log` | 标准输出日志文件名称。 | -|`stderr_log_file` |`storaged-stderr.log` | 标准错误日志文件名称。 | -|`stderrthreshold` | `3` | 要复制到标准错误中的最小日志级别（`minloglevel`）。 | -| `timestamp_in_logfile_name` | `true` | 日志文件名称中是否包含时间戳。`true`表示包含，`false`表示不包含。 | +| 名称 | 预设值 | 说明 |是否支持运行时动态修改| +| :------------- | :------------------------ | :---------------------------------- |:----------------------- | +| `log_dir` | `logs` | 存放 Storage 服务日志的目录，建议和数据保存在不同硬盘。 |不支持| +| `minloglevel` | `0` | 最小日志级别，即记录此级别或更高级别的日志。可选值：`0`（INFO）、`1`（WARNING）、`2`（ERROR）、`3`（FATAL）。建议在调试时设置为`0`，生产环境中设置为`1`。如果设置为`4`，NebulaGraph 不会记录任何日志。 |支持| +| `v` | `0` | VLOG 日志详细级别，即记录小于或等于此级别的所有 VLOG 消息。可选值为`0`、`1`、`2`、`3`、`4`、`5`。glog 提供的 VLOG 宏允许用户定义自己的数字日志记录级别，并用参数`v`控制记录哪些详细消息。详情参见 [Verbose Logging](https://github.com/google/glog#verbose-logging)。 |支持| +| `logbufsecs` | `0` | 缓冲日志的最大时间，超时后输出到日志文件。`0`表示实时输出。单位：秒。 |不支持| +|`redirect_stdout`|`true` |是否将标准输出和标准错误重定向到单独的输出文件。 |不支持| +|`stdout_log_file` |`storaged-stdout.log` | 标准输出日志文件名称。 |不支持| +|`stderr_log_file` |`storaged-stderr.log` | 标准错误日志文件名称。 |不支持| +|`stderrthreshold` | `3` | 要复制到标准错误中的最小日志级别（`minloglevel`）。 |不支持| +| `timestamp_in_logfile_name` | `true` | 日志文件名称中是否包含时间戳。`true`表示包含，`false`表示不包含。 |不支持| ## networking 配置 -| 名称 | 预设值 | 说明 | -| :----------------------- | :---------------- | :---------------------------------------------------- | -| `meta_server_addrs` | `127.0.0.1:9559` | 全部 Meta 服务的 IP 地址和端口。多个 Meta 服务用英文逗号（,）分隔。 | -|`local_ip` | `127.0.0.1` | Storage 服务的本地 IP 地址。本地 IP 地址用于识别 nebula-storaged 进程，如果是分布式集群或需要远程访问，请修改为对应地址。| -| `port` | `9779` | Storage 服务的 RPC 守护进程监听端口。Storage 服务对外端口为`9779`，对内端口为`9777`、`9778`和`9780`，NebulaGraph 使用内部端口进行多副本间的交互。
`9777`：drainer 服务占用端口，仅在企业版集群中暴露；`9778`：Admin 服务（Storage 接收 Meta 命令的服务）占用的端口；`9780`：Raft 通信端口。| -| `ws_ip` | `0.0.0.0` | HTTP 服务的 IP 地址。 | -| `ws_http_port` | `19779` | HTTP 服务的端口。 | -|`heartbeat_interval_secs` | `10` | 默认心跳间隔。请确保所有服务的`heartbeat_interval_secs`取值相同，否则会导致系统无法正常工作。单位：秒。 | +| 名称 | 预设值 | 说明 |是否支持运行时动态修改| +| :----------------------- | :---------------- | :------------------------|:----------------------- | +| `meta_server_addrs` | `127.0.0.1:9559` | 全部 Meta 服务的 IP 地址和端口。多个 Meta 服务用英文逗号（,）分隔。 |不支持| +|`local_ip` | `127.0.0.1` | Storage 服务的本地 IP 地址。本地 IP 地址用于识别 nebula-storaged 进程，如果是分布式集群或需要远程访问，请修改为对应地址。|不支持| +| `port` | `9779` | Storage 服务的 RPC 守护进程监听端口。Storage 服务对外端口为`9779`，对内端口为`9777`、`9778`和`9780`，NebulaGraph 使用内部端口进行多副本间的交互。
`9777`：drainer 服务占用端口，仅在企业版集群中暴露；`9778`：Admin 服务（Storage 接收 Meta 命令的服务）占用的端口；`9780`：Raft 通信端口。|不支持| +| `ws_ip` | `0.0.0.0` | HTTP 服务的 IP 地址。 |不支持| +| `ws_http_port` | `19779` | HTTP 服务的端口。 |不支持| +|`heartbeat_interval_secs` | `10` | 默认心跳间隔。请确保所有服务的`heartbeat_interval_secs`取值相同，否则会导致系统无法正常工作。单位：秒。 |支持| !!! caution @@ -66,30 +70,30 @@ Storage 服务提供了两份初始配置文件`nebula-storaged.conf.default`和 ## raft 配置 -| 名称 | 预设值 | 说明 | -| :--------------------------- | :-------- | :------------------------ | -|`raft_heartbeat_interval_secs`| `30` | Raft 选举超时时间。单位：秒。 | -|`raft_rpc_timeout_ms` | `500` | Raft 客户端的远程过程调用（RPC）超时时间。单位：毫秒。 | -|`wal_ttl` | `14400` | Raft WAL 的有效时间。单位：秒。 | +| 名称 | 预设值 | 说明 |是否支持运行时动态修改| +| :--------------------------- | :-------- | :------------------------ |:----------------------- | +|`raft_heartbeat_interval_secs`| `30` | Raft 选举超时时间。单位：秒。 |支持| +|`raft_rpc_timeout_ms` | `500` | Raft 客户端的远程过程调用（RPC）超时时间。单位：毫秒。 |支持| +|`wal_ttl` | `14400` | Raft WAL 的有效时间。单位：秒。 |支持| ## disk 配置 -| 名称 | 预设值 | 说明 | -| :--------------------------| :-------------- | :------------------------ | -|`data_path` | `data/storage` | 数据存储路径，多个路径用英文逗号（,）分隔。一个 RocksDB 实例对应一个路径。 | -|`minimum_reserved_bytes`|`268435456`|每个数据存储路径的剩余空间最小值，低于该值时，可能会导致集群数据写入失败。单位：字节。| -|`rocksdb_batch_size` | `4096` | 批量操作的缓存大小。单位：字节。 | -|`rocksdb_block_cache` | `4` | BlockBasedTable 的默认块缓存大小。单位：兆字节。 | -|`disable_page_cache` |`false`|允许或禁止 NebulaGraph 使用操作系统的页缓存。默认值为`false`，表示允许使用 page cache。当值为`true`时，禁止 NebulaGraph 使用 page cache，此时须设置充足的块缓存（block cache）空间。| -|`engine_type` | `rocksdb` | 存储引擎类型。 | -|`rocksdb_compression` | `lz4` | 压缩算法，可选值：`no`、`snappy`、`lz4`、`lz4hc`、`zlib`、`bzip2`、`zstd`。
该参数会修改每一层的压缩算法，如需为不同层级设置不同的压缩算法，请使用`rocksdb_compression_per_level`参数。 | -|`rocksdb_compression_per_level` | - | 为不同层级设置不同的压缩算法。优先级高于`rocksdb_compression`。例如`no:no:lz4:lz4:snappy:zstd:snappy`。
也可以不设置某个层级的压缩算法，例如`no:no:lz4:lz4::zstd`，此时 L4、L6 层使用`rocksdb_compression`参数的压缩算法。 | -|`enable_rocksdb_statistics` | `false` | 是否启用 RocksDB 的数据统计。 | -|`rocksdb_stats_level` | `kExceptHistogramOrTimers` | RocksDB 的数据统计级别。可选值：`kExceptHistogramOrTimers`（禁用计时器统计，跳过柱状图统计）、`kExceptTimers`（跳过计时器统计）、`kExceptDetailedTimers`（收集除互斥锁和压缩花费时间之外的所有统计数据）、`kExceptTimeForMutex`收集除互斥锁花费时间之外的所有统计数据）、`kAll`（收集所有统计数据）。 | -|`enable_rocksdb_prefix_filtering` | `true` | 是否启用 prefix bloom filter，启用时可以提升图遍历速度，但是会增加内存消耗。 | -|`enable_rocksdb_whole_key_filtering` | `false` | 是否启用 whole key bloom filter。 | -|`rocksdb_filtering_prefix_length` | `12` | 每个 key 的 prefix 长度。可选值：`12`（分片 ID+点 ID）、`16`（分片 ID+点 ID+TagID/Edge typeID）。单位：字节。 | -|`enable_partitioned_index_filter`|`false` |设置为`true`可以降低 bloom 过滤器占用的内存大小，但是在某些随机寻道（random-seek）的情况下，可能会降低读取性能。初始配置文件中未设置该参数，如需使用请手动添加。| +| 名称 | 预设值 | 说明 |是否支持运行时动态修改| +| :--------------------------| :-------------- | :------------------------ |:----------------------- | +|`data_path` | `data/storage` | 数据存储路径，多个路径用英文逗号（,）分隔。一个 RocksDB 实例对应一个路径。 |不支持| +|`minimum_reserved_bytes`|`268435456`|每个数据存储路径的剩余空间最小值，低于该值时，可能会导致集群数据写入失败。单位：字节。|不支持| +|`rocksdb_batch_size` | `4096` | 批量操作的缓存大小。单位：字节。 |不支持| +|`rocksdb_block_cache` | `4` | BlockBasedTable 的默认块缓存大小。单位：兆字节。 |不支持| +|`disable_page_cache` |`false`|允许或禁止 NebulaGraph 使用操作系统的页缓存。默认值为`false`，表示允许使用 page cache。当值为`true`时，禁止 NebulaGraph 使用 page cache，此时须设置充足的块缓存（block cache）空间。|不支持| +|`engine_type` | `rocksdb` | 存储引擎类型。 |不支持| +|`rocksdb_compression` | `lz4` | 压缩算法，可选值：`no`、`snappy`、`lz4`、`lz4hc`、`zlib`、`bzip2`、`zstd`。
该参数会修改每一层的压缩算法，如需为不同层级设置不同的压缩算法，请使用`rocksdb_compression_per_level`参数。 |不支持| +|`rocksdb_compression_per_level` | - | 为不同层级设置不同的压缩算法。优先级高于`rocksdb_compression`。例如`no:no:lz4:lz4:snappy:zstd:snappy`。
也可以不设置某个层级的压缩算法，例如`no:no:lz4:lz4::zstd`，此时 L4、L6 层使用`rocksdb_compression`参数的压缩算法。 |不支持| +|`enable_rocksdb_statistics` | `false` | 是否启用 RocksDB 的数据统计。 |不支持| +|`rocksdb_stats_level` | `kExceptHistogramOrTimers` | RocksDB 的数据统计级别。可选值：`kExceptHistogramOrTimers`（禁用计时器统计，跳过柱状图统计）、`kExceptTimers`（跳过计时器统计）、`kExceptDetailedTimers`（收集除互斥锁和压缩花费时间之外的所有统计数据）、`kExceptTimeForMutex`收集除互斥锁花费时间之外的所有统计数据）、`kAll`（收集所有统计数据）。 |不支持| +|`enable_rocksdb_prefix_filtering` | `true` | 是否启用 prefix bloom filter，启用时可以提升图遍历速度，但是会增加内存消耗。 |不支持| +|`enable_rocksdb_whole_key_filtering` | `false` | 是否启用 whole key bloom filter。 |不支持| +|`rocksdb_filtering_prefix_length` | `12` | 每个 key 的 prefix 长度。可选值：`12`（分片 ID+点 ID）、`16`（分片 ID+点 ID+TagID/Edge typeID）。单位：字节。 |不支持| +|`enable_partitioned_index_filter`|`false` |设置为`true`可以降低 bloom 过滤器占用的内存大小，但是在某些随机寻道（random-seek）的情况下，可能会降低读取性能。初始配置文件中未设置该参数，如需使用请手动添加。|不支持| + 3.4.0发布 - +--> ## 快速开始 From 5a8407258ef3276ea2806e0c1bf4937535736980 Mon Sep 17 00:00:00 2001 From: "min.wu" <50101159+whitewum@users.noreply.github.com> Date: Tue, 7 Mar 2023 15:41:39 +0800 Subject: [PATCH 070/137] Update mkdocs.yml --- mkdocs.yml | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/mkdocs.yml b/mkdocs.yml index bdf0c614b45..028585c34d5 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -108,14 +108,14 @@ plugins: # - '.*\.(tmp|bin|tar)$' # modify when release: - - with-pdf: - copyright: 2023 vesoft Inc. - cover_subtitle: v3.4.0 - author: 吴敏，周瑶，梁振亚，杨怡璇，黄凤仙 - cover: true - back_cover: true - cover_logo: 'https://cloud-cdn.nebula-graph.com.cn/nebula-for-pdf.png' - output_path: pdf/NebulaGraph-CN.pdf +# - with-pdf: +# copyright: 2023 vesoft Inc. +# cover_subtitle: v3.4.0 +# author: 吴敏，周瑶，梁振亚，杨怡璇，黄凤仙 +# cover: true +# back_cover: true +# cover_logo: 'https://cloud-cdn.nebula-graph.com.cn/nebula-for-pdf.png' +# output_path: pdf/NebulaGraph-CN.pdf extra_javascript: - js/version-select.js @@ -758,4 +758,4 @@ nav: - 思维导图: 20.appendix/mind-map.md - 错误码: 20.appendix/error-code.md - - PDF: ./pdf/NebulaGraph-CN.pdf +# - PDF: ./pdf/NebulaGraph-CN.pdf From 56e824021ae512e89e767dbd64c89efcd19757ab Mon Sep 17 00:00:00 2001 From: cooper-lzy <78672629+cooper-lzy@users.noreply.github.com> Date: Wed, 8 Mar 2023 11:15:53 +0800 Subject: [PATCH 071/137] release 3.4.1 (#2626) * release 3.4.1 * Update nebula-comm-release-note.md --- .github/workflows/deploy.yaml | 10 +-- docs-2.0/20.appendix/history.md | 8 +- .../release-notes/nebula-comm-release-note.md | 68 +-------------- .../release-notes/nebula-ent-release-note.md | 83 +------------------ docs-2.0/README.md | 2 +- docs-2.0/stylesheets/extra.css | 4 +- mkdocs.yml | 8 +- 7 files changed, 23 insertions(+), 160 deletions(-) diff --git a/.github/workflows/deploy.yaml b/.github/workflows/deploy.yaml index ea61e5645ef..568c8da62a7 100644 --- a/.github/workflows/deploy.yaml +++ b/.github/workflows/deploy.yaml @@ -2,7 +2,7 @@ name: Publish docs via GitHub Pages on: push: branches: - - v3.4.0 + - v3.4.1 jobs: deploy: @@ -27,8 +27,8 @@ jobs: - name: mike run: | git fetch origin gh-pages --depth=1 # fix mike's CI update - mike deploy 3.4.0 -p --rebase - mike set-default 3.4.0 -p --rebase + mike deploy 3.4.1 -p --rebase + mike set-default 3.4.1 -p --rebase mike list - name: show git branch @@ -38,7 +38,7 @@ jobs: git checkout gh-pages - name: Compress run: | - tar -vczf nebula-docs.tar.gz 3.4.0 versions.json *.html + tar -vczf nebula-docs.tar.gz 3.4.1 versions.json *.html - name: Transfer # uses: garygrossgarten/github-action-scp@release @@ -61,7 +61,7 @@ jobs: mkdir -p /usr/web/nebula-docs/ tar -xzf /usr/web/nebula-docs.tar.gz -C /usr/web/nebula-docs/ mkdir -p /usr/web/nebula-docs/site/pdf/ - cp -f /usr/web/nebula-docs/3.4.0/pdf/NebulaGraph-CN.pdf /usr/web/nebula-docs/site/pdf/NebulaGraph-book.pdf + cp -f /usr/web/nebula-docs/3.4.1/pdf/NebulaGraph-CN.pdf /usr/web/nebula-docs/site/pdf/NebulaGraph-book.pdf # pip3 install --upgrade pip # pip3 install -r /usr/web/nebula-docs/requirement.txt diff --git a/docs-2.0/20.appendix/history.md b/docs-2.0/20.appendix/history.md index 5baf3e74796..79f769a7cde 100644 --- a/docs-2.0/20.appendix/history.md +++ b/docs-2.0/20.appendix/history.md @@ -35,4 +35,10 @@ 9. 2022.2 发布 v3.0.0 -10. 2022.4 发布 v3.1.0 \ No newline at end of file +10. 2022.4 发布 v3.1.0 + +11. 2022.7 发布 v3.2.0 + +12. 2022.10 发布 v3.3.0 + +13. 2023.2 发布 v3.4.0 \ No newline at end of file diff --git a/docs-2.0/20.appendix/release-notes/nebula-comm-release-note.md b/docs-2.0/20.appendix/release-notes/nebula-comm-release-note.md index c2ab82a9985..975c4ad9904 100644 --- a/docs-2.0/20.appendix/release-notes/nebula-comm-release-note.md +++ b/docs-2.0/20.appendix/release-notes/nebula-comm-release-note.md @@ -1,74 +1,10 @@ # NebulaGraph 社区版 {{ nebula.release }} release notes -## 功能 - -- 支持[终止会话](../../3.ngql-guide/17.query-tuning-statements/2.kill-session.md)。[#5146](https://github.com/vesoft-inc/nebula/pull/5146) -- 支持 [Memory Tracker](../../5.configurations-and-logs/1.configurations/4.storage-config.md)，优化内存管理。[#5082](https://github.com/vesoft-inc/nebula/pull/5082) - -## 优化 - -- 优化作业管理。 [#5212](https://github.com/vesoft-inc/nebula/pull/5212) [#5093](https://github.com/vesoft-inc/nebula/pull/5093) [#5099](https://github.com/vesoft-inc/nebula/pull/5099) [#4872](https://github.com/vesoft-inc/nebula/pull/4872) - -- 修改 Graph 服务配置参数`session_reclaim_interval_secs`的默认值更改为 60 秒。 [#5246](https://github.com/vesoft-inc/nebula/pull/5246) - -- 调整配置文件中`stderrthreshold`的默认级别。 [#5188](https://github.com/vesoft-inc/nebula/pull/5188) - -- 优化全文索引。 [#5077](https://github.com/vesoft-inc/nebula/pull/5077) [#4900](https://github.com/vesoft-inc/nebula/pull/4900) [#4925](https://github.com/vesoft-inc/nebula/pull/4925) - -- 限制优化器中计划树的最大深度以避免堆栈溢出。 [#5050](https://github.com/vesoft-inc/nebula/pull/5050) - -- 优化模式表达式作为谓词时的处理方案。 [#4916](https://github.com/vesoft-inc/nebula/pull/4916) - ## 缺陷修复 -- 修复查询计划生成与优化时的问题。 [#4863](https://github.com/vesoft-inc/nebula/pull/4863) [#4813](https://github.com/vesoft-inc/nebula/pull/4813) - -- 修复索引相关的缺陷： - - - 全文索引 [#5214](https://github.com/vesoft-inc/nebula/pull/5214) [#5260](https://github.com/vesoft-inc/nebula/pull/5260) - - 字符串索引 [#5126](https://github.com/vesoft-inc/nebula/pull/5126) - -- 修复查询语句的缺陷： - - - 变量 [#5192](https://github.com/vesoft-inc/nebula/pull/5192) - - 过滤条件和表达式 [#4952](https://github.com/vesoft-inc/nebula/pull/4952) [#4893](https://github.com/vesoft-inc/nebula/pull/4893) [#4863](https://github.com/vesoft-inc/nebula/pull/4863) - - 点或边的属性 [#5230](https://github.com/vesoft-inc/nebula/pull/5230) [#4846](https://github.com/vesoft-inc/nebula/pull/4846) [#4841](https://github.com/vesoft-inc/nebula/pull/4841) [#5238](https://github.com/vesoft-inc/nebula/pull/5238) - - 函数与聚合 [#5135](https://github.com/vesoft-inc/nebula/pull/5135) [#5121](https://github.com/vesoft-inc/nebula/pull/5121) [#4884](https://github.com/vesoft-inc/nebula/pull/4884) - - 使用非法的数据类型 [#5242](https://github.com/vesoft-inc/nebula/pull/5242) - - 子句与算子 [#5241](https://github.com/vesoft-inc/nebula/pull/5241) [#4965](https://github.com/vesoft-inc/nebula/pull/4965) - -- 修复 DDL 和 DML 语句相关的缺陷： - - - ALTER TAG [#5105](https://github.com/vesoft-inc/nebula/pull/5105) [#5136](https://github.com/vesoft-inc/nebula/pull/5136) - - UPDATE [#4933](https://github.com/vesoft-inc/nebula/pull/4933) - -- 修复其它功能的缺陷： - - - TTL [#4961](https://github.com/vesoft-inc/nebula/pull/4961) - - 身份验证 [#4885](https://github.com/vesoft-inc/nebula/pull/4885) - - 服务 [#4896](https://github.com/vesoft-inc/nebula/pull/4896) - -## 变更 - -- 新增的属性名不能与已存在或被删除的属性名同名，否则新增属性会失败。 [#5130](https://github.com/vesoft-inc/nebula/pull/5130) -- 限制修改 Schema 时的类型转换。 [#5098](https://github.com/vesoft-inc/nebula/pull/5098) -- 创建`NOT NULL`类型的属性时，必须指定默认值。 [#5105](https://github.com/vesoft-inc/nebula/pull/5105) -- 在配置文件中添加多线程查询参数`query_concurrently`，默认值为`true`。 [#5119](https://github.com/vesoft-inc/nebula/pull/5119) -- 从配置文件中改移除 KV 分离存储功能参数`kv_separation`，默认关闭该功能。 [#5119](https://github.com/vesoft-inc/nebula/pull/5119) -- 修改配置文件中`local_config`的默认值为`true`。 [#5119](https://github.com/vesoft-inc/nebula/pull/5119) -- 统一使用`v.tag.property`的方式获取属性值，需要指明 Tag。使用`v.property`的方式访问`v`点上某个 Tag 的属性在之前的版本中被错误地允许。 [#5230](https://github.com/vesoft-inc/nebula/pull/5230) -- 删除命令`SHOW HOSTS`中的`HTTP port`列。 [#5056](https://github.com/vesoft-inc/nebula/pull/5056) -- 禁用`OPTIONAL MATCH WHERE `形式的查询。 [#5273](https://github.com/vesoft-inc/nebula/pull/5273) -- 禁用 TOSS。 [#5119](https://github.com/vesoft-inc/nebula/pull/5119) -- 重命名 Listener 的 pid 文件名和 log 目录名。 [#5119](https://github.com/vesoft-inc/nebula/pull/5119) - - -## 升级说明 - -如果用户打算升级到该版本，请按照升级文档进行操作。 +- 修复参数表达式编码到存储层执行时导致崩溃的问题。 [#5336](https://github.com/vesoft-inc/nebula/pull/5336) -- [升级 NebulaGraph v2.x 至 v3.4.0](../../4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-graph-to-latest.md) -- [升级 NebulaGraph v3.x 至 v3.4.0](../../4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-from-300-to-latest.md) +- 修复一些列表函数的崩溃问题。 [#5383](https://github.com/vesoft-inc/nebula/pull/5383) ## 历史版本 diff --git a/docs-2.0/20.appendix/release-notes/nebula-ent-release-note.md b/docs-2.0/20.appendix/release-notes/nebula-ent-release-note.md index a3e37b98d6f..56a0f5eaed7 100644 --- a/docs-2.0/20.appendix/release-notes/nebula-ent-release-note.md +++ b/docs-2.0/20.appendix/release-notes/nebula-ent-release-note.md @@ -1,89 +1,10 @@ # NebulaGraph 企业版 {{ nebula.release }} release notes -## 功能 - -- 支持[增量备份](../../backup-and-restore/nebula-br-ent/1.br-ent-overview.md)。 -- 支持 Tag/Edge type 级别的[细粒度权限管理](../../7.data-security/1.authentication/3.role-list.md)。 -- 支持[终止会话](../../3.ngql-guide/17.query-tuning-statements/2.kill-session.md)。 -- 支持 [Memory Tracker](../../5.configurations-and-logs/1.configurations/4.storage-config.md)，优化内存管理。 -- 支持[黑匣子监控工具](../../6.monitor-and-metrics/3.bbox/3.1.bbox.md)。 -- 支持 [json_extract](../../3.ngql-guide/6.functions-and-expressions/2.string.md) 函数。 -- 支持 [extract](../../3.ngql-guide/6.functions-and-expressions/2.string.md) 函数。 - -## 优化 - -- 支持`GET SUBGRAPH`时过滤点。 -- 支持`GetNeighbors`过滤点。 -- 支持时间戳和日期时间相互转换。 -- 支持模式表达式引用局部定义变量。 -- 优化作业管理。 -- 优化全文索引。 -- 优化模式表达式作为谓词时的处理方案。 -- 优化 GO 语句的 JOIN 性能。 -- 优化 k-hop 查询性能。 -- 优化查询最短路径的性能。 -- 优化点属性过滤的下推。 -- 优化边过滤的下推。 -- 优化查询子图的循环条件。 -- 优化属性裁剪的规则。 -- 移除无效的 Project 操作符。 -- 移除无效的 AppendVertices 操作符。 -- 减少连接操作的数据复制量。 -- 减少 Traverse 和 AppendVertices 操作符的数据复制量。 -- 修改 Graph 服务配置参数`session_reclaim_interval_secs`的默认值更改为 60 秒。 -- 调整配置文件中`stderrthreshold`的默认级别。 -- 通过下标获取属性值，减少属性查询的时间。 -- 限制优化器中计划树的最大深度以避免堆栈溢出。 - ## 缺陷修复 -- 修复查询计划生成与优化时的问题。 - -- 修复索引相关的缺陷： - - - 全文索引 - - 字符串索引 - -- 修复查询语句的缺陷： - - - 变量 - - 过滤条件和表达式 - - 点或边的属性 - - 参数 - - 函数与聚合 - - 使用非法的数据类型 - - 时区、日期、时间等 - - 子句与算子 - -- 修复 DDL 和 DML 语句相关的缺陷： - - - ALTER TAG - - UPDATE - -- 修复其它功能的缺陷： - - - TTL - - 数据同步 - - 身份验证 - - 服务 - - 日志 - - 监控和统计 - -## 变更 +- 修复参数表达式 encode 到存储层执行导致崩溃的问题。 -- 如果您打算从 3.1 升级到 3.4 版本，请按照[升级文档](../../4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-ent-from-3.x-3.4.md)的指导进行操作。 -- 新增的属性名不能与已存在或被删除的属性名同名，否则新增属性会失败。 -- 限制修改 Schema 时的类型转换。 -- 创建`NOT NULL`类型的属性时，必须指定默认值。 -- 在配置文件中添加多线程查询参数`query_concurrently`，默认值为`true`。 -- 从配置文件中改移除 KV 分离存储功能参数`kv_separation`，默认关闭该功能。 -- 修改配置文件中`local_config`的默认值为`true`。 -- 统一使用`v.tag.property`的方式获取属性值，需要指明 Tag。使用`v.property`的方式访问`v`点上某个 Tag 的属性在之前的版本中被错误地允许。 -- 删除命令`SHOW HOSTS`中的`HTTP port`列。 -- 禁用`OPTIONAL MATCH WHERE `形式的查询。 -- 禁用`COUNT(DISTINCT *)`形式的函数。 -- 禁用 TOSS。 -- 重命名 Listener 的 pid 文件名和 log 目录名。 +- 修复一些列表函数的崩溃问题。 ## 历史版本 diff --git a/docs-2.0/README.md b/docs-2.0/README.md index af79adbc63a..91b9e3a5d50 100644 --- a/docs-2.0/README.md +++ b/docs-2.0/README.md @@ -2,7 +2,7 @@ !!! Note - 本文档更新时间{{ now().year }}-{{ now().month }}-{{ now().day }}，GitHub commit [{{ git.short_commit }}](https://github.com/vesoft-inc/nebula-docs/commits/v{{nebula.release}})。该版本主色系为"GPT绿"，色号为 #0FA37F。 + 本文档更新时间{{ now().year }}-{{ now().month }}-{{ now().day }}，GitHub commit [{{ git.short_commit }}](https://github.com/vesoft-inc/nebula-docs/commits/v{{nebula.release}})。该版本主色系为"感性红"，色号为 #F3A68C。 +---> ## 与 HDFS 的区别 From 8734ac2957f5614791c1451918a09c5f304eda82 Mon Sep 17 00:00:00 2001 From: "abby.huang" <78209557+abby-cyber@users.noreply.github.com> Date: Wed, 15 Mar 2023 15:57:43 +0800 Subject: [PATCH 089/137] update result for show sessions (#2657) --- .../6.show/17.show-sessions.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/docs-2.0/3.ngql-guide/7.general-query-statements/6.show/17.show-sessions.md b/docs-2.0/3.ngql-guide/7.general-query-statements/6.show/17.show-sessions.md index d33599cebdf..0e5ea3c92de 100644 --- a/docs-2.0/3.ngql-guide/7.general-query-statements/6.show/17.show-sessions.md +++ b/docs-2.0/3.ngql-guide/7.general-query-statements/6.show/17.show-sessions.md @@ -26,19 +26,19 @@ nebula> SHOW SESSIONS; +------------------+----------+--------------------+----------------------------+----------------------------+------------------+----------+--------------------+ | SessionId | UserName | SpaceName | CreateTime | UpdateTime | GraphAddr | Timezone | ClientIp | +------------------+----------+--------------------+----------------------------+----------------------------+------------------+----------+--------------------+ -| 1651220858102296 | "root" | "basketballplayer" | 2022-04-29T08:27:38.102296 | 2022-04-29T08:50:46.282921 | "127.0.0.1:9669" | 0 | "::ffff:127.0.0.1" | -| 1651199330300991 | "root" | "basketballplayer" | 2022-04-29T02:28:50.300991 | 2022-04-29T08:16:28.339038 | "127.0.0.1:9669" | 0 | "::ffff:127.0.0.1" | -| 1651112899847744 | "root" | "basketballplayer" | 2022-04-28T02:28:19.847744 | 2022-04-28T08:17:44.470210 | "127.0.0.1:9669" | 0 | "::ffff:127.0.0.1" | -| 1651041092662100 | "root" | "basketballplayer" | 2022-04-27T06:31:32.662100 | 2022-04-27T07:01:25.200978 | "127.0.0.1:9669" | 0 | "::ffff:127.0.0.1" | -| 1650959429593975 | "root" | "basketballplayer" | 2022-04-26T07:50:29.593975 | 2022-04-26T07:51:47.184810 | "127.0.0.1:9669" | 0 | "::ffff:127.0.0.1" | -| 1650958897679595 | "root" | "" | 2022-04-26T07:41:37.679595 | 2022-04-26T07:41:37.683802 | "127.0.0.1:9669" | 0 | "::ffff:127.0.0.1" | +| 1651220858102296 | "root" | "basketballplayer" | 2022-04-29T08:27:38.102296 | 2022-04-29T08:50:46.282921 | "127.0.0.1:9669" | 0 | "127.0.0.1" | +| 1651199330300991 | "root" | "basketballplayer" | 2022-04-29T02:28:50.300991 | 2022-04-29T08:16:28.339038 | "127.0.0.1:9669" | 0 | "127.0.0.1" | +| 1651112899847744 | "root" | "basketballplayer" | 2022-04-28T02:28:19.847744 | 2022-04-28T08:17:44.470210 | "127.0.0.1:9669" | 0 | "127.0.0.1" | +| 1651041092662100 | "root" | "basketballplayer" | 2022-04-27T06:31:32.662100 | 2022-04-27T07:01:25.200978 | "127.0.0.1:9669" | 0 | "127.0.0.1" | +| 1650959429593975 | "root" | "basketballplayer" | 2022-04-26T07:50:29.593975 | 2022-04-26T07:51:47.184810 | "127.0.0.1:9669" | 0 | "127.0.0.1" | +| 1650958897679595 | "root" | "" | 2022-04-26T07:41:37.679595 | 2022-04-26T07:41:37.683802 | "127.0.0.1:9669" | 0 | "127.0.0.1" | +------------------+----------+--------------------+----------------------------+----------------------------+------------------+----------+--------------------+ nebula> SHOW SESSION 1635254859271703; +------------------+----------+--------------------+----------------------------+----------------------------+------------------+----------+--------------------+ | SessionId | UserName | SpaceName | CreateTime | UpdateTime | GraphAddr | Timezone | ClientIp | +------------------+----------+--------------------+----------------------------+----------------------------+------------------+----------+--------------------+ -| 1651220858102296 | "root" | "basketballplayer" | 2022-04-29T08:27:38.102296 | 2022-04-29T08:50:54.254384 | "127.0.0.1:9669" | 0 | "::ffff:127.0.0.1" | +| 1651220858102296 | "root" | "basketballplayer" | 2022-04-29T08:27:38.102296 | 2022-04-29T08:50:54.254384 | "127.0.0.1:9669" | 0 | "127.0.0.1" | +------------------+----------+--------------------+----------------------------+----------------------------+------------------+----------+--------------------+ ``` From 351599d57bda0cd721d62c7b2b1148997f759fc4 Mon Sep 17 00:00:00 2001 From: "abby.huang" <78209557+abby-cyber@users.noreply.github.com> Date: Wed, 15 Mar 2023 16:02:33 +0800 Subject: [PATCH 090/137] opt syntax desc for order by (#2659) --- docs-2.0/3.ngql-guide/8.clauses-and-options/order-by.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs-2.0/3.ngql-guide/8.clauses-and-options/order-by.md b/docs-2.0/3.ngql-guide/8.clauses-and-options/order-by.md index 7eec8782108..193f6dfecf4 100644 --- a/docs-2.0/3.ngql-guide/8.clauses-and-options/order-by.md +++ b/docs-2.0/3.ngql-guide/8.clauses-and-options/order-by.md @@ -15,7 +15,7 @@ ```ngql -ORDER BY [ASC | DESC] [, [ASC | DESC] ...]; +| ORDER BY [ASC | DESC] [, [ASC | DESC] ...]; ``` !!! compatibility From 6dc6af3446065ecb5a759596d0b46578bada4b63 Mon Sep 17 00:00:00 2001 From: randomJoe211 <69501902+randomJoe211@users.noreply.github.com> Date: Thu, 16 Mar 2023 11:28:33 +0800 Subject: [PATCH 091/137] Remove the limit for update license with mv --- docs-2.0/4.deployment-and-installation/deploy-license.md | 4 ---- 1 file changed, 4 deletions(-) diff --git a/docs-2.0/4.deployment-and-installation/deploy-license.md b/docs-2.0/4.deployment-and-installation/deploy-license.md index 6ca18503670..1498c235e3a 100644 --- a/docs-2.0/4.deployment-and-installation/deploy-license.md +++ b/docs-2.0/4.deployment-and-installation/deploy-license.md @@ -88,10 +88,6 @@ License 文件包含生效时间、过期时间等信息。说明如下。 2. 在所有包含 Meta 服务的机器上，路径为每个 Meta 服务安装目录的`share/resources/`内，使用新的 License 文件`nebula.license`替换旧的 License 文件。 - !!! note - - 建议使用`cp`、`scp`命令替换 License 文件或使用 vi 等工具编辑原文件的内容实现替换。如果使用`mv`命令，替换后需要重启所有 Meta 服务器。 - 3. 重启 Storage 和 Graph 服务。关于重启操作，参见[启动服务](manage-service.md)。如果用户的 License 的过期时间在到期后的缓冲期内（默认 14 天），则无需重启 Storage 和 Graph 服务。 !!! note From 25e9b3722274faa97b317b5f4aaa3749060bdb5a Mon Sep 17 00:00:00 2001 From: "abby.huang" <78209557+abby-cyber@users.noreply.github.com> Date: Fri, 17 Mar 2023 13:51:32 +0800 Subject: [PATCH 092/137] Config rolling update strategy for operator (#2660) * config-rolling-update-strategy-for-operator * change doc title * Update 11.rolling-update-strategy.md * Update 8.2.pv-reclaim.md * Update 11.rolling-update-strategy.md --- docs-2.0/20.appendix/0.FAQ.md | 2 +- .../11.rolling-update-strategy.md | 38 +++++++++++++++++++ .../8.2.pv-reclaim.md | 2 +- .../9.upgrade-nebula-cluster.md | 4 ++ mkdocs.yml | 9 +++-- 5 files changed, 49 insertions(+), 6 deletions(-) create mode 100644 docs-2.0/nebula-operator/11.rolling-update-strategy.md diff --git a/docs-2.0/20.appendix/0.FAQ.md b/docs-2.0/20.appendix/0.FAQ.md index 1f10081af16..0d1b78ff264 100644 --- a/docs-2.0/20.appendix/0.FAQ.md +++ b/docs-2.0/20.appendix/0.FAQ.md @@ -525,7 +525,7 @@ dmp 文件是错误报告文件，详细记录了进程退出的信息，可以 ### 防火墙中需要开放哪些端口？ -如果没有修改过[配置文件](../5.configurations-and-logs/1.configurations/1.configurations.md) 中预设的端口，请在防火墙中开放如下端口： +如果没有修改过[配置文件](../5.configurations-and-logs/1.configurations/1.configurations.md)中预设的端口，请在防火墙中开放如下端口： |服务类型|端口| |-|-| diff --git a/docs-2.0/nebula-operator/11.rolling-update-strategy.md b/docs-2.0/nebula-operator/11.rolling-update-strategy.md new file mode 100644 index 00000000000..cc7d5ea0a07 --- /dev/null +++ b/docs-2.0/nebula-operator/11.rolling-update-strategy.md @@ -0,0 +1,38 @@ +# NebulaGraph 集群的滚动更新策略 + +NebulaGraph 集群使用分布式架构将数据分成多个逻辑分片，这些分片通常均分在不同的节点上。分布式系统中，同一份数据通常会有多个副本。为了保证多个副本数据的一致性，NebulaGraph 集群使用 Raft 协议实现了多分片副本同步。Raft 协议中，每个分片都会选举出一个 Leader 副本，Leader 副本负责处理写请求，Follower 副本负责处理读请求。 + +通过 Operator 创建的 NebulaGraph 集群在滚动更新过程中，一个存储节点会暂时停止提供服务以进行更新。关于滚动更新的概述，参见[执行滚动更新](https://kubernetes.io/zh-cn/docs/tutorials/kubernetes-basics/update/update-intro/)。如果 Leader 副本所在的节点停止提供服务，会导致该分片的读写不可用。为了避免这种情况，Operator 会在 NebulaGraph 集群滚动更新过程中，默认将 Leader 副本迁移到其他未受影响节点上。这样，当一个存储节点处于更新状态时，其他节点上的 Leader 副本能够继续处理客户端请求，以保证集群的读写可用性。 + +一个存储节点上的所有 Leader 副本全部迁移到其他节点的这个过程可能会持续较长时间。为了更好地控制滚动更新的时间，Operator 提供了一个名为`enableForceUpdate`参数。当确定没有外部访问流量时，可将该参数设置为`true`，这样，Leader 副本将不会被迁移到其他节点上，从而加快滚动更新的速度。 + +## 滚动更新触发条件 + +Operator 会在以下情况下触发 NebulaGraph 集群的滚动更新： + +- NebulaGraph 集群的版本发生变化。 +- NebulaGraph 集群的配置发生变化。 + +## 配置滚动更新策略 + +在创建集群实例的 YAML 文件中，添加`spec.storaged.enableForceUpdate`参数，设置为`true`或`false`，以控制滚动更新的速度。 + +当`enableForceUpdate`为`true`时，表示不迁移分片 Leader 副本，从而加快滚动更新的速度；反之，表示迁移分片 Leader 副本，以保证集群的读写可用性。默认值为`false`。 + +!!! caution + + 设置`enableForceUpdate`为`true`时，确保没有流量进入集群进行读写操作。因为该设置会强制重建集群 Pod，此过程会发生数据丢失或客户端请求失败的情况。 + + +配置示例： + +```yaml +... +spec: +... + storaged: + enableForceUpdate: true // 设置为 true 时，加快滚动更新的速度。 + ... +``` + + 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 60a1b3be2ee..ffcb6cdb3de 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 @@ -2,7 +2,7 @@ NebulaGraph Operator 使用持久化卷 PV（Persistent Volume）和持久化卷声明 PVC（Persistent Volume Claim）来存储持久化数据。如果用户不小心删除了一个 NebulaGraph 集群，默认 PV 和 PVC 对象及其数据仍可保留，以确保数据安全。 -用户也可以在集群实例的配置文件中通过设置参数`spec.enablePVReclaim`为`true`来定义在删除集群后自动删除 PVC 以释放数据。至于在删除 PVC 后是否删除 PV，用户需要自定义 PV 的回收策略。参见 [StorageClass 中设置 reclaimPolicy](https://kubernetes.io/docs/concepts/storage/storage-classes/#reclaim-policy)和 [PV Reclaiming](https://kubernetes.io/docs/concepts/storage/persistent-volumes/#reclaiming) 了解 PV 回收策略。 +用户也可以在集群实例的配置文件中通过设置参数`spec.enablePVReclaim`为`true`来定义在删除集群后自动删除 PVC 以释放数据。至于在删除 PVC 后是否删除 PV，用户需要自定义 PV 的回收策略。参见 [StorageClass 中设置 reclaimPolicy](https://kubernetes.io/docs/concepts/storage/storage-classes/#reclaim-policy) 和 [PV Reclaiming](https://kubernetes.io/docs/concepts/storage/persistent-volumes/#reclaiming) 了解 PV 回收策略。 ## 前提条件 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 95adc9ce69d..1d9c1ca41bc 100644 --- a/docs-2.0/nebula-operator/9.upgrade-nebula-cluster.md +++ b/docs-2.0/nebula-operator/9.upgrade-nebula-cluster.md @@ -203,3 +203,7 @@ 1 vesoft/nebula-metad:{{nebula.tag}} 3 vesoft/nebula-storaged:{{nebula.tag}} ``` + +## 加速升级过程 + +集群的升级过程是一个滚动更新的过程也是耗时的过程，因为 Storage 服务的 Leader 分片副本会进行状态转移。用户可在集群实例的 YAML 文件中配置`enableForceUpdate`参数，来略过 Leader 分片副本转移操作，以达到加速升级的过程。详情参见[配置滚动更新策略](11.rolling-update-strategy.md)。 \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index 43f89a8c2e5..0de4139869d 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -713,15 +713,16 @@ nav: - 部署 NebulaGraph: - 使用 Kubectl 部署 NebulaGraph 集群: nebula-operator/3.deploy-nebula-graph-cluster/3.1create-cluster-with-kubectl.md - 使用 Helm 部署 NebulaGraph 集群: nebula-operator/3.deploy-nebula-graph-cluster/3.2create-cluster-with-helm.md + - 连接 NebulaGraph: nebula-operator/4.connect-to-nebula-graph-service.md - 配置 NebulaGraph: - 自定义 NebulaGraph 集群的配置参数: nebula-operator/8.custom-cluster-configurations/8.1.custom-conf-parameter.md - 回收 PV: nebula-operator/8.custom-cluster-configurations/8.2.pv-reclaim.md #ent - 均衡扩容后的 Storage 数据: nebula-operator/8.custom-cluster-configurations/8.3.balance-data-when-scaling-storage.md - - 升级 NebulaGraph: nebula-operator/9.upgrade-nebula-cluster.md - - 连接 NebulaGraph: nebula-operator/4.connect-to-nebula-graph-service.md -#ent - - 备份与恢复: nebula-operator/10.backup-restore-using-operator.md + - 升级 NebulaGraph: nebula-operator/9.upgrade-nebula-cluster.md + - 配置滚动更新策略: nebula-operator/11.rolling-update-strategy.md +#ent + - 备份与恢复: nebula-operator/10.backup-restore-using-operator.md - 故障自愈: nebula-operator/5.operator-failover.md - 常见问题: nebula-operator/7.operator-faq.md From 82d8801c2865504f6cbc205f951be5ad9936531b Mon Sep 17 00:00:00 2001 From: "abby.huang" <78209557+abby-cyber@users.noreply.github.com> Date: Fri, 17 Mar 2023 14:06:32 +0800 Subject: [PATCH 093/137] Config rolling update strategy for operator (#2663) * Update 11.rolling-update-strategy.md Update 8.2.pv-reclaim.md Update 11.rolling-update-strategy.md change doc title config-rolling-update-strategy-for-operator * Update mkdocs.yml --- mkdocs.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/mkdocs.yml b/mkdocs.yml index 0de4139869d..74dc3a5c6aa 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -719,6 +719,7 @@ nav: - 回收 PV: nebula-operator/8.custom-cluster-configurations/8.2.pv-reclaim.md #ent - 均衡扩容后的 Storage 数据: nebula-operator/8.custom-cluster-configurations/8.3.balance-data-when-scaling-storage.md + - 管理集群日志: nebula-operator/8.custom-cluster-configurations/8.4.manage-running-logs.md - 升级 NebulaGraph: nebula-operator/9.upgrade-nebula-cluster.md - 配置滚动更新策略: nebula-operator/11.rolling-update-strategy.md #ent From 443ab3e7d3f1559857df4352ae953aa0fc2a9c8e Mon Sep 17 00:00:00 2001 From: cooper-lzy <78672629+cooper-lzy@users.noreply.github.com> Date: Mon, 20 Mar 2023 15:18:32 +0800 Subject: [PATCH 094/137] fix some error (#2665) --- docs-2.0/3.ngql-guide/13.edge-statements/1.insert-edge.md | 4 ++-- docs-2.0/3.ngql-guide/13.edge-statements/3.upsert-edge.md | 2 +- .../use-exchange/ex-ug-export-from-nebula.md | 7 ++++++- 3 files changed, 9 insertions(+), 4 deletions(-) diff --git a/docs-2.0/3.ngql-guide/13.edge-statements/1.insert-edge.md b/docs-2.0/3.ngql-guide/13.edge-statements/1.insert-edge.md index e05720dc24e..19c5a240311 100644 --- a/docs-2.0/3.ngql-guide/13.edge-statements/1.insert-edge.md +++ b/docs-2.0/3.ngql-guide/13.edge-statements/1.insert-edge.md @@ -33,7 +33,7 @@ INSERT EDGE [IF NOT EXISTS] ( ) VALUES - `dst_vid`：目的点 ID，表示边的终点。 -- `rank`：可选项。边的 rank 值。默认值为`0`。 +- `rank`：可选项。边的 rank 值。数据类型为`int`。默认值为`0`。 !!! compatibility "openCypher 兼容性" @@ -97,6 +97,6 @@ nebula> FETCH PROP ON e2 "14"->"15"@1 YIELD edge AS e; !!! Note * NebulaGraph {{ nebula.release }} 允许存在悬挂边（Dangling edge）。因此可以在起点或者终点存在前，先写边；此时就可以通过 `._src`或`._dst`获取到（尚未写入的）点 VID（不建议这样使用）。 - * 目前还不能保证操作的原子性，如果失败请重试，否则会发生部分写入。此时读取该数据的行为是未定义的。 + * 目前还不能保证操作的原子性，如果失败请重试，否则会发生部分写入。此时读取该数据的行为是未定义的。例如写入操作涉及到多个机器时，可能会出现插入单个边的正反向边只写入成功一个，或者插入多个边时只写入成功一部分，此时会返回报错，请重新执行命令。 * 并发写入同一条边会报`edge conflict`错误，可稍后重试。 * `边的 INSERT 速度`大约是点的 INSERT 速度一半。原因是 INSERT 边会对应 storaged 的两个 INSERT，`INSERT 点`对应 storaged 的一个 INSERT。 diff --git a/docs-2.0/3.ngql-guide/13.edge-statements/3.upsert-edge.md b/docs-2.0/3.ngql-guide/13.edge-statements/3.upsert-edge.md index e3648de9de0..d7aa10ac636 100644 --- a/docs-2.0/3.ngql-guide/13.edge-statements/3.upsert-edge.md +++ b/docs-2.0/3.ngql-guide/13.edge-statements/3.upsert-edge.md @@ -23,7 +23,7 @@ SET | `ON ` | 是 | 指定 Edge type。要修改的属性必须在这个 Edge type 内。 | `ON serve` | | `` | 是 | 指定边的起始点 ID。 | `"player100"` | | `` | 是 | 指定边的目的点 ID。 | `"team204"` | -| `` | 否 | 指定边的 rank 值。 | `10` | +| `` | 否 | 指定边的 rank 值。数据类型为`int`。 | `10` | | `SET ` | 是 | 指定如何修改属性值。| `SET start_year = start_year +1` | | `WHEN ` | 否 | 指定过滤条件。 | `WHEN end_year < 2010` | |`YIELD `|否| 指定语句的输出格式。 | `YIELD start_year AS Start_Year` | diff --git a/docs-2.0/nebula-exchange/use-exchange/ex-ug-export-from-nebula.md b/docs-2.0/nebula-exchange/use-exchange/ex-ug-export-from-nebula.md index 8c0e220e0b1..593957c90f2 100644 --- a/docs-2.0/nebula-exchange/use-exchange/ex-ug-export-from-nebula.md +++ b/docs-2.0/nebula-exchange/use-exchange/ex-ug-export-from-nebula.md @@ -117,7 +117,9 @@ CentOS 7.9.2009 source: nebula sink: csv } - + metaAddress:"127.0.0.1:9559" + space:"test" + label:"person" # config the fields you want to export from nebula fields: [nebula-field-0, nebula-field-1, nebula-field-2] noFields:false # default false, if true, just export id @@ -138,6 +140,9 @@ CentOS 7.9.2009 source: nebula sink: csv } + metaAddress:"127.0.0.1:9559" + space:"test" + label:"friend" # config the fields you want to export from nebula fields: [nebula-field-0, nebula-field-1, nebula-field-2] noFields:false # default false, if true, just export id From 681a3a3b5aedddcd77c8867c04c97ddab954f095 Mon Sep 17 00:00:00 2001 From: "abby.huang" <78209557+abby-cyber@users.noreply.github.com> Date: Mon, 20 Mar 2023 17:07:27 +0800 Subject: [PATCH 095/137] list-ports-used-in-nebulagraph (#2666) * list-ports-used-in-nebulagraph * Update 0.FAQ.md * Update 0.FAQ.md * Update 0.FAQ.md --- docs-2.0/20.appendix/0.FAQ.md | 33 ++++++++++++++++++++++++++++++++- 1 file changed, 32 insertions(+), 1 deletion(-) diff --git a/docs-2.0/20.appendix/0.FAQ.md b/docs-2.0/20.appendix/0.FAQ.md index 0d1b78ff264..a96ae9735a7 100644 --- a/docs-2.0/20.appendix/0.FAQ.md +++ b/docs-2.0/20.appendix/0.FAQ.md @@ -535,7 +535,38 @@ dmp 文件是错误报告文件，详细记录了进程退出的信息，可以 如果修改过配置文件中预设的端口，请找出实际使用的端口并在防火墙中开放它们。 -周边工具各自使用不用的端口，请参考各工具文档。 + +周边工具各自使用不同的端口。以下是 NebulaGraph 内核及周边工具使用的默认端口信息： + +| 序号 | 所属产品/服务 | 类型 | 默认端口 | 说明 | +| :--- | :--------------------- | :--- | :---------------------------- | :----------------------------------------------------------- | +| 1 | NebulaGraph | TCP | 9669 | Graph 服务的 RPC 守护进程监听端口（通常用于客户端连接Graph服务）。 | +| 2 | NebulaGraph | TCP | 19669 | Graph 服务的 HTTP 端口。 | +| 3 | NebulaGraph | TCP | 19670 | Graph 服务的 HTTP/2 端口。（3.x 后已弃用该端口） | +| 4 | NebulaGraph | TCP | 9559 | Meta 服务的 RPC 守护进程监听端口。（通常由 Graph 服务和 Storage 服务发起请求，用于获取和更新图数据库的元数据信息。 | +| 5 | NebulaGraph | TCP | 9560 | Meta 服务之间的 Raft 通信端口。 | +| 6 | NebulaGraph | TCP | 19559 | Meta 服务的 HTTP 端口。 | +| 7 | NebulaGraph | TCP | 19560 | Meta 服务的 HTTP/2 端口。（3.x 后已弃用该端口） | +| 8 | NebulaGraph | TCP | 9777 | Storage 服务中，Drainer 服务占用端口（仅在企业版集群中暴露）。 | +| 9 | NebulaGraph | TCP | 9778 | Storage 服务中，Admin 服务占用端口。 | +| 10 | NebulaGraph | TCP | 9779 | Storage 服务的 RPC 守护进程监听端口。（通常由 Graph 服务发起请求，用于执行数据存储相关的操作，例如读取、写入或删除数据。） | +| 11 | NebulaGraph | TCP | 9780 | Storage 服务之间的 Raft 通信端口。 | +| 12 | NebulaGraph | TCP | 19779 | Storage 服务的 HTTP 端口。 | +| 13 | NebulaGraph | TCP | 19780 | Storage 服务的 HTTP/2 端口。（3.x 后已弃用该端口） | +| 14 | NebulaGraph | TCP | 8888 | 备份和恢复功能的 Agent 服务端口。Agent 是集群中每台机器的一个守护进程，用于启停 NebulaGraph 服务和上传、下载备份文件。 | +| 15 | NebulaGraph | TCP | 9789、9790、9788 | 全文索引中 Raft Listener 的端口，从 Storage 服务读取数据，然后将它们写入 Elasticsearch 集群。
也是集群间数据同步中 Storage Listener 的端口。用于同步主集群的 Storage 数据。端口 9790、9788 由端口 9789 加一减一后自动生成。 | +| 16 | NebulaGraph | TCP | 9200 | NebulaGraph 使用该端口与 Elasticsearch 进行 HTTP 通信，以执行全文搜索查询和管理全文索引。 | +| 17 | NebulaGraph | TCP | 9569、9570、9568| 集群间数据同步功能中 Meta Listener 的端口，用于同步主集群的 Meta 数据。端口 9570、9568 由端口 9569 加一减一后自动生成。 | +| 18 | NebulaGraph | TCP | 9889、9890、9888 | 集群间数据同步功能中 Drainer 服务端口。用于同步 Storage、Meta 数据给从集群。端口 9890、9888 由端口 9889 加一减一后自动生成。| +| 19 | NebulaGraph Studio | TCP | 7001 | Studio 提供 Web 服务占用端口。 | +| 20 | NebulaGraph Dashboard | TCP | 8090 | Nebula HTTP Gateway 依赖服务端口。为集群服务提供 HTTP 接口，执行 nGQL 语句与 NebulaGraph 数据库进行交互。 | +| 21 | NebulaGraph Dashboard | TCP | 9200 | Nebula Stats Exporter 依赖服务端口。收集集群的性能指标，包括服务 IP 地址、版本和监控指标（例如查询数量、查询延迟、心跳延迟 等）。 | +| 22 | NebulaGraph Dashboard | TCP | 9100 | Node Exporter 依赖服务端口。收集集群中机器的资源信息，包括 CPU、内存、负载、磁盘和流量。 | +| 23 | NebulaGraph Dashboard | TCP | 9090 | Prometheus 服务的端口。存储监控数据的时间序列数据库。 | +| 24 | NebulaGraph Dashboard | TCP | 7003 | Dashboard 社区版 提供 Web 服务占用端口。 | +| 25 | NebulaGraph Dashboard | TCP | 7005 | Dashboard 企业版 提供 Web 服务占用端口。 | +| 26 | NebulaGraph Dashboard | TCP | 9093 | Alertmanager 服务的端口。接收 Prometheus 告警，发送告警通知给 Dashboard。 | +| 27 | NebulaGraph Explorer | TCP | 7002 | Explorer 提供的 Web 服务占用端口。 | ### 如何测试端口是否已开放？ From 5777ae228af84a49b1da86108e0f19164b146c19 Mon Sep 17 00:00:00 2001 From: cooper-lzy <78672629+cooper-lzy@users.noreply.github.com> Date: Tue, 21 Mar 2023 17:15:33 +0800 Subject: [PATCH 096/137] split prepare --- docs-2.0/20.appendix/6.eco-tool-version.md | 23 +++++ mkdocs.yml | 98 +++++++++++++++++----- 2 files changed, 98 insertions(+), 23 deletions(-) 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 68668d7dd11..28d0221f087 100644 --- a/docs-2.0/20.appendix/6.eco-tool-version.md +++ b/docs-2.0/20.appendix/6.eco-tool-version.md @@ -30,6 +30,9 @@ - 2.x 版本的生态工具完全不支持在 NebulaGraph 3.x 版本中使用。 + +{{ comm.comm_begin }} + ## NebulaGraph Studio NebulaGraph Studio（简称 Studio）是一款可以通过 Web 访问的图数据库可视化工具，搭配 NebulaGraph DBMS 使用，提供构图、数据导入、编写 nGQL 查询、图探索等一站式服务。详情请参见[什么是 NebulaGraph Studio](../nebula-studio/about-studio/st-ug-what-is-graph-studio.md)。 @@ -42,6 +45,11 @@ NebulaGraph Studio（简称 Studio）是一款可以通过 Web 访问的图数 |:---|:---| | {{ nebula.tag }} | {{studio.tag}}| +{{ comm.comm_end }} + + +{{ comm.comm_begin }} + ## NebulaGraph Dashboard（社区版） NebulaGraph Dashboard（简称 Dashboard）是一款用于监控 NebulaGraph 集群中机器和服务状态的可视化工具。详情参见[什么是 NebulaGraph Dashboard](../nebula-dashboard/1.what-is-dashboard.md)。 @@ -50,6 +58,10 @@ NebulaGraph Dashboard（简称 Dashboard）是一款用于监控 NebulaGraph 集 |:---|:---| | {{ nebula.tag }} | {{dashboard.tag}}| +{{ comm.comm_end }} + +{{ ent.ent_begin }} + ## NebulaGraph Dashboard（企业版） NebulaGraph Dashboard（简称 Dashboard）是一款用于监控和管理 NebulaGraph 多集群中机器和服务状态的可视化工具，支持在可视化界面进行集群创建、集群导入、数据平衡、扩容缩容等操作。详情参见[什么是 NebulaGraph Dashboard](../nebula-dashboard-ent/1.what-is-dashboard-ent.md)。 @@ -58,6 +70,10 @@ NebulaGraph Dashboard（简称 Dashboard）是一款用于监控和管理 Nebula |:---|:---| | {{ nebula.tag }} | {{dashboard_ent.tag}}| +{{ ent.ent_end }} + +{{ ent.ent_begin }} + ## NebulaGraph Explorer NebulaGraph Explorer（简称 Explorer）是一款可以通过 Web 访问的图探索可视化工具，搭配 NebulaGraph 内核使用，用于与图数据进行可视化交互。即使没有图数据操作经验，用户也可以快速成为图专家。详情参见[什么是 NebulaGraph Explorer](../nebula-explorer/about-explorer/ex-ug-what-is-explorer.md)。 @@ -66,6 +82,8 @@ NebulaGraph Explorer（简称 Explorer）是一款可以通过 Web 访问的图 |:---|:---| | {{ nebula.tag }} | {{explorer.tag}}| +{{ ent.ent_end }} + ## NebulaGraph Stats Exporter [nebula-stats-exporter](https://github.com/vesoft-inc/nebula-stats-exporter)将监控数据导入Prometheus。 @@ -146,6 +164,9 @@ Docker Compose 可以快速部署 NebulaGraph 集群。如何使用请参见 [Do |:---|:---| | {{ nebula.tag }} | {{dockercompose.tag}}| + +{{ comm.comm_begin }} + ## Backup & Restore [Backup&Restore](../backup-and-restore/nebula-br/1.what-is-br.md)（简称 BR）是一款命令行界面（CLI）工具，可以帮助备份 NebulaGraph 的图空间数据，或者通过备份文件恢复数据。 @@ -154,6 +175,8 @@ Docker Compose 可以快速部署 NebulaGraph 集群。如何使用请参见 [Do |:---|:---| | {{ nebula.tag }} | {{br.tag}}| +{{ comm.comm_end }} + {{ent.ent_begin}} ## Backup & Restore (企业版) diff --git a/mkdocs.yml b/mkdocs.yml index 74dc3a5c6aa..4410c2bc5e5 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -81,7 +81,7 @@ plugins: - spark-connector/* - 4.deployment-and-installation/5.zone.md - 4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-from-200-to-latest.md - # ent.begin + # comm.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 @@ -93,13 +93,25 @@ plugins: - nebula-operator/8.custom-cluster-configurations/8.3.balance-data-when-scaling-storage.md - nebula-operator/10.backup-restore-using-operator.md - synchronization-and-migration/replication-between-clusters.md - - 20.appendix/8.about-license/ + - 20.appendix/8.about-license/* - nebula-dashboard-ent/4.cluster-operator/operator/scale.md - - 6.monitor-and-metrics/3.bbox/ - - backup-and-restore/nebula-br-ent/ - # ent.end - # comm.begin + - 6.monitor-and-metrics/3.bbox/* + - backup-and-restore/nebula-br-ent/* + - nebula-dashboard-ent/* + - nebula-explorer/* + - 20.appendix/release-notes/nebula-ent-release-note.md + - 20.appendix/release-notes/dashboard-ent-release-note.md + - 20.appendix/release-notes/explorer-release-note.md + - 20.appendix/8.about-license.md # comm.end + # ent.begin + - backup-and-restore/nebula-br/* + - nebula-studio/* + - nebula-dashboard/ + - 20.appendix/release-notes/nebula-comm-release-note.md + - 20.appendix/release-notes/studio-release-note.md + - 20.appendix/release-notes/dashboard-comm-release-note.md + # ent.end # Exclude the file with the following file name. # - abc.md @@ -156,6 +168,13 @@ extra: base200: 2.0.0 branch: release-3.4 tag: v3.4.1 + # ent.begin + name: 星云图数据库 + # ent.end + # comm.begin + name: NebulaGraph + # comm.end + studio: base111b: 1.1.1-beta base220: 2.2.1 @@ -264,9 +283,6 @@ extra: aliyunRelease: 3.4.0 # 阿里云兼容的最新内核版本 azureLatestRelease: 3.1.0 # 支持Azure云的最新文档版本 aliyunLatestRelease: 3.4.0 # 支持阿里云的最新文档版本 - ent: - ent_begin: #文档包含企业版时需补全该注释（），只包含社区版时只保留注释头（ #文档包含企业版时需补全该注释（），只包含社区版时只保留注释尾（-->） nav: @@ -346,8 +362,9 @@ nav: - 条件表达式函数: 3.ngql-guide/6.functions-and-expressions/5.conditional-expressions.md - 谓词函数: 3.ngql-guide/6.functions-and-expressions/8.predicate.md - geo 函数: 3.ngql-guide/6.functions-and-expressions/14.geo.md -#ent + # ent.begin - 自定义函数: 3.ngql-guide/6.functions-and-expressions/9.user-defined-functions.md + # ent.end - 通用查询语句: - MATCH: 3.ngql-guide/7.general-query-statements/2.match.md @@ -458,8 +475,9 @@ nav: - 使用 RPM/DEB 包部署多机集群: 4.deployment-and-installation/2.compile-and-install-nebula-graph/deploy-nebula-graph-cluster.md - 使用生态工具安装: 4.deployment-and-installation/2.compile-and-install-nebula-graph/6.deploy-nebula-graph-with-peripherals.md - 安装存算合并版 NebulaGraph: 4.deployment-and-installation/standalone-deployment.md -#ent - - 设置 NebulaGraph 企业版 License: 4.deployment-and-installation/deploy-license.md + # ent.begin + - 设置 NebulaGraph 企业版 License: 4.deployment-and-installation/deploy-license.md + # ent.end - 管理服务: 4.deployment-and-installation/manage-service.md - 连接服务: 4.deployment-and-installation/connect-to-nebula-graph.md - 管理 Storage 主机: 4.deployment-and-installation/manage-storage-host.md @@ -480,44 +498,51 @@ nav: - Linux 内核配置: 5.configurations-and-logs/1.configurations/6.kernel-config.md - 日志: - 运行日志: 5.configurations-and-logs/2.log-management/logs.md -#ent + # ent.begin - 审计日志（企业版）: 5.configurations-and-logs/2.log-management/audit-log.md + # ent.end - 监控: - 查询 NebulaGraph 监控指标: 6.monitor-and-metrics/1.query-performance-metrics.md - RocksDB 统计数据: 6.monitor-and-metrics/2.rocksdb-statistics.md -#ent + # ent.begin - 黑匣子: - 黑匣子介绍: 6.monitor-and-metrics/3.bbox/3.1.bbox.md - Nebula-BBox 工具: 6.monitor-and-metrics/3.bbox/3.2.bbox-reviewer.md + # ent.end - 数据安全: - 验证和授权: - 身份验证: 7.data-security/1.authentication/1.authentication.md - 用户管理: 7.data-security/1.authentication/2.management-user.md - 内置角色权限: 7.data-security/1.authentication/3.role-list.md -#ent + # ent.begin - OpenLDAP 验证: 7.data-security/1.authentication/4.ldap.md + # ent.end - SSL 加密: 7.data-security/4.ssl.md - 备份与恢复: + # comm.begin - NebulaGraph BR（社区版）: - BR（社区版）概述: backup-and-restore/nebula-br/1.what-is-br.md - 安装 BR: backup-and-restore/nebula-br/2.compile-br.md - 使用 BR 备份数据: backup-and-restore/nebula-br/3.br-backup-data.md - 使用 BR 恢复数据: backup-and-restore/nebula-br/4.br-restore-data.md -#ent + # comm.end + # ent.begin - NebulaGraph BR（企业版）: - BR（企业版）概述: backup-and-restore/nebula-br-ent/1.br-ent-overview.md - 安装 BR: backup-and-restore/nebula-br-ent/2.install-tools.md - 使用 BR 备份数据: backup-and-restore/nebula-br-ent/3.backup-data.md - 使用 BR 恢复数据: backup-and-restore/nebula-br-ent/4.restore-data.md + # ent.end - 快照: backup-and-restore/3.manage-snapshot.md - 同步与迁移: - 负载均衡: synchronization-and-migration/2.balance-syntax.md -#ent + # ent.begin - 集群间数据同步: synchronization-and-migration/replication-between-clusters.md + # ent.end - 最佳实践: - Compaction: 8.service-tuning/compaction.md @@ -540,7 +565,7 @@ nav: # - NebulaGraph Cloud: nebula-cloud.md -#ent + # ent.begin - NebulaGraph Cloud: - 什么是 NebulaGraph Cloud: nebula-cloud/1.what-is-cloud.md - Nebula Graph Cloud 阿里云版: @@ -548,6 +573,8 @@ nav: - 使用服务实例: nebula-cloud/nebula-cloud-on-alibabacloud/2.use-cloud-services.md - 扩缩容服务: nebula-cloud/nebula-cloud-on-alibabacloud/4.scaling-services.md - 删除服务实例: nebula-cloud/nebula-cloud-on-alibabacloud/3.delete-service-instance.md + # ent.end + # - NebulaGraph Cloud Azure版: # - 创建订阅: nebula-cloud/nebula-cloud-on-azure/2.how-to-create-subsciption.md # - 配置Solution: nebula-cloud/nebula-cloud-on-azure/3.how-to-set-solution.md @@ -561,6 +588,7 @@ nav: # - 用户服务条款: nebula-cloud/nebula-cloud-on-azure/7.terms-and-conditions.md # - 隐私政策条款: nebula-cloud/nebula-cloud-on-azure/8.privacy-policy.md + # comm.begin - NebulaGraph Studio: - 认识 NebulaGraph Studio: - 什么是 NebulaGraph Studio: nebula-studio/about-studio/st-ug-what-is-graph-studio.md @@ -584,14 +612,18 @@ nav: - 连接数据库错误: nebula-studio/troubleshooting/st-ug-config-server-errors.md - 无法访问 Studio: nebula-studio/troubleshooting/st-ug-connection-errors.md - Studio 常见问题: nebula-studio/troubleshooting/st-ug-faq.md - + # comm.end + + # comm.begin - NebulaGraph Dashboard（社区版）: - 什么是 NebulaGraph Dashboard: nebula-dashboard/1.what-is-dashboard.md - 部署 Dashboard: nebula-dashboard/2.deploy-dashboard.md - 连接 Dashboard: nebula-dashboard/3.connect-dashboard.md - Dashboard 页面介绍: nebula-dashboard/4.use-dashboard.md - 监控指标说明: nebula-dashboard/6.monitor-parameter.md + # comm.end + # ent.begin - NebulaGraph Dashboard（企业版）: - 什么是 NebulaGraph Dashboard 企业版: nebula-dashboard-ent/1.what-is-dashboard-ent.md - 部署 NebulaGraph Dashboard 企业版: nebula-dashboard-ent/2.deploy-connect-dashboard-ent.md @@ -629,7 +661,9 @@ nav: - 安装包管理: nebula-dashboard-ent/system-settings/manage-package.md - 监控指标说明: nebula-dashboard-ent/7.monitor-parameter.md - 常见问题 FAQ: nebula-dashboard-ent/8.faq.md + # ent.end + # ent.begin - NebulaGraph Explorer: - 什么是 NebulaGraph Explorer: nebula-explorer/about-explorer/ex-ug-what-is-explorer.md - 安装与登录: @@ -673,6 +707,7 @@ nav: - 内联框架: nebula-explorer/iframe.md - 基本操作和快捷键: nebula-explorer/ex-ug-shortcuts.md - 常见问题 FAQ: nebula-explorer/faq.md + # ent.end - NebulaGraph Importer: - 使用 NebulaGraph Importer: nebula-importer/use-importer.md @@ -703,7 +738,9 @@ nav: - 导入 Kafka 数据: nebula-exchange/use-exchange/ex-ug-import-from-kafka.md - 导入通用 JDBC 数据: nebula-exchange/use-exchange/ex-ug-import-from-jdbc.md - 导入 SST 文件数据: nebula-exchange/use-exchange/ex-ug-import-from-sst.md + # ent.begin - 导出 NebulaGraph 数据: nebula-exchange/use-exchange/ex-ug-export-from-nebula.md + # ent.end - Exchange 常见问题: nebula-exchange/ex-ug-FAQ.md - NebulaGraph Operator: @@ -717,13 +754,15 @@ nav: - 配置 NebulaGraph: - 自定义 NebulaGraph 集群的配置参数: nebula-operator/8.custom-cluster-configurations/8.1.custom-conf-parameter.md - 回收 PV: nebula-operator/8.custom-cluster-configurations/8.2.pv-reclaim.md -#ent + # ent.begin - 均衡扩容后的 Storage 数据: nebula-operator/8.custom-cluster-configurations/8.3.balance-data-when-scaling-storage.md + # ent.end - 管理集群日志: nebula-operator/8.custom-cluster-configurations/8.4.manage-running-logs.md - 升级 NebulaGraph: nebula-operator/9.upgrade-nebula-cluster.md - 配置滚动更新策略: nebula-operator/11.rolling-update-strategy.md -#ent - - 备份与恢复: nebula-operator/10.backup-restore-using-operator.md + # ent.begin + - 备份与恢复: nebula-operator/10.backup-restore-using-operator.md + # ent.end - 故障自愈: nebula-operator/5.operator-failover.md - 常见问题: nebula-operator/7.operator-faq.md @@ -743,15 +782,28 @@ nav: - 附录: - Release Note: + # comm.begin - NebulaGraph 社区版: 20.appendix/release-notes/nebula-comm-release-note.md + # comm.end + # ent.begin - NebulaGraph 企业版: 20.appendix/release-notes/nebula-ent-release-note.md + # ent.end + # comm.begin - NebulaGraph Studio: 20.appendix/release-notes/studio-release-note.md + # comm.end + # comm.begin - NebulaGraph Dashboard 社区版: 20.appendix/release-notes/dashboard-comm-release-note.md + # comm.end + # ent.begin - NebulaGraph Dashboard 企业版: 20.appendix/release-notes/dashboard-ent-release-note.md + # ent.end + # ent.begin - NebulaGraph Explorer: 20.appendix/release-notes/explorer-release-note.md + # ent.end - 学习路径: 20.appendix/learning-path.md -#ent + # ent.begin - 关于 License: 20.appendix/8.about-license.md + # ent.end - 常见问题 FAQ: 20.appendix/0.FAQ.md - 生态工具概览: 20.appendix/6.eco-tool-version.md - 导入工具选择: 20.appendix/write-tools.md From 4679d10e722bdf1f86ce3c06d7da986e40f15363 Mon Sep 17 00:00:00 2001 From: cooper-lzy <78672629+cooper-lzy@users.noreply.github.com> Date: Tue, 21 Mar 2023 17:54:37 +0800 Subject: [PATCH 097/137] update --- mkdocs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/mkdocs.yml b/mkdocs.yml index 4410c2bc5e5..0f8a7549947 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -169,7 +169,7 @@ extra: branch: release-3.4 tag: v3.4.1 # ent.begin - name: 星云图数据库 + name: 悦数图数据库 # ent.end # comm.begin name: NebulaGraph From f848efbdb3a41926e670393a43b8e5b2797370d1 Mon Sep 17 00:00:00 2001 From: Abby <78209557+abby-cyber@users.noreply.github.com> Date: Tue, 21 Mar 2023 18:25:37 +0800 Subject: [PATCH 098/137] Update mkdocs.yml --- mkdocs.yml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/mkdocs.yml b/mkdocs.yml index 4410c2bc5e5..670ad751445 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -103,6 +103,7 @@ plugins: - 20.appendix/release-notes/dashboard-ent-release-note.md - 20.appendix/release-notes/explorer-release-note.md - 20.appendix/8.about-license.md + - 4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-ent-from-3.x-3.4.md # comm.end # ent.begin - backup-and-restore/nebula-br/* @@ -486,7 +487,9 @@ nav: - 升级版本: - 升级 v2.x 至 v3.4（社区版）: 4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-graph-to-latest.md - 升级 v3.x 至 v3.4（社区版）: 4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-from-300-to-latest.md + # ent.begin - 升级 v3.x 至 v3.4（企业版）: 4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-ent-from-3.x-3.4.md + # ent.end - 卸载 NebulaGraph: 4.deployment-and-installation/4.uninstall-nebula-graph.md - 配置与日志: From 30b1eac9ac1ef20c8b84022236b6fa516475ebff Mon Sep 17 00:00:00 2001 From: cooper-lzy <78672629+cooper-lzy@users.noreply.github.com> Date: Wed, 22 Mar 2023 11:18:21 +0800 Subject: [PATCH 099/137] Update extra.css --- docs-2.0/stylesheets/extra.css | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs-2.0/stylesheets/extra.css b/docs-2.0/stylesheets/extra.css index b77ffece587..c49ddad8623 100644 --- a/docs-2.0/stylesheets/extra.css +++ b/docs-2.0/stylesheets/extra.css @@ -14,7 +14,7 @@ --md-accent-fg-color: #FF8BFF; /* 选中/悬浮链接的颜色 */ --md-typeset-a-color: #0FA37F!important; /* 白天的链接颜色 */ --md-code-fg-color: rgb(12, 21, 26); /* 代码段字体色 */ - --md-code-bg-color: #ced1d4;/* 代码段背景色 */ + --md-code-bg-color: #eaebec;/* 代码段背景色 */ --md-typeset-color: #000000;/* 普通背景字 */ } From b4cb84db64d39db585d78ebb6b5bdf836b6a9d68 Mon Sep 17 00:00:00 2001 From: "abby.huang" <78209557+abby-cyber@users.noreply.github.com> Date: Wed, 22 Mar 2023 15:27:58 +0800 Subject: [PATCH 100/137] Update upgrade-nebula-ent-from-3.x-3.4.md (#2669) * update-upgrade-doc-for-3.3.0,-remove-update-between-3.x Update upgrade-nebula-graph-to-latest.md Update upgrade-nebula-ent-from-3.x-3.4.md * Update upgrade-nebula-graph-to-latest.md --- ... => _upgrade-nebula-from-300-to-latest.md} | 0 .../upgrade-nebula-ent-from-3.x-3.4.md | 23 +++++++++------ .../upgrade-nebula-graph-to-latest.md | 29 ++++++++++++++----- mkdocs.yml | 6 ++-- 4 files changed, 39 insertions(+), 19 deletions(-) rename docs-2.0/4.deployment-and-installation/3.upgrade-nebula-graph/{upgrade-nebula-from-300-to-latest.md => _upgrade-nebula-from-300-to-latest.md} (100%) diff --git a/docs-2.0/4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-from-300-to-latest.md b/docs-2.0/4.deployment-and-installation/3.upgrade-nebula-graph/_upgrade-nebula-from-300-to-latest.md similarity index 100% rename from docs-2.0/4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-from-300-to-latest.md rename to docs-2.0/4.deployment-and-installation/3.upgrade-nebula-graph/_upgrade-nebula-from-300-to-latest.md diff --git a/docs-2.0/4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-ent-from-3.x-3.4.md b/docs-2.0/4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-ent-from-3.x-3.4.md index 3fdbd0f63d3..61fb1d09e70 100644 --- a/docs-2.0/4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-ent-from-3.x-3.4.md +++ b/docs-2.0/4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-ent-from-3.x-3.4.md @@ -1,10 +1,15 @@ -# 升级企业版 NebulaGraph 3.x 至 3.4.0 +# 升级企业版 NebulaGraph 3.x 至 {{nebula.release}} -本文以企业版 NebulaGraph 3.1.0 为例，介绍如何升级至 3.4.0。 +本文以企业版 NebulaGraph 3.1.0 为例，介绍如何升级 v3.x 至 v{{nebula.release}}。 ## 升级说明 -- 此升级操作仅适用于升级企业版 NebulaGraph 3.x 至 3.4.0。 如果您的企业版 NebulaGraph 版本低于 3.0.0，请先升级到企业版 3.1.0 再升级到 3.4.0。具体操作请参见[升级 NebulaGraph 2.x 至 3.1.0](https://docs.nebula-graph.com.cn/3.1.0/4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-graph-to-latest/)。 +- 此升级操作仅适用于升级企业版 NebulaGraph 3.x（x < 4）至 {{nebula.release}}。对于升级 3.4.0 及以上版本至 {{nebula.release}}，可以直接替换二进制文件进行升级。具体操作请参见[升级 NebulaGraph 至 {{nebula.release}}](https://docs.nebula-graph.com.cn/{{nebula.release}}/4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-graph-to-latest/)。 + + + !!! note + + 如果您的企业版 NebulaGraph 版本低于 3.0.0，请先升级到企业版 3.1.0 再升级到 {{nebula.release}}。具体操作请参见[升级 NebulaGraph 2.x 至 3.1.0](https://docs.nebula-graph.com.cn/3.1.0/4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-graph-to-latest/)。 - 执行升级操作的集群 IP 地址必须与原集群相同。 @@ -18,7 +23,7 @@ ## 升级步骤 -1. [联系我们获取](https://www.nebula-graph.com.cn/contact)企业版 NebulaGraph v3.4.0 的安装包并安装。 +1. [联系我们获取](https://www.nebula-graph.com.cn/contact)企业版 NebulaGraph v{{nebula.release}} 的安装包并安装。 !!! note @@ -26,12 +31,12 @@ !!! caution - 请确保 3.4.0 集群的 Meta 服务和 Storage 服务的配置文件中的`--data_path`参数设置的存储路径数量与 3.x 集群的配置文件中的`--data_path`参数配置的路径数量相同。否则，升级后的集群无法启动。 + 请确保 {{nebula.release}} 集群的 Meta 服务和 Storage 服务的配置文件中的`--data_path`参数设置的存储路径数量与 3.x 集群的配置文件中的`--data_path`参数配置的路径数量相同。否则，升级后的集群无法启动。 2. 停止企业版 NebulaGraph v3.x 服务。详情请参见[管理 NebulaGraph 服务](../../2.quick-start/3.quick-start-on-premise/5.start-stop-service.md)。 运行命令后可继续运行`nebula.service status all`命令以确认所有服务都已停止。 -3. 在企业版 NebulaGraph v3.4.0 的安装目录下，分别执行以下命令以升级 Storage 和 Meta 服务。 +3. 在企业版 NebulaGraph v{{nebula.release}} 的安装目录下，分别执行以下命令以升级 Storage 和 Meta 服务。 - 升级 Storage 服务： @@ -82,11 +87,11 @@ 如果有多个源 Meta 数据目录，请指定不同的源 Meta 数据目录和目标 Meta 数据目录并分别执行命令。 - 服务升级完成后，会在 v3.4.0 的安装目录下生成`data`目录，其中包含升级后的数据文件。 + 服务升级完成后，会在 v{{nebula.release}} 的安装目录下生成`data`目录，其中包含升级后的数据文件。 -4. 上传 License 文件至 v3.4.0 的安装目录下的`share/resources`内。 +4. 上传 License 文件至 v{{nebula.release}} 的安装目录下的`share/resources`内。 -5. 启动和连接企业版 NebulaGraph v3.4.0 服务后，验证数据是否正确。参考命令如下： +5. 启动和连接企业版 NebulaGraph v{{nebula.release}} 服务后，验证数据是否正确。参考命令如下： ``` nebula> SHOW HOSTS; 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 adb323a274d..dfa24f57ce6 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 @@ -1,10 +1,19 @@ -# 升级 NebulaGraph 2.x 至 {{nebula.release}} 版本 +# 升级 NebulaGraph 至 {{nebula.release}} 版本 -本文以 NebulaGraph 2.6.1 版本升级到 {{nebula.release}} 版本为例，介绍 NebulaGraph 2.x 版本升级到 3.x 版本的方法。 +本文以 NebulaGraph 2.6.1 版本升级到 {{nebula.release}} 版本为例，介绍 NebulaGraph 2.x、3.x 版本升级到 {{nebula.release}} 版本的方法。 + + + ## 适用版本 -本文适用于将 NebulaGraph 从 2.5.0 及之后的 2.x 版本升级到 {{nebula.release}} 版本。不适用于 2.5.0 之前的历史版本（含 1.x 版本）。如需升级历史版本，将其根据最新的 2.x 版本文档升级到 2.5 版本，然后根据本文的说明升级到 {{nebula.release}} 版本。 +本文适用于将 NebulaGraph 从 2.5.0 及之后的 2.x、3.x 版本升级到 {{nebula.release}} 版本。不适用于 2.5.0 之前的历史版本（含 1.x 版本）。如需升级历史版本，将其根据最新的 2.x 版本文档升级到 2.5 版本，然后根据本文的说明升级到 {{nebula.release}} 版本。 + + !!! caution @@ -63,10 +72,11 @@ ## 升级准备 -- 根据操作系统和架构下载 NebulaGraph {{nebula.release}} 版本的 TAR 文件并解压，升级过程中需要其中的二进制文件。TAR 包下载地址参见 [Download 页面](https://nebula-graph.io/download/)。 +- 根据操作系统和架构下载 NebulaGraph {{nebula.release}} 版本的包文件并解压，升级过程中需要其中的二进制文件。下载地址参见 [Download 页面](https://nebula-graph.io/download/)。 !!! note - 编译源码或者下载RPM/DEB包也可以获取新版二进制文件。 + + 编译源码或者下载 RPM/DEB、TAR 包都可以获取新版二进制文件。 - 根据 Storage 和 Meta 服务配置中`data_path`参数的值找到数据文件的位置，并备份数据。默认路径为`nebula/data/storage`和`nebula/data/meta`。 @@ -92,16 +102,21 @@ `storaged` 进程 flush 数据要等待约 1 分钟。运行命令后可继续运行`nebula.service status all`命令以确认所有服务都已停止。启动和停止服务的详细说明参见[管理服务](../manage-service.md)。 - !!! Note + !!! note 如果超过 20 分钟不能停止服务，放弃本次升级，在[论坛](https://discuss.nebula-graph.com.cn/)或 [GitHub](https://github.com/vesoft-inc/nebula/issues) 提问。 -2. 在**升级准备**中解压 TAR 包的目的路径下，用此处`bin`目录中的新版二进制文件替换 NebulaGraph 安装路径下`bin`目录中的旧版二进制文件。 + !!! caution + + 从 3.0.0 开始，支持插入无 Tag 的点。如果用户需要保留无 Tag 的点，在集群内所有 Graph 服务的配置文件（`nebula-graphd.conf`）中新增`--graph_use_vertex_key=true`；在所有 Storage 服务的配置文件（`nebula-storaged.conf`）中新增`--use_vertex_key=true`。 + +2. 在**升级准备**中下载的包的目的路径下，用此处`bin`目录中的新版二进制文件替换 NebulaGraph 安装路径下`bin`目录中的旧版二进制文件。 !!! note 每台部署了 NebulaGraph 服务的机器上都要更新相应服务的二进制文件。 3. 编辑所有 Graph 服务的配置文件，修改以下参数以适应新版本的取值范围。如参数值已在规定范围内，忽略该步骤。 + - 为`session_idle_timeout_secs`参数设置一个在 [1,604800] 区间的值，推荐值为 28800。 - 为`client_idle_timeout_secs`参数设置一个在 [1,604800] 区间的值，推荐值为 28800。 diff --git a/mkdocs.yml b/mkdocs.yml index 74dc3a5c6aa..a64c326844a 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -466,9 +466,9 @@ nav: # - 管理逻辑机架（Zone）: 4.deployment-and-installation/5.zone.md - 升级版本: - - 升级 v2.x 至 v3.4（社区版）: 4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-graph-to-latest.md - - 升级 v3.x 至 v3.4（社区版）: 4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-from-300-to-latest.md - - 升级 v3.x 至 v3.4（企业版）: 4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-ent-from-3.x-3.4.md + - 升级 NebulaGraph 至 v3.4（社区版）: 4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-graph-to-latest.md + # - 升级 v3.x 至 v3.4（社区版）: 4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-from-300-to-latest.md + - 升级 NebulaGraph 至 v3.4（企业版）: 4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-ent-from-3.x-3.4.md - 卸载 NebulaGraph: 4.deployment-and-installation/4.uninstall-nebula-graph.md - 配置与日志: From a93a5eab5fa9e38541f087a1063862849aeb414a Mon Sep 17 00:00:00 2001 From: Abby <78209557+abby-cyber@users.noreply.github.com> Date: Wed, 22 Mar 2023 15:40:05 +0800 Subject: [PATCH 101/137] Update mkdocs.yml --- mkdocs.yml | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/mkdocs.yml b/mkdocs.yml index fc62acddd1b..a825c47a5f0 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -485,10 +485,12 @@ nav: # - 管理逻辑机架（Zone）: 4.deployment-and-installation/5.zone.md - 升级版本: - - 升级 v2.x 至 v3.4（社区版）: 4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-graph-to-latest.md - - 升级 v3.x 至 v3.4（社区版）: 4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-from-300-to-latest.md + # comm.begin + - 升级 NebulaGraph 至 v3.4（社区版）: 4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-graph-to-latest.md + # comm.end +# - 升级 v3.x 至 v3.4（社区版）: 4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-from-300-to-latest.md # ent.begin - - 升级 v3.x 至 v3.4（企业版）: 4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-ent-from-3.x-3.4.md + - 升级 NebulaGraph 至 v3.4（企业版）: 4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-ent-from-3.x-3.4.md # ent.end - 卸载 NebulaGraph: 4.deployment-and-installation/4.uninstall-nebula-graph.md From 69cd7e005e1048691590581a551aaa3fbe9dd160 Mon Sep 17 00:00:00 2001 From: Abby <78209557+abby-cyber@users.noreply.github.com> Date: Wed, 22 Mar 2023 15:48:36 +0800 Subject: [PATCH 102/137] Update mkdocs.yml --- mkdocs.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/mkdocs.yml b/mkdocs.yml index a825c47a5f0..cc6808cad47 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -107,6 +107,7 @@ plugins: # comm.end # ent.begin - backup-and-restore/nebula-br/* + - 4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-graph-to-latest.md - nebula-studio/* - nebula-dashboard/ - 20.appendix/release-notes/nebula-comm-release-note.md From 2f75ec1184485070556018b8e6b2365af586e6d8 Mon Sep 17 00:00:00 2001 From: "abby.huang" <78209557+abby-cyber@users.noreply.github.com> Date: Wed, 22 Mar 2023 18:02:28 +0800 Subject: [PATCH 103/137] add-note-related-to-tar-package-commands-for-bbox (#2673) * add-note-related-to-tar-package-commands-for-bbox * Update 3.2.bbox-reviewer.md --- docs-2.0/6.monitor-and-metrics/3.bbox/3.1.bbox.md | 2 +- .../3.bbox/3.2.bbox-reviewer.md | 12 ++++++++---- 2 files changed, 9 insertions(+), 5 deletions(-) diff --git a/docs-2.0/6.monitor-and-metrics/3.bbox/3.1.bbox.md b/docs-2.0/6.monitor-and-metrics/3.bbox/3.1.bbox.md index fd0a9a938d5..73add898aef 100644 --- a/docs-2.0/6.monitor-and-metrics/3.bbox/3.1.bbox.md +++ b/docs-2.0/6.monitor-and-metrics/3.bbox/3.1.bbox.md @@ -8,7 +8,7 @@ NebulaGraph 黑匣子功能定期收集和归档操作系统和服务指标的 ## 功能说明 -黑匣子在服务器后台以进程运行并收集指标数据，目前仅收集操作系统运行时的一些性能指标（例如，CPU/Memory/Network IO 等相关指标），在未来，我们将支持收集服务指标。关于指标说明，参见[PROC](https://man7.org/linux/man-pages/man5/proc.5.html)。 +黑匣子在服务器后台以进程运行并收集指标数据，目前仅收集操作系统运行时的一些性能指标（例如，CPU/Memory/Network IO 等相关指标），在未来，我们将支持收集服务指标。关于指标说明，参见 [PROC](https://man7.org/linux/man-pages/man5/proc.5.html)。 ## 开启黑匣子 diff --git a/docs-2.0/6.monitor-and-metrics/3.bbox/3.2.bbox-reviewer.md b/docs-2.0/6.monitor-and-metrics/3.bbox/3.2.bbox-reviewer.md index 6dfdfeeb122..63c7e0e7f03 100644 --- a/docs-2.0/6.monitor-and-metrics/3.bbox/3.2.bbox-reviewer.md +++ b/docs-2.0/6.monitor-and-metrics/3.bbox/3.2.bbox-reviewer.md @@ -28,7 +28,7 @@ NebulaGraph 与 Nebula-BBox 的版本兼容性如下： ## 部署 Nebula-BBox -支持多种部署方式，包括 RPM、DEB、Docker 等。本文以 RPM 部署为例介绍如何部署 Nebula-BBox。 +支持多种部署方式，包括 RPM、DEB、TAR、Docker 等。本文以 RPM 部署为例介绍如何部署 Nebula-BBox。 1. 获取 RPM 安装包。 @@ -40,19 +40,23 @@ NebulaGraph 与 Nebula-BBox 的版本兼容性如下： 例如，`sudo rpm -i nebula-bbox-.x86_64.rpm` - Nebula-BBox 以二进制文件的形式安装在默认路径`/usr/bin/`下。 + Nebula-BBox 以二进制文件（文件名为`nebula-bbox`）的形式安装在默认路径`/usr/bin/`下。 ## 使用 Nebula-BBox 用户可以执行`nebula-bbox -h/--help`查看 Nebula-BBox 的帮助信息。 +!!! caution + + 对于安装在非默认路径（默认为`/usr/bin/`）下的 Nebula-BBox，执行`nebula-bbox`相关命令时，需指定 Nebula-BBox 的安装路径。例如，Nebula-BBox 安装在`/usr/bbox`下，则需执行`/usr/bbox/nebula-bbox -h`。 + ### 查看 Nebula-BBox 版本 执行`nebula-bbox version`查看 Nebula-BBox 的版本信息。 ### 查看采集的所有指标 -执行`nebula-bbox metrics`命令查看 Nebula-BBox 采集的所有指标。关于指标的详细信息，参见[PROC(5)](https://man7.org/linux/man-pages/man5/proc.5.html)。 +执行`nebula-bbox metrics`命令查看 Nebula-BBox 采集的所有指标。关于指标的详细信息，参见 [PROC(5)](https://man7.org/linux/man-pages/man5/proc.5.html)。 ### 查看黑匣子文件数据 @@ -87,7 +91,7 @@ nebula-bbox view [(-o|--output=)tui|csv] [--metrics name[,name ...]] [flags] (FI |查看子目录和单个文件的所有指标数据|`nebula-bbox view /usr/local/nebula/black_box/ /usr/local/nebula/black_box/ /usr/local/nebula/black_box//black_box..log`| |查看单个文件中指定的指标数据|`nebula-bbox view --metrics /usr/local/nebula/black_box//black_box..log`| |在所有文件中查看指定的指标数据|`nebula-bbox view --metrics /usr/local/nebula/black_box`| -|将所有文件中指定的指标数据导出为 CSV 文件。|`nebula-bbox view --metrics [, ...] --output csv --output-file .csv /usr/local/nebula/black_box`| +|将所有文件中指定的指标数据导出为 CSV 文件|`nebula-bbox view --metrics [, ...] --output csv --output-file .csv /usr/local/nebula/black_box`| |在所有文件中查看多个指定的指标数据|`nebula-bbox view --metrics [, ...] /usr/local/nebula/black_box`| |查看北京时间 2022 年 9 月 6 日 12：00 起至现在的所有文件数据| `nebula-bbox view --start-time "Tue, 06 Sep 2022 12:00:00 +0800" /usr/local/nebula/black_box`
其中`Tue, 06 Sep 2022 12:00:00 +0800`的格式可替换成`2022-09-06T12:00:00+08:00`、`2022-09-06 04:00:00 +0800`。| |查看北京时间 2022 年 9 月 6 日 12：00 起 1 小时内的所有文件数据|`nebula-bbox view --start-time "Tue, 06 Sep 2022 12:00:00 +0800" --duration 1h /usr/local/nebula/black_box`，时间段单位支持`h`、`m`、`s`。| From 0cceff2f70bdff95858eedbd345760444af9986c Mon Sep 17 00:00:00 2001 From: "abby.huang" <78209557+abby-cyber@users.noreply.github.com> Date: Thu, 23 Mar 2023 11:50:02 +0800 Subject: [PATCH 104/137] Update 3.alter-tag.md (#2675) --- .../3.ngql-guide/10.tag-statements/3.alter-tag.md | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/docs-2.0/3.ngql-guide/10.tag-statements/3.alter-tag.md b/docs-2.0/3.ngql-guide/10.tag-statements/3.alter-tag.md index 135221d5c44..88aa9ed1e06 100644 --- a/docs-2.0/3.ngql-guide/10.tag-statements/3.alter-tag.md +++ b/docs-2.0/3.ngql-guide/10.tag-statements/3.alter-tag.md @@ -10,8 +10,8 @@ - 确保新增的属性名不与已存在或被删除的属性名同名，否则新增属性会失败。 -- 允许增加`FIXED_STRING`和`INT`类型的长度。 -- 允许`FIXED_STRING`类型转换为`STRING`类型、`FLOAT`类型转换为`DOUBLE`类型。 +- 仅允许**增加**`FIXED_STRING`和`INT`类型的长度，不允许减少长度。 +- 仅允许转换`FIXED_STRING`类型为`STRING`类型、转换`FLOAT`类型为`DOUBLE`类型。 ## 语法 @@ -40,13 +40,12 @@ ttl_definition: ```ngql nebula> CREATE TAG IF NOT EXISTS t1 (p1 string, p2 int); -nebula> ALTER TAG t1 ADD (p3 int, p4 string); +nebula> ALTER TAG t1 ADD (p3 int32, p4 fixed_string(10)); nebula> ALTER TAG t1 TTL_DURATION = 2, TTL_COL = "p2"; nebula> ALTER TAG t1 COMMENT = 'test1'; nebula> ALTER TAG t1 ADD (p5 double NOT NULL DEFAULT 0.4 COMMENT 'p5') COMMENT='test2'; -// 修改 TAG `t1` 的 `p3` 属性为 INT8 类型 -nebula> ALTER TAG t1 CHANGE (p3 int8, p4 string); -[ERROR(-1005)]: Unsupported! +// 将 TAG t1 的 p3 属性类型从 INT32 改为 INT64，p4 属性类型从 FIXED_STRING(10) 改为 STRING。 +nebula> ALTER TAG t1 CHANGE (p3 int64, p4 string); ``` ## 修改 Tag 说明 From bdcfd9161cb1330952dac864315cb3dd5762a99b Mon Sep 17 00:00:00 2001 From: "abby.huang" <78209557+abby-cyber@users.noreply.github.com> Date: Thu, 23 Mar 2023 14:07:01 +0800 Subject: [PATCH 105/137] Update datatype convert example (#2677) * Update 3.alter-tag.md * Update 3.alter-tag.md * Update 3.alter-tag.md --- docs-2.0/3.ngql-guide/10.tag-statements/3.alter-tag.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/docs-2.0/3.ngql-guide/10.tag-statements/3.alter-tag.md b/docs-2.0/3.ngql-guide/10.tag-statements/3.alter-tag.md index 88aa9ed1e06..7c527f42b8f 100644 --- a/docs-2.0/3.ngql-guide/10.tag-statements/3.alter-tag.md +++ b/docs-2.0/3.ngql-guide/10.tag-statements/3.alter-tag.md @@ -10,9 +10,6 @@ - 确保新增的属性名不与已存在或被删除的属性名同名，否则新增属性会失败。 -- 仅允许**增加**`FIXED_STRING`和`INT`类型的长度，不允许减少长度。 -- 仅允许转换`FIXED_STRING`类型为`STRING`类型、转换`FLOAT`类型为`DOUBLE`类型。 - ## 语法 ```ngql @@ -35,6 +32,11 @@ ttl_definition: - 可以在一个`ALTER TAG`语句中使用多个`ADD`、`DROP`和`CHANGE`子句，子句之间用英文逗号（,）分隔。 - 当使用`ADD`或`CHANGE`指定属性值为`NOT NULL`时，必需为该属性指定默认值，即定义`DEFAULT`的值。 + +- 当使用`CHANGE`修改属性的数据类型时： + + - 仅允许修改`FIXED_STRING`和`INT`类型的长度为更大的长度，不允许减少长度。 + - 仅允许修改`FIXED_STRING`类型为`STRING`类型、修改`FLOAT`类型为`DOUBLE`类型。 ## 示例 From a82587f1f4714a0586ecc946e3999d01b34ca64a Mon Sep 17 00:00:00 2001 From: randomJoe211 <69501902+randomJoe211@users.noreply.github.com> Date: Thu, 23 Mar 2023 17:51:17 +0800 Subject: [PATCH 106/137] Update script tags in mkdocs.yml --- mkdocs.yml | 116 ++++++++++++++++++++++++++--------------------------- 1 file changed, 58 insertions(+), 58 deletions(-) diff --git a/mkdocs.yml b/mkdocs.yml index cc6808cad47..e4b7b5a4715 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -81,7 +81,7 @@ plugins: - spark-connector/* - 4.deployment-and-installation/5.zone.md - 4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-from-200-to-latest.md - # comm.begin + # exclude.ent.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 @@ -104,8 +104,8 @@ plugins: - 20.appendix/release-notes/explorer-release-note.md - 20.appendix/8.about-license.md - 4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-ent-from-3.x-3.4.md - # comm.end - # ent.begin + # exclude.ent.end + # exclude.comm.begin - backup-and-restore/nebula-br/* - 4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-graph-to-latest.md - nebula-studio/* @@ -113,7 +113,7 @@ plugins: - 20.appendix/release-notes/nebula-comm-release-note.md - 20.appendix/release-notes/studio-release-note.md - 20.appendix/release-notes/dashboard-comm-release-note.md - # ent.end + # exclude.comm.end # Exclude the file with the following file name. # - abc.md @@ -170,12 +170,12 @@ extra: base200: 2.0.0 branch: release-3.4 tag: v3.4.1 - # ent.begin + # nav.ent.begin name: 悦数图数据库 - # ent.end - # comm.begin + # nav.ent.end + # nav.comm.begin name: NebulaGraph - # comm.end + # nav.comm.end studio: base111b: 1.1.1-beta @@ -364,9 +364,9 @@ nav: - 条件表达式函数: 3.ngql-guide/6.functions-and-expressions/5.conditional-expressions.md - 谓词函数: 3.ngql-guide/6.functions-and-expressions/8.predicate.md - geo 函数: 3.ngql-guide/6.functions-and-expressions/14.geo.md - # ent.begin + # nav.ent.begin - 自定义函数: 3.ngql-guide/6.functions-and-expressions/9.user-defined-functions.md - # ent.end + # nav.ent.end - 通用查询语句: - MATCH: 3.ngql-guide/7.general-query-statements/2.match.md @@ -477,22 +477,22 @@ nav: - 使用 RPM/DEB 包部署多机集群: 4.deployment-and-installation/2.compile-and-install-nebula-graph/deploy-nebula-graph-cluster.md - 使用生态工具安装: 4.deployment-and-installation/2.compile-and-install-nebula-graph/6.deploy-nebula-graph-with-peripherals.md - 安装存算合并版 NebulaGraph: 4.deployment-and-installation/standalone-deployment.md - # ent.begin + # nav.ent.begin - 设置 NebulaGraph 企业版 License: 4.deployment-and-installation/deploy-license.md - # ent.end + # nav.ent.end - 管理服务: 4.deployment-and-installation/manage-service.md - 连接服务: 4.deployment-and-installation/connect-to-nebula-graph.md - 管理 Storage 主机: 4.deployment-and-installation/manage-storage-host.md # - 管理逻辑机架（Zone）: 4.deployment-and-installation/5.zone.md - 升级版本: - # comm.begin + # nav.comm.begin - 升级 NebulaGraph 至 v3.4（社区版）: 4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-graph-to-latest.md - # comm.end + # nav.comm.end # - 升级 v3.x 至 v3.4（社区版）: 4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-from-300-to-latest.md - # ent.begin + # nav.ent.begin - 升级 NebulaGraph 至 v3.4（企业版）: 4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-ent-from-3.x-3.4.md - # ent.end + # nav.ent.end - 卸载 NebulaGraph: 4.deployment-and-installation/4.uninstall-nebula-graph.md - 配置与日志: @@ -504,51 +504,51 @@ nav: - Linux 内核配置: 5.configurations-and-logs/1.configurations/6.kernel-config.md - 日志: - 运行日志: 5.configurations-and-logs/2.log-management/logs.md - # ent.begin + # nav.ent.begin - 审计日志（企业版）: 5.configurations-and-logs/2.log-management/audit-log.md - # ent.end + # nav.ent.end - 监控: - 查询 NebulaGraph 监控指标: 6.monitor-and-metrics/1.query-performance-metrics.md - RocksDB 统计数据: 6.monitor-and-metrics/2.rocksdb-statistics.md - # ent.begin + # nav.ent.begin - 黑匣子: - 黑匣子介绍: 6.monitor-and-metrics/3.bbox/3.1.bbox.md - Nebula-BBox 工具: 6.monitor-and-metrics/3.bbox/3.2.bbox-reviewer.md - # ent.end + # nav.ent.end - 数据安全: - 验证和授权: - 身份验证: 7.data-security/1.authentication/1.authentication.md - 用户管理: 7.data-security/1.authentication/2.management-user.md - 内置角色权限: 7.data-security/1.authentication/3.role-list.md - # ent.begin + # nav.ent.begin - OpenLDAP 验证: 7.data-security/1.authentication/4.ldap.md - # ent.end + # nav.ent.end - SSL 加密: 7.data-security/4.ssl.md - 备份与恢复: - # comm.begin + # nav.comm.begin - NebulaGraph BR（社区版）: - BR（社区版）概述: backup-and-restore/nebula-br/1.what-is-br.md - 安装 BR: backup-and-restore/nebula-br/2.compile-br.md - 使用 BR 备份数据: backup-and-restore/nebula-br/3.br-backup-data.md - 使用 BR 恢复数据: backup-and-restore/nebula-br/4.br-restore-data.md - # comm.end - # ent.begin + # nav.comm.end + # nav.ent.begin - NebulaGraph BR（企业版）: - BR（企业版）概述: backup-and-restore/nebula-br-ent/1.br-ent-overview.md - 安装 BR: backup-and-restore/nebula-br-ent/2.install-tools.md - 使用 BR 备份数据: backup-and-restore/nebula-br-ent/3.backup-data.md - 使用 BR 恢复数据: backup-and-restore/nebula-br-ent/4.restore-data.md - # ent.end + # nav.ent.end - 快照: backup-and-restore/3.manage-snapshot.md - 同步与迁移: - 负载均衡: synchronization-and-migration/2.balance-syntax.md - # ent.begin + # nav.ent.begin - 集群间数据同步: synchronization-and-migration/replication-between-clusters.md - # ent.end + # nav.ent.end - 最佳实践: - Compaction: 8.service-tuning/compaction.md @@ -571,7 +571,7 @@ nav: # - NebulaGraph Cloud: nebula-cloud.md - # ent.begin + # nav.ent.begin - NebulaGraph Cloud: - 什么是 NebulaGraph Cloud: nebula-cloud/1.what-is-cloud.md - Nebula Graph Cloud 阿里云版: @@ -579,7 +579,7 @@ nav: - 使用服务实例: nebula-cloud/nebula-cloud-on-alibabacloud/2.use-cloud-services.md - 扩缩容服务: nebula-cloud/nebula-cloud-on-alibabacloud/4.scaling-services.md - 删除服务实例: nebula-cloud/nebula-cloud-on-alibabacloud/3.delete-service-instance.md - # ent.end + # nav.ent.end # - NebulaGraph Cloud Azure版: # - 创建订阅: nebula-cloud/nebula-cloud-on-azure/2.how-to-create-subsciption.md @@ -594,7 +594,7 @@ nav: # - 用户服务条款: nebula-cloud/nebula-cloud-on-azure/7.terms-and-conditions.md # - 隐私政策条款: nebula-cloud/nebula-cloud-on-azure/8.privacy-policy.md - # comm.begin + # nav.comm.begin - NebulaGraph Studio: - 认识 NebulaGraph Studio: - 什么是 NebulaGraph Studio: nebula-studio/about-studio/st-ug-what-is-graph-studio.md @@ -618,18 +618,18 @@ nav: - 连接数据库错误: nebula-studio/troubleshooting/st-ug-config-server-errors.md - 无法访问 Studio: nebula-studio/troubleshooting/st-ug-connection-errors.md - Studio 常见问题: nebula-studio/troubleshooting/st-ug-faq.md - # comm.end + # nav.comm.end - # comm.begin + # nav.comm.begin - NebulaGraph Dashboard（社区版）: - 什么是 NebulaGraph Dashboard: nebula-dashboard/1.what-is-dashboard.md - 部署 Dashboard: nebula-dashboard/2.deploy-dashboard.md - 连接 Dashboard: nebula-dashboard/3.connect-dashboard.md - Dashboard 页面介绍: nebula-dashboard/4.use-dashboard.md - 监控指标说明: nebula-dashboard/6.monitor-parameter.md - # comm.end + # nav.comm.end - # ent.begin + # nav.ent.begin - NebulaGraph Dashboard（企业版）: - 什么是 NebulaGraph Dashboard 企业版: nebula-dashboard-ent/1.what-is-dashboard-ent.md - 部署 NebulaGraph Dashboard 企业版: nebula-dashboard-ent/2.deploy-connect-dashboard-ent.md @@ -667,9 +667,9 @@ nav: - 安装包管理: nebula-dashboard-ent/system-settings/manage-package.md - 监控指标说明: nebula-dashboard-ent/7.monitor-parameter.md - 常见问题 FAQ: nebula-dashboard-ent/8.faq.md - # ent.end + # nav.ent.end - # ent.begin + # nav.ent.begin - NebulaGraph Explorer: - 什么是 NebulaGraph Explorer: nebula-explorer/about-explorer/ex-ug-what-is-explorer.md - 安装与登录: @@ -713,7 +713,7 @@ nav: - 内联框架: nebula-explorer/iframe.md - 基本操作和快捷键: nebula-explorer/ex-ug-shortcuts.md - 常见问题 FAQ: nebula-explorer/faq.md - # ent.end + # nav.ent.end - NebulaGraph Importer: - 使用 NebulaGraph Importer: nebula-importer/use-importer.md @@ -744,9 +744,9 @@ nav: - 导入 Kafka 数据: nebula-exchange/use-exchange/ex-ug-import-from-kafka.md - 导入通用 JDBC 数据: nebula-exchange/use-exchange/ex-ug-import-from-jdbc.md - 导入 SST 文件数据: nebula-exchange/use-exchange/ex-ug-import-from-sst.md - # ent.begin + # nav.ent.begin - 导出 NebulaGraph 数据: nebula-exchange/use-exchange/ex-ug-export-from-nebula.md - # ent.end + # nav.ent.end - Exchange 常见问题: nebula-exchange/ex-ug-FAQ.md - NebulaGraph Operator: @@ -760,15 +760,15 @@ nav: - 配置 NebulaGraph: - 自定义 NebulaGraph 集群的配置参数: nebula-operator/8.custom-cluster-configurations/8.1.custom-conf-parameter.md - 回收 PV: nebula-operator/8.custom-cluster-configurations/8.2.pv-reclaim.md - # ent.begin + # nav.ent.begin - 均衡扩容后的 Storage 数据: nebula-operator/8.custom-cluster-configurations/8.3.balance-data-when-scaling-storage.md - # ent.end + # nav.ent.end - 管理集群日志: nebula-operator/8.custom-cluster-configurations/8.4.manage-running-logs.md - 升级 NebulaGraph: nebula-operator/9.upgrade-nebula-cluster.md - 配置滚动更新策略: nebula-operator/11.rolling-update-strategy.md - # ent.begin + # nav.ent.begin - 备份与恢复: nebula-operator/10.backup-restore-using-operator.md - # ent.end + # nav.ent.end - 故障自愈: nebula-operator/5.operator-failover.md - 常见问题: nebula-operator/7.operator-faq.md @@ -788,28 +788,28 @@ nav: - 附录: - Release Note: - # comm.begin + # nav.comm.begin - NebulaGraph 社区版: 20.appendix/release-notes/nebula-comm-release-note.md - # comm.end - # ent.begin + # nav.comm.end + # nav.ent.begin - NebulaGraph 企业版: 20.appendix/release-notes/nebula-ent-release-note.md - # ent.end - # comm.begin + # nav.ent.end + # nav.comm.begin - NebulaGraph Studio: 20.appendix/release-notes/studio-release-note.md - # comm.end - # comm.begin + # nav.comm.end + # nav.comm.begin - NebulaGraph Dashboard 社区版: 20.appendix/release-notes/dashboard-comm-release-note.md - # comm.end - # ent.begin + # nav.comm.end + # nav.ent.begin - NebulaGraph Dashboard 企业版: 20.appendix/release-notes/dashboard-ent-release-note.md - # ent.end - # ent.begin + # nav.ent.end + # nav.ent.begin - NebulaGraph Explorer: 20.appendix/release-notes/explorer-release-note.md - # ent.end + # nav.ent.end - 学习路径: 20.appendix/learning-path.md - # ent.begin + # nav.ent.begin - 关于 License: 20.appendix/8.about-license.md - # ent.end + # nav.ent.end - 常见问题 FAQ: 20.appendix/0.FAQ.md - 生态工具概览: 20.appendix/6.eco-tool-version.md - 导入工具选择: 20.appendix/write-tools.md From 1fc0c7c03cf033796bdce1d63bfcbde1fb8680ed Mon Sep 17 00:00:00 2001 From: randomJoe211 <69501902+randomJoe211@users.noreply.github.com> Date: Fri, 24 Mar 2023 10:26:05 +0800 Subject: [PATCH 107/137] Update conditional_yml.py --- scripts/conditional_yml.py | 30 ++++++++++++++---------------- 1 file changed, 14 insertions(+), 16 deletions(-) diff --git a/scripts/conditional_yml.py b/scripts/conditional_yml.py index fa8cdf410e0..c38ba3d6a4d 100644 --- a/scripts/conditional_yml.py +++ b/scripts/conditional_yml.py @@ -1,10 +1,3 @@ -# Rules for processing the mkdocs.yml file: -# - When `database_edition` is `community`, keep all content between tags `# ent.begin` and `# ent.end`, and delete all content between tags `# comm.begin` and `# comm.end`. -# - When `database_edition` is `enterprise`, keep all content between `# comm.begin` and `# comm.end`, and delete all content between `# ent.begin` and `# ent.end` -# - When `database_edition` is `both`, delete all content between `# ent.begin` and `# ent.end`, and between `# comm.begin` and `# comm.end`. -# - Always keep the tags. - -import os import re import yaml @@ -15,25 +8,30 @@ def process_mkdocs_yml(mkdocs_yml_path, database_edition): content = f.read() if database_edition == 'enterprise': content = re.sub( - r'#\s*ent\.begin(.*?)#\s*ent\.end', + r'#\s*exclude\.ent\.begin(.*?)#\s*exclude\.ent\.end', '', content, flags=re.DOTALL) content = re.sub( - r'#\s*comm\.begin(.*?)#\s*comm\.end', + r'#\s*exclude\.comm\.begin(.*?)#\s*exclude\.comm\.end', '\\1', content, flags=re.DOTALL) - elif database_edition == 'community': content = re.sub( - r'#\s*ent\.begin(.*?)#\s*ent\.end', + r'#\s*nav\.ent\.begin(.*?)#\s*nav\.ent\.end', '\\1', content, flags=re.DOTALL) content = re.sub( - r'#\s*comm\.begin(.*?)#\s*comm\.end', + r'#\s*nav\.comm\.begin(.*?)#\s*nav\.comm\.end', '', content, flags=re.DOTALL) - elif database_edition == 'both': + elif database_edition == 'community': content = re.sub( - r'#\s*ent\.begin(.*?)#\s*ent\.end', + r'#\s*exclude\.ent\.begin(.*?)#\s*exclude\.ent\.end', + '\\1', content, flags=re.DOTALL) + content = re.sub( + r'#\s*exclude\.comm\.begin(.*?)#\s*exclude\.comm\.end', '', content, flags=re.DOTALL) content = re.sub( - r'#\s*comm\.begin(.*?)#\s*comm\.end', + r'#\s*nav\.ent\.begin(.*?)#\s*nav\.ent\.end', '', content, flags=re.DOTALL) + content = re.sub( + r'#\s*nav\.comm\.begin(.*?)#\s*nav\.comm\.end', + '\\1', content, flags=re.DOTALL) with open(mkdocs_yml_path, 'w', encoding='utf-8') as f: f.write(content) @@ -44,4 +42,4 @@ def process_mkdocs_yml(mkdocs_yml_path, database_edition): database_edition = config.get("extra", {}).get("database_edition", "both") if database_edition not in ['community', 'enterprise', 'both']: raise ValueError("Invalid value for database_edition: {}".format(database_edition)) - process_mkdocs_yml(mkdocs_yml_path, database_edition) \ No newline at end of file + process_mkdocs_yml(mkdocs_yml_path, database_edition) From 641ea969aedef69bd36df98f1eae6d1e688aad2b Mon Sep 17 00:00:00 2001 From: randomJoe211 <69501902+randomJoe211@users.noreply.github.com> Date: Fri, 24 Mar 2023 14:43:34 +0800 Subject: [PATCH 108/137] add rule details --- scripts/conditional_yml.py | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/scripts/conditional_yml.py b/scripts/conditional_yml.py index c38ba3d6a4d..ca2baad1354 100644 --- a/scripts/conditional_yml.py +++ b/scripts/conditional_yml.py @@ -1,3 +1,19 @@ +# This script processes the 'mkdocs.yml' file based on the value of 'database_edition' in the following manner: + +# 1. If the value of 'database_edition' is 'enterprise': +# - Remove the text between '# exclude.ent.begin' and '# exclude.ent.end' +# - Keep the text between '# exclude.comm.begin' and '# exclude.comm.end' +# - Keep the text between '# nav.ent.begin' and '# nav.ent.end' +# - Remove the text between '# nav.comm.begin' and '# nav.comm.end' + +# 2. If the value of 'database_edition' is 'community': +# - Keep the text between '# exclude.ent.begin' and '# exclude.ent.end' +# - Remove the text between '# exclude.comm.begin' and '# exclude.comm.end' +# - Remove the text between '# nav.ent.begin' and '# nav.ent.end' +# - Keep the text between '# nav.comm.begin' and '# nav.comm.end' + +# 3. If the value of 'database_edition' is 'both', no changes are made to the file content. + import re import yaml From 9db81cc41de7d5315afdbcb1969c4b7af1de7d6c Mon Sep 17 00:00:00 2001 From: "abby.huang" <78209557+abby-cyber@users.noreply.github.com> Date: Fri, 24 Mar 2023 17:43:10 +0800 Subject: [PATCH 109/137] specify-expression-of-returning-properties-for-edges (#2679) --- .../8.clauses-and-options/return.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/docs-2.0/3.ngql-guide/8.clauses-and-options/return.md b/docs-2.0/3.ngql-guide/8.clauses-and-options/return.md index 61f12418453..22c617b04e9 100644 --- a/docs-2.0/3.ngql-guide/8.clauses-and-options/return.md +++ b/docs-2.0/3.ngql-guide/8.clauses-and-options/return.md @@ -129,9 +129,10 @@ nebula> MATCH (v:player{name:"Tim Duncan"}) \ ## 返回属性 -使用语法`{|}.`返回点或边的属性。 +使用语法`..`返回点的属性；使用语法`.`返回边的属性。 ```ngql +// 返回点的属性 nebula> MATCH (v:player) \ RETURN v.player.name, v.player.age \ LIMIT 3; @@ -144,6 +145,20 @@ nebula> MATCH (v:player) \ +------------------+--------------+ ``` +```ngql +// 返回边的属性 +nebula> MATCH (v:player{name:"Tim Duncan"})-[e]->() \ + RETURN e.start_year, e.degree \ ++--------------+----------+ +| e.start_year | e.degree | ++--------------+----------+ +| __NULL__ | 95 | +| __NULL__ | 95 | +| 1997 | __NULL__ | ++--------------+----------+ +``` + + 使用`properties()`函数返回点或边的所有属性。 ```ngql From 945dc2ea67659149974cf9565f7e06bf49a982c7 Mon Sep 17 00:00:00 2001 From: cooper-lzy <78672629+cooper-lzy@users.noreply.github.com> Date: Tue, 28 Mar 2023 14:03:50 +0800 Subject: [PATCH 110/137] Update 3.graph-config.md --- .../1.configurations/3.graph-config.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs-2.0/5.configurations-and-logs/1.configurations/3.graph-config.md b/docs-2.0/5.configurations-and-logs/1.configurations/3.graph-config.md index 3fa2971c8ff..d648f9945bd 100644 --- a/docs-2.0/5.configurations-and-logs/1.configurations/3.graph-config.md +++ b/docs-2.0/5.configurations-and-logs/1.configurations/3.graph-config.md @@ -67,8 +67,8 @@ Graph 服务提供了两份初始配置文件`nebula-graphd.conf.default`和`neb | `port` | `9669` | Graph 服务的 RPC 守护进程监听端口。 |不支持| |`reuse_port` |`false` | 是否启用 SO_REUSEPORT。 |不支持| |`listen_backlog` |`1024` | socket 监听的连接队列最大长度，调整本参数需要同时调整`net.core.somaxconn`。 |不支持| -|`client_idle_timeout_secs` |`28800` | 空闲连接的超时时间。默认 8 小时。`0`表示永不超时。单位：秒。 |不支持| -|`session_idle_timeout_secs` |`28800` | 空闲会话的超时时间。取值范围为 1~604800。默认 8 小时。单位：秒。 |不支持| +|`client_idle_timeout_secs` |`28800` | 空闲连接的超时时间。取值范围为 1~604800。默认 8 小时。单位：秒。 | +|`session_idle_timeout_secs` |`28800` | 空闲会话的超时时间。取值范围为 1~604800。默认 8 小时。单位：秒。 | |`num_accept_threads` |`1` | 接受传入连接的线程数。 |不支持| |`num_netio_threads` |`0` | 网络 IO 线程数。`0`表示 CPU 核数。 |不支持| |`num_worker_threads` |`0` | 执行用户查询的线程数。`0`表示 CPU 核数。 |不支持| From 56ce39ad27d0184de4345bb78ebecafe443cebbf Mon Sep 17 00:00:00 2001 From: "abby.huang" <78209557+abby-cyber@users.noreply.github.com> Date: Tue, 28 Mar 2023 14:59:47 +0800 Subject: [PATCH 111/137] add-schema-name-restrictions (#2690) --- docs-2.0/3.ngql-guide/10.tag-statements/1.create-tag.md | 4 ++-- .../3.ngql-guide/11.edge-type-statements/1.create-edge.md | 2 +- docs-2.0/3.ngql-guide/9.space-statements/1.create-space.md | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs-2.0/3.ngql-guide/10.tag-statements/1.create-tag.md b/docs-2.0/3.ngql-guide/10.tag-statements/1.create-tag.md index ed95702abfe..77f6eab5307 100644 --- a/docs-2.0/3.ngql-guide/10.tag-statements/1.create-tag.md +++ b/docs-2.0/3.ngql-guide/10.tag-statements/1.create-tag.md @@ -31,10 +31,10 @@ CREATE TAG [IF NOT EXISTS] |参数|说明| |:---|:---| |`IF NOT EXISTS`|检测待创建的 Tag 是否存在，只有不存在时，才会创建 Tag。仅检测 Tag 的名称，不会检测具体属性。| -|``|1、每个图空间内的 Tag 必须是唯一的。
2、Tag 名称设置后无法修改。
3、支持 1~4 字节的 UTF-8 编码字符，包括英文字母（区分大小写）、数字、中文、日文、韩文等，但是不包括除下划线外的特殊字符。使用特殊字符或保留关键字时，需要用反引号（\`）包围且不能使用英文句号（`.`），详情参见[关键字和保留字](../../3.ngql-guide/1.nGQL-overview/keywords-and-reserved-words.md)。| +|``|1、每个图空间内的 Tag 必须是唯一的。
2、Tag 名称设置后无法修改。
3、不能以数字开头；支持 1~4 字节的 UTF-8 编码字符，包括英文字母（区分大小写）、数字、中文等，但是不包括除下划线外的特殊字符；使用特殊字符、保留关键字或数字开头时，需要用反引号（\`）包围且不能使用英文句号（`.`）。详情参见[关键字和保留字](../../3.ngql-guide/1.nGQL-overview/keywords-and-reserved-words.md)。| |``|属性名称。每个 Tag 中的属性名称必须唯一。属性的命名规则与 Tag 相同。| |``|属性的数据类型，目前支持[数值](../3.data-types/1.numeric.md)、[布尔](../3.data-types/2.boolean.md)、[字符串](../3.data-types/3.string.md)以及[日期与时间](../3.data-types/4.date-and-time.md)。| -|`NULL \| NOT NULL`|指定属性值是否支持为`NULL`。默认值为`NULL`。当指定属性值为`NOT NULL`时，必需指定属性的默认值，也就是`DEFAULT`的值。| +|`NULL \| NOT NULL`|指定属性值是否支持为`NULL`。默认值为`NULL`。当指定属性值为`NOT NULL`时，必需指定属性的默认值，也就是`DEFAULT`的值。| |`DEFAULT`|指定属性的默认值。默认值可以是一个文字值或 NebulaGraph 支持的表达式。如果插入点时没有指定某个属性的值，则使用默认值。| |`COMMENT`|对单个属性或 Tag 的描述。最大为 256 字节。默认无描述。| |`TTL_DURATION`|指定时间戳差值，单位：秒。时间戳差值必须为 64 位非负整数。属性值和时间戳差值之和如果小于当前时间戳，属性就会过期。默认值为`0`，表示属性永不过期。| diff --git a/docs-2.0/3.ngql-guide/11.edge-type-statements/1.create-edge.md b/docs-2.0/3.ngql-guide/11.edge-type-statements/1.create-edge.md index 5fffdd1134d..35de47d6ec9 100644 --- a/docs-2.0/3.ngql-guide/11.edge-type-statements/1.create-edge.md +++ b/docs-2.0/3.ngql-guide/11.edge-type-statements/1.create-edge.md @@ -31,7 +31,7 @@ CREATE EDGE [IF NOT EXISTS] |参数|说明| |:---|:---| |`IF NOT EXISTS`|检测待创建的 Edge type 是否存在，只有不存在时，才会创建 Edge type。仅检测 Edge type 的名称，不会检测具体属性。| -|``|每个图空间内的 Edge type 必须是唯一的。Edge type 名称设置后无法修改。Edge type 名称以英文字母开头，支持 1~4 字节的 UTF-8 编码字符，包括英文字母（区分大小写）、数字、中文等，但是不包括除下划线外的特殊字符。使用特殊字符或保留关键字时，需要用反引号（\`）包围，详情参见[关键字和保留字](../../3.ngql-guide/1.nGQL-overview/keywords-and-reserved-words.md)。| +|``|1、每个图空间内的 Edge type 必须是唯一的。
2、Edge type 名称设置后无法修改。
3、不能以数字开头；支持 1~4 字节的 UTF-8 编码字符，包括英文字母（区分大小写）、数字、中文等，但是不包括除下划线外的特殊字符；使用特殊字符、保留关键字或数字开头时，需要用反引号（\`）包围且不能使用英文句号（`.`）。详情参见[关键字和保留字](../../3.ngql-guide/1.nGQL-overview/keywords-and-reserved-words.md)。| |``|属性名称。每个 Edge type 中的属性名称必须唯一。属性的命名规则与 Edge type 相同。| |``|属性的数据类型，目前支持[数值](../3.data-types/1.numeric.md)、[布尔](../3.data-types/2.boolean.md)、[字符串](../3.data-types/3.string.md)以及[日期与时间](../3.data-types/4.date-and-time.md)。| |`NULL \| NOT NULL`|指定属性值是否支持为`NULL`。默认值为`NULL`。当指定属性值为`NOT NULL`时，必需指定属性的默认值，也就是`DEFAULT`的值。| diff --git a/docs-2.0/3.ngql-guide/9.space-statements/1.create-space.md b/docs-2.0/3.ngql-guide/9.space-statements/1.create-space.md index 97b7afb66e5..b8a00bbe600 100644 --- a/docs-2.0/3.ngql-guide/9.space-statements/1.create-space.md +++ b/docs-2.0/3.ngql-guide/9.space-statements/1.create-space.md @@ -22,7 +22,7 @@ CREATE SPACE [IF NOT EXISTS] ( |参数|说明| |:---|:---| |`IF NOT EXISTS`|检测待创建的图空间是否存在，只有不存在时，才会创建图空间。仅检测图空间的名称，不会检测具体属性。| -|``|在 NebulaGraph 实例中唯一标识一个图空间。图空间名称以英文字母开头，支持 1~4 字节的 UTF-8 编码字符，包括英文字母（区分大小写）、数字、中文等，但是不包括除下划线外的特殊字符。使用特殊字符或保留关键字时，需要用反引号（\`）包围，详情参见[关键字和保留字](../../3.ngql-guide/1.nGQL-overview/keywords-and-reserved-words.md)。| +|``|1、在 NebulaGraph 实例中唯一标识一个图空间。
2、图空间名称设置后无法被修改。
3、不能以数字开头；支持 1~4 字节的 UTF-8 编码字符，包括英文字母（区分大小写）、数字、中文等，但是不包括除下划线外的特殊字符；使用特殊字符、保留关键字或数字开头时，需要用反引号（\`）包围且不能使用英文句号（`.`）。详情参见[关键字和保留字](../../3.ngql-guide/1.nGQL-overview/keywords-and-reserved-words.md)。| |`partition_num`|指定图空间的分片数量。建议设置为集群中硬盘数量的 20 倍（HDD 硬盘建议为 2 倍）。例如集群中有 3 个硬盘，建议设置 60 个分片。默认值为 100。| |`replica_factor`|指定每个分片的副本数量。建议在生产环境中设置为 3，在测试环境中设置为 1。由于需要基于多数表决，副本数量必须是**奇数**。默认值为 1。| |`vid_type`|必选参数。指定点 ID 的数据类型。可选值为`FIXED_STRING()`和`INT64`。`INT`等同于`INT64`。
`FIXED_STRING()`表示数据类型为定长字符串，长度为`N`字节，超出长度会报错。例如，UTF-8中，一个中文字符的长度为三个字节，如果设置`N`为 12，那么`vid_type`为最多 4 个中文字符。
`INT64`表示数据类型为整数。| From 337cd5a98f6a2a5497f68d4ae857b1e9ea3f76ea Mon Sep 17 00:00:00 2001 From: Abby <78209557+abby-cyber@users.noreply.github.com> Date: Wed, 29 Mar 2023 16:32:17 +0800 Subject: [PATCH 112/137] add a restriction for adding Chinese schema names --- docs-2.0/3.ngql-guide/10.tag-statements/1.create-tag.md | 2 +- docs-2.0/3.ngql-guide/11.edge-type-statements/1.create-edge.md | 2 +- .../14.native-index-statements/1.create-native-index.md | 2 +- docs-2.0/3.ngql-guide/9.space-statements/1.create-space.md | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs-2.0/3.ngql-guide/10.tag-statements/1.create-tag.md b/docs-2.0/3.ngql-guide/10.tag-statements/1.create-tag.md index 77f6eab5307..2c82375186b 100644 --- a/docs-2.0/3.ngql-guide/10.tag-statements/1.create-tag.md +++ b/docs-2.0/3.ngql-guide/10.tag-statements/1.create-tag.md @@ -31,7 +31,7 @@ CREATE TAG [IF NOT EXISTS] |参数|说明| |:---|:---| |`IF NOT EXISTS`|检测待创建的 Tag 是否存在，只有不存在时，才会创建 Tag。仅检测 Tag 的名称，不会检测具体属性。| -|``|1、每个图空间内的 Tag 必须是唯一的。
2、Tag 名称设置后无法修改。
3、不能以数字开头；支持 1~4 字节的 UTF-8 编码字符，包括英文字母（区分大小写）、数字、中文等，但是不包括除下划线外的特殊字符；使用特殊字符、保留关键字或数字开头时，需要用反引号（\`）包围且不能使用英文句号（`.`）。详情参见[关键字和保留字](../../3.ngql-guide/1.nGQL-overview/keywords-and-reserved-words.md)。| +|``|1、每个图空间内的 Tag 必须是唯一的。
2、Tag 名称设置后无法修改。
3、不能以数字开头；支持 1~4 字节的 UTF-8 编码字符，包括英文字母（区分大小写）、数字、中文等，但是不包括除下划线外的特殊字符；使用特殊字符、保留关键字或数字开头时，需要用反引号（\`）包围且不能使用英文句号（`.`）。详情参见[关键字和保留字](../../3.ngql-guide/1.nGQL-overview/keywords-and-reserved-words.md)。
**注意**：如果以中文命名 Tag，报`SyntaxError`错误时，需使用反引号（\`）包围中文字符。| |``|属性名称。每个 Tag 中的属性名称必须唯一。属性的命名规则与 Tag 相同。| |``|属性的数据类型，目前支持[数值](../3.data-types/1.numeric.md)、[布尔](../3.data-types/2.boolean.md)、[字符串](../3.data-types/3.string.md)以及[日期与时间](../3.data-types/4.date-and-time.md)。| |`NULL \| NOT NULL`|指定属性值是否支持为`NULL`。默认值为`NULL`。当指定属性值为`NOT NULL`时，必需指定属性的默认值，也就是`DEFAULT`的值。| diff --git a/docs-2.0/3.ngql-guide/11.edge-type-statements/1.create-edge.md b/docs-2.0/3.ngql-guide/11.edge-type-statements/1.create-edge.md index 35de47d6ec9..c0e9c16b57b 100644 --- a/docs-2.0/3.ngql-guide/11.edge-type-statements/1.create-edge.md +++ b/docs-2.0/3.ngql-guide/11.edge-type-statements/1.create-edge.md @@ -31,7 +31,7 @@ CREATE EDGE [IF NOT EXISTS] |参数|说明| |:---|:---| |`IF NOT EXISTS`|检测待创建的 Edge type 是否存在，只有不存在时，才会创建 Edge type。仅检测 Edge type 的名称，不会检测具体属性。| -|``|1、每个图空间内的 Edge type 必须是唯一的。
2、Edge type 名称设置后无法修改。
3、不能以数字开头；支持 1~4 字节的 UTF-8 编码字符，包括英文字母（区分大小写）、数字、中文等，但是不包括除下划线外的特殊字符；使用特殊字符、保留关键字或数字开头时，需要用反引号（\`）包围且不能使用英文句号（`.`）。详情参见[关键字和保留字](../../3.ngql-guide/1.nGQL-overview/keywords-and-reserved-words.md)。| +|``|1、每个图空间内的 Edge type 必须是唯一的。
2、Edge type 名称设置后无法修改。
3、不能以数字开头；支持 1~4 字节的 UTF-8 编码字符，包括英文字母（区分大小写）、数字、中文等，但是不包括除下划线外的特殊字符；使用特殊字符、保留关键字或数字开头时，需要用反引号（\`）包围且不能使用英文句号（`.`）。详情参见[关键字和保留字](../../3.ngql-guide/1.nGQL-overview/keywords-and-reserved-words.md)。
**注意**：如果以中文命名 Edge type，报`SyntaxError`错误时，需使用反引号（\`）包围中文字符。| |``|属性名称。每个 Edge type 中的属性名称必须唯一。属性的命名规则与 Edge type 相同。| |``|属性的数据类型，目前支持[数值](../3.data-types/1.numeric.md)、[布尔](../3.data-types/2.boolean.md)、[字符串](../3.data-types/3.string.md)以及[日期与时间](../3.data-types/4.date-and-time.md)。| |`NULL \| NOT NULL`|指定属性值是否支持为`NULL`。默认值为`NULL`。当指定属性值为`NOT NULL`时，必需指定属性的默认值，也就是`DEFAULT`的值。| diff --git a/docs-2.0/3.ngql-guide/14.native-index-statements/1.create-native-index.md b/docs-2.0/3.ngql-guide/14.native-index-statements/1.create-native-index.md index 947c79f00cc..af4643fae96 100644 --- a/docs-2.0/3.ngql-guide/14.native-index-statements/1.create-native-index.md +++ b/docs-2.0/3.ngql-guide/14.native-index-statements/1.create-native-index.md @@ -70,7 +70,7 @@ CREATE {TAG | EDGE} INDEX [IF NOT EXISTS] ON { | `|索引名。索引名在一个图空间中必须是唯一的。推荐的命名方式为`i_tagName_propName`。索引名称以英文字母开头，支持 1~4 字节的 UTF-8 编码字符，包括英文字母（区分大小写）、数字、中文等，但是不包括除下划线外的特殊字符。使用特殊字符或保留关键字时，需要用反引号（\`）包围，详情参见[关键字和保留字](../../3.ngql-guide/1.nGQL-overview/keywords-and-reserved-words.md)。| +|``|索引名。索引名在一个图空间中必须是唯一的。推荐的命名方式为`i_tagName_propName`。
索引名称不能以数字开头，支持 1~4 字节的 UTF-8 编码字符，包括英文字母（区分大小写）、数字、中文等，但是不包括除下划线外的特殊字符。使用特殊字符、保留关键字或数字开头时，需要用反引号（\`）包围，详情参见[关键字和保留字](../../3.ngql-guide/1.nGQL-overview/keywords-and-reserved-words.md)。
**注意**：如果以中文为索引命名，报`SyntaxError`错误时，需使用反引号（\`）包围中文字符。| |` | `|指定索引关联的 Tag 或 Edge 名称。| |``|为**变长**字符串属性创建索引时，必须用`prop_name(length)`指定索引长度；为 Tag 或 Edge type 本身创建索引时，忽略``。| |`COMMENT`|索引的描述。最大为 256 字节。默认无描述。| diff --git a/docs-2.0/3.ngql-guide/9.space-statements/1.create-space.md b/docs-2.0/3.ngql-guide/9.space-statements/1.create-space.md index b8a00bbe600..76e66aac572 100644 --- a/docs-2.0/3.ngql-guide/9.space-statements/1.create-space.md +++ b/docs-2.0/3.ngql-guide/9.space-statements/1.create-space.md @@ -22,7 +22,7 @@ CREATE SPACE [IF NOT EXISTS] ( |参数|说明| |:---|:---| |`IF NOT EXISTS`|检测待创建的图空间是否存在，只有不存在时，才会创建图空间。仅检测图空间的名称，不会检测具体属性。| -|``|1、在 NebulaGraph 实例中唯一标识一个图空间。
2、图空间名称设置后无法被修改。
3、不能以数字开头；支持 1~4 字节的 UTF-8 编码字符，包括英文字母（区分大小写）、数字、中文等，但是不包括除下划线外的特殊字符；使用特殊字符、保留关键字或数字开头时，需要用反引号（\`）包围且不能使用英文句号（`.`）。详情参见[关键字和保留字](../../3.ngql-guide/1.nGQL-overview/keywords-and-reserved-words.md)。| +|``|1、在 NebulaGraph 实例中唯一标识一个图空间。
2、图空间名称设置后无法被修改。
3、不能以数字开头；支持 1~4 字节的 UTF-8 编码字符，包括英文字母（区分大小写）、数字、中文等，但是不包括除下划线外的特殊字符；使用特殊字符、保留关键字或数字开头时，需要用反引号（\`）包围且不能使用英文句号（`.`）。详情参见[关键字和保留字](../../3.ngql-guide/1.nGQL-overview/keywords-and-reserved-words.md)。
**注意**：如果以中文为图空间命名，报`SyntaxError`错误时，需使用反引号（\`）包围中文字符。| |`partition_num`|指定图空间的分片数量。建议设置为集群中硬盘数量的 20 倍（HDD 硬盘建议为 2 倍）。例如集群中有 3 个硬盘，建议设置 60 个分片。默认值为 100。| |`replica_factor`|指定每个分片的副本数量。建议在生产环境中设置为 3，在测试环境中设置为 1。由于需要基于多数表决，副本数量必须是**奇数**。默认值为 1。| |`vid_type`|必选参数。指定点 ID 的数据类型。可选值为`FIXED_STRING()`和`INT64`。`INT`等同于`INT64`。
`FIXED_STRING()`表示数据类型为定长字符串，长度为`N`字节，超出长度会报错。例如，UTF-8中，一个中文字符的长度为三个字节，如果设置`N`为 12，那么`vid_type`为最多 4 个中文字符。
`INT64`表示数据类型为整数。| From 66b345278081a35e95152357525c46942854df2d Mon Sep 17 00:00:00 2001 From: "abby.huang" <78209557+abby-cyber@users.noreply.github.com> Date: Wed, 29 Mar 2023 16:53:41 +0800 Subject: [PATCH 113/137] add a restriction for adding Chinese schema names (#2694) From ea6fa618a9cee4b3205d1833c2537dedb3709b50 Mon Sep 17 00:00:00 2001 From: cooper-lzy <78672629+cooper-lzy@users.noreply.github.com> Date: Thu, 30 Mar 2023 16:27:12 +0800 Subject: [PATCH 114/137] Update ex-ug-para-import-command.md --- .../parameter-reference/ex-ug-para-import-command.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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 8c0d170d240..8d52c02abb7 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 @@ -21,7 +21,7 @@ !!! faq - 如果使用 [yarn-cluster 模式](https://spark-reference-doc-cn.readthedocs.io/zh_CN/latest/deploy-guide/running-on-yarn.html)提交任务，请参考如下示例，，**尤其是示例中的两个**`--conf`。 + 如果使用 [yarn-cluster 模式](https://spark-reference-doc-cn.readthedocs.io/zh_CN/latest/deploy-guide/running-on-yarn.html)提交任务，请参考如下示例，**尤其是示例中的两个**`--conf`。 ```bash $SPARK_HOME/bin/spark-submit --master yarn-cluster \ From 5cda5a1f8628823326f75a1ea4e6365c1c543615 Mon Sep 17 00:00:00 2001 From: "abby.huang" <78209557+abby-cyber@users.noreply.github.com> Date: Thu, 30 Mar 2023 18:14:22 +0800 Subject: [PATCH 115/137] add-step-of-install-thirdlib (#2697) --- ...1.install-nebula-graph-by-compiling-the-source-code.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) 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 66e31683db3..8691d4a3033 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 @@ -28,15 +28,17 @@ $ git clone https://github.com/vesoft-inc/nebula.git ``` -2. 进入目录`nebula`。 +2. 进入`nebula/third-party`目录，安装 NebulaGraph 依赖的第三方库。 ```bash - $ cd nebula + $ cd nebula/third-party + $ ./install-third-party.sh ``` -3. 创建目录`build`并进入该目录。 +3. 返回`nebula`目录，创建目录`build`并进入该目录。 ```bash + $ cd .. $ mkdir build && cd build ``` From 836b54f71ce06d27430564b9cc662353db2a684c Mon Sep 17 00:00:00 2001 From: "abby.huang" <78209557+abby-cyber@users.noreply.github.com> Date: Fri, 7 Apr 2023 14:01:41 +0800 Subject: [PATCH 116/137] balance-leader-balances-all-the-leaders-within-all-spaces (#2709) Update docs-2.0/2.quick-start/6.cheatsheet-for-ngql-command.md --- docs-2.0/2.quick-start/6.cheatsheet-for-ngql-command.md | 2 +- docs-2.0/synchronization-and-migration/2.balance-syntax.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs-2.0/2.quick-start/6.cheatsheet-for-ngql-command.md b/docs-2.0/2.quick-start/6.cheatsheet-for-ngql-command.md index 5b48a2c7c2a..6e2c30e3f25 100644 --- a/docs-2.0/2.quick-start/6.cheatsheet-for-ngql-command.md +++ b/docs-2.0/2.quick-start/6.cheatsheet-for-ngql-command.md @@ -436,7 +436,7 @@ | 语法 | 说明 | | :-------------------------------- | :----------------------------------------------------------- | - |`BALANCE LEADER`|在当前图空间内启动任务均衡分布 leader。该命令会返回任务 ID。| + |`BALANCE LEADER`|启动任务均衡分布所有图空间中的 leader。该命令会返回任务 ID。| -* [Foesa 小学姐课堂——NebulaGraph 那些磨人的概念](https://www.bilibili.com/video/BV1Q5411K7Gg)（04 分 20 秒） +* [Foesa 小学姐课堂——{{nebula.name}}那些磨人的概念](https://www.bilibili.com/video/BV1Q5411K7Gg)（04 分 20 秒） diff --git a/docs-2.0/2.quick-start/2.quick-start-on-cloud/1.create-instance-on-cloud.md b/docs-2.0/2.quick-start/2.quick-start-on-cloud/1.create-instance-on-cloud.md index 4b328c385f6..2fd34f52431 100644 --- a/docs-2.0/2.quick-start/2.quick-start-on-cloud/1.create-instance-on-cloud.md +++ b/docs-2.0/2.quick-start/2.quick-start-on-cloud/1.create-instance-on-cloud.md @@ -1,14 +1,14 @@ # 创建云服务实例 -用户可以在云服务上创建 NebulaGraph 实例，本文介绍如何在阿里云上快速创建 NebulaGraph 实例。 +用户可以在云服务上创建{{nebula.name}}实例，本文介绍如何在阿里云上快速创建{{nebula.name}}实例。 ## 背景信息 -NebulaGraph 支持在多个云平台上部署 NebulaGraph，本文只介绍如何在 NebulaGraph Cloud 阿里云版创建 NebulaGraph 实例。更多云服务平台的支持情况，参见 [NebulaGraph Cloud](https://docs.nebula-graph.com.cn/{{cloud.aliyunLatestRelease}}/nebula-cloud/1.what-is-cloud/)。 +{{nebula.name}}支持在多个云平台上部署{{nebula.name}}，本文只介绍如何在 NebulaGraph Cloud 阿里云版创建{{nebula.name}}实例。更多云服务平台的支持情况，参见 [NebulaGraph Cloud](https://docs.nebula-graph.com.cn/{{cloud.aliyunLatestRelease}}/nebula-cloud/1.what-is-cloud/)。 !!! caution - 使用 NebulaGraph Cloud 阿里云版创建的实例对应`{{cloud.aliyunLatestRelease}}`版本的 NebulaGraph。 + 使用 NebulaGraph Cloud 阿里云版创建的实例对应`{{cloud.aliyunLatestRelease}}`版本的{{nebula.name}}。 {% include "/source_create_instance_aliyun.md" %} diff --git a/docs-2.0/2.quick-start/2.quick-start-on-cloud/2.connect-to-nebulagraph-on-cloud.md b/docs-2.0/2.quick-start/2.quick-start-on-cloud/2.connect-to-nebulagraph-on-cloud.md index 5f1803f323c..f9e34fbeced 100644 --- a/docs-2.0/2.quick-start/2.quick-start-on-cloud/2.connect-to-nebulagraph-on-cloud.md +++ b/docs-2.0/2.quick-start/2.quick-start-on-cloud/2.connect-to-nebulagraph-on-cloud.md @@ -1,6 +1,6 @@ -# 连接 NebulaGraph +# 连接{{nebula.name}} -创建好云服务实例后，可以连接 NebulaGraph。本文介绍如何使用 NebulaGraph Explorer 快速连接 NebulaGraph。 +创建好云服务实例后，可以连接{{nebula.name}}。本文介绍如何使用{{explorer.name}}快速连接{{nebula.name}}。 ## 前提条件 @@ -8,7 +8,7 @@ ## 操作步骤 -本文使用 [NebulaGraph Explorer](../../nebula-explorer/about-explorer/ex-ug-what-is-explorer.md) 快速连接 NebulaGraph。操作步骤如下： +本文使用 [{{explorer.name}}](../../nebula-explorer/about-explorer/ex-ug-what-is-explorer.md) 快速连接{{nebula.name}}。操作步骤如下： 1. 登录[服务实例管理](https://computenest.console.aliyun.com/user/cn-hangzhou/serviceInstance/private)页面。 @@ -21,7 +21,7 @@ 4. 在**概览**页签的**基本信息**区域，查看**nebula_private_ip**及**explorer_portal**信息。 -5. 单击**explorer_portal**对应链接，进入 NebulaGraph Explorer 登录页面。 +5. 单击**explorer_portal**对应链接，进入{{explorer.name}}登录页面。 6. 填写登录信息，单击**登录**。 - **Host**：`nebula_private_ip地址:9669`，例如`192.168.98.160:9669`。 @@ -35,9 +35,9 @@ ## 更多连接方式 -用户可根据自己的需求选择其他连接方式。关于更多连接方式，参见[连接 NebulaGraph](https://docs.nebula-graph.com.cn/{{cloud.aliyunLatestRelease}}/nebula-cloud/nebula-cloud-on-alibabacloud/2.use-cloud-services/#_4)。 +用户可根据自己的需求选择其他连接方式。关于更多连接方式，参见[连接{{nebula.name}}](https://docs.nebula-graph.com.cn/{{cloud.aliyunLatestRelease}}/nebula-cloud/nebula-cloud-on-alibabacloud/2.use-cloud-services/#_4)。 ## 下一步 -[管理 NebulaGraph 数据](3.how-to-query-on-cloud.md) \ No newline at end of file +[管理{{nebula.name}}数据](3.how-to-query-on-cloud.md) \ No newline at end of file diff --git a/docs-2.0/2.quick-start/2.quick-start-on-cloud/3.how-to-query-on-cloud.md b/docs-2.0/2.quick-start/2.quick-start-on-cloud/3.how-to-query-on-cloud.md index 546594feb1f..a2f4f2f2fdf 100644 --- a/docs-2.0/2.quick-start/2.quick-start-on-cloud/3.how-to-query-on-cloud.md +++ b/docs-2.0/2.quick-start/2.quick-start-on-cloud/3.how-to-query-on-cloud.md @@ -1,16 +1,16 @@ -# 管理 NebulaGraph 数据 +# 管理{{nebula.name}}数据 -nGQL 是 NebulaGraph 创建的声明式图查询语言。用户可以使用 nGQL 语句对 NebulaGraph 数据库进行增删改查。本文介绍如何通过 NebulaGraph Cloud 中 Explorer 的控制台功能快速使用 Nebula Graph 基本语句。 +nGQL 是{{nebula.name}}创建的声明式图查询语言。用户可以使用 nGQL 语句对{{nebula.name}}数据库进行增删改查。本文介绍如何通过 NebulaGraph Cloud 中{{explorer.name}}的控制台功能快速使用 Nebula Graph 基本语句。 !!! note - 用户可以在 Explorer 中通过可视化查询 NebulaGraph 数据。本文介绍通过控制台功能使用 nGQL 语句增删改查 NebulaGraph 数据。关于如何可视化使用 Explorer 查询数据，参见[开始探索](../../nebula-explorer/graph-explorer/ex-ug-query-exploration.md)和[探索拓展](../../nebula-explorer/graph-explorer/ex-ug-graph-exploration.md)，或者观看视频。 + 用户可以在 Explorer 中通过可视化查询{{nebula.name}}数据。本文介绍通过控制台功能使用 nGQL 语句增删改查{{nebula.name}}数据。关于如何可视化使用 Explorer 查询数据，参见[开始探索](../../nebula-explorer/graph-explorer/ex-ug-query-exploration.md)和[探索拓展](../../nebula-explorer/graph-explorer/ex-ug-graph-exploration.md)，或者观看视频。 ## 前提条件 -[连接 NebulaGraph](2.connect-to-nebulagraph-on-cloud.md) +[连接{{nebula.name}}](2.connect-to-nebulagraph-on-cloud.md) ## 基本流程 diff --git a/docs-2.0/2.quick-start/3.quick-start-on-premise/2.install-nebula-graph.md b/docs-2.0/2.quick-start/3.quick-start-on-premise/2.install-nebula-graph.md index 076caba1d63..4f87fcbbc46 100644 --- a/docs-2.0/2.quick-start/3.quick-start-on-premise/2.install-nebula-graph.md +++ b/docs-2.0/2.quick-start/3.quick-start-on-premise/2.install-nebula-graph.md @@ -1,4 +1,4 @@ -# 步骤 1：安装 NebulaGraph +# 步骤 1：安装{{nebula.name}} {% include "/source_install-nebula-graph-by-rpm-or-deb.md" %} diff --git a/docs-2.0/2.quick-start/3.quick-start-on-premise/3.1add-storage-hosts.md b/docs-2.0/2.quick-start/3.quick-start-on-premise/3.1add-storage-hosts.md index d211c7fdf94..280da202435 100644 --- a/docs-2.0/2.quick-start/3.quick-start-on-premise/3.1add-storage-hosts.md +++ b/docs-2.0/2.quick-start/3.quick-start-on-premise/3.1add-storage-hosts.md @@ -1,6 +1,6 @@ # 注册 Storage 服务 -首次连接到 NebulaGraph 后，需要先添加 Storage 主机，并确认主机都处于在线状态。 +首次连接到{{nebula.name}}后，需要先添加 Storage 主机，并确认主机都处于在线状态。 diff --git a/docs-2.0/2.quick-start/3.quick-start-on-premise/4.nebula-graph-crud.md b/docs-2.0/2.quick-start/3.quick-start-on-premise/4.nebula-graph-crud.md index 518f37f70fd..e431514762b 100644 --- a/docs-2.0/2.quick-start/3.quick-start-on-premise/4.nebula-graph-crud.md +++ b/docs-2.0/2.quick-start/3.quick-start-on-premise/4.nebula-graph-crud.md @@ -1,6 +1,6 @@ # 步骤 4：使用常用 nGQL（CRUD 命令） -本文介绍 NebulaGraph 查询语言的基础语法，包括用于 Schema 创建和常用增删改查操作的语句。 +本文介绍{{nebula.name}}查询语言的基础语法，包括用于 Schema 创建和常用增删改查操作的语句。 如需了解更多语句的用法，参见 [nGQL 指南](../../3.ngql-guide/1.nGQL-overview/1.overview.md)。 diff --git a/docs-2.0/2.quick-start/3.quick-start-on-premise/5.start-stop-service.md b/docs-2.0/2.quick-start/3.quick-start-on-premise/5.start-stop-service.md index c245195926f..374c024ef1c 100644 --- a/docs-2.0/2.quick-start/3.quick-start-on-premise/5.start-stop-service.md +++ b/docs-2.0/2.quick-start/3.quick-start-on-premise/5.start-stop-service.md @@ -1,4 +1,4 @@ -# 步骤 2：启动 NebulaGraph 服务 +# 步骤 2：启动{{nebula.name}}服务 {% include "/source_manage-service.md" %} diff --git a/docs-2.0/2.quick-start/6.cheatsheet-for-ngql-command.md b/docs-2.0/2.quick-start/6.cheatsheet-for-ngql-command.md index 6e2c30e3f25..9e1e075120d 100644 --- a/docs-2.0/2.quick-start/6.cheatsheet-for-ngql-command.md +++ b/docs-2.0/2.quick-start/6.cheatsheet-for-ngql-command.md @@ -341,7 +341,7 @@ | [CREATE SPACE](../3.ngql-guide/9.space-statements/1.create-space.md) | `CREATE SPACE [IF NOT EXISTS] ( [partition_num = ,] [replica_factor = ,] vid_type = {FIXED_STRING() | INT[64]} ) [COMMENT = '']` | `CREATE SPACE my_space_1 (vid_type=FIXED_STRING(30))` | 创建一个新的图空间。 | | [CREATE SPACE](../3.ngql-guide/9.space-statements/1.create-space.md) | `CREATE SPACE AS ` | `CREATE SPACE my_space_4 as my_space_3` | 克隆现有图空间的 Schema。 | | [USE](../3.ngql-guide/9.space-statements/2.use-space.md) | `USE ` | `USE space1` | 指定一个图空间，或切换到另一个图空间，将其作为后续查询的工作空间。 | -| [SHOW SPACES](../3.ngql-guide/9.space-statements/3.show-spaces.md) | `SHOW SPACES` | `SHOW SPACES` | 列出 NebulaGraph 示例中的所有图空间。 | +| [SHOW SPACES](../3.ngql-guide/9.space-statements/3.show-spaces.md) | `SHOW SPACES` | `SHOW SPACES` | 列出{{nebula.name}}示例中的所有图空间。 | | [DESCRIBE SPACE](../3.ngql-guide/9.space-statements/4.describe-space.md) | `DESC[RIBE] SPACE ` | `DESCRIBE SPACE basketballplayer` | 显示指定图空间的信息。 | | [CLEAR SPACE](../3.ngql-guide/9.space-statements/6.clear-space.md) | `CLEAR SPACE [IF EXISTS] ` | 清空图空间中的点和边，但不会删除图空间本身以及其中的 Schema 信息。 | | [DROP SPACE](../3.ngql-guide/9.space-statements/5.drop-space.md) | `DROP SPACE [IF EXISTS] ` | `DROP SPACE basketballplayer` | 删除指定图空间的所有内容。 | @@ -371,7 +371,7 @@ | 语句 | 语法 | 示例 | 说明 | | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | -| [INSERT VERTEX](../3.ngql-guide/12.vertex-statements/1.insert-vertex.md) | `INSERT VERTEX [IF NOT EXISTS] [tag_props, [tag_props] ...] VALUES : ([prop_value_list])` | `INSERT VERTEX t2 (name, age) VALUES "13":("n3", 12), "14":("n4", 8)` | 在 NebulaGraph 实例的指定图空间中插入一个或多个点。 | +| [INSERT VERTEX](../3.ngql-guide/12.vertex-statements/1.insert-vertex.md) | `INSERT VERTEX [IF NOT EXISTS] [tag_props, [tag_props] ...] VALUES : ([prop_value_list])` | `INSERT VERTEX t2 (name, age) VALUES "13":("n3", 12), "14":("n4", 8)` | 在{{nebula.name}}实例的指定图空间中插入一个或多个点。 | | [DELETE VERTEX](../3.ngql-guide/12.vertex-statements/4.delete-vertex.md) | `DELETE VERTEX [, ...]` | `DELETE VERTEX "team1"` | 删除点，以及点关联的出边和入边。 | | [UPDATE VERTEX](../3.ngql-guide/12.vertex-statements/2.update-vertex.md) | `UPDATE VERTEX ON SET [WHEN ] [YIELD ]` | `UPDATE VERTEX ON player "player101" SET age = age + 2 ` | 修改点上 Tag 的属性值。 | | [UPSERT VERTEX](../3.ngql-guide/12.vertex-statements/3.upsert-vertex.md) | `UPSERT VERTEX ON SET [WHEN ] [YIELD ]` | `UPSERT VERTEX ON player "player667" SET age = 31` | 结合`UPDATE`和`INSERT`，如果点存在，会修改点的属性值；如果点不存在，会插入新的点。 | @@ -380,7 +380,7 @@ | 语句 | 语法 | 示例 | 说明 | | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | -| [INSERT EDGE](../3.ngql-guide/13.edge-statements/1.insert-edge.md) | `INSERT EDGE [IF NOT EXISTS] ( ) VALUES -> [@] : ( ) [, -> [@] : ( ), ...]` | `INSERT EDGE e2 (name, age) VALUES "11"->"13":("n1", 1)` | 在 NebulaGraph 实例的指定图空间中插入一条或多条边。 | +| [INSERT EDGE](../3.ngql-guide/13.edge-statements/1.insert-edge.md) | `INSERT EDGE [IF NOT EXISTS] ( ) VALUES -> [@] : ( ) [, -> [@] : ( ), ...]` | `INSERT EDGE e2 (name, age) VALUES "11"->"13":("n1", 1)` | 在{{nebula.name}}实例的指定图空间中插入一条或多条边。 | | [DELETE EDGE](../3.ngql-guide/12.vertex-statements/3.upsert-vertex.md) | `DELETE EDGE -> [@] [, -> [@] ...]` | `DELETE EDGE serve "player100" -> "team204"@0` | 删除边。一次可以删除一条或多条边。 | | [UPDATE EDGE](../3.ngql-guide/13.edge-statements/2.update-edge.md) | `UPDATE EDGE ON -> [@] SET [WHEN ] [YIELD ]` | `UPDATE EDGE ON serve "player100" -> "team204"@0 SET start_year = start_year + 1` | 修改边上 Edge type 的属性。 | | [UPSERT EDGE](../3.ngql-guide/12.vertex-statements/3.upsert-vertex.md) | `UPSERT EDGE ON -> [@rank] SET [WHEN ] [YIELD ]` | `UPSERT EDGE on serve "player666" -> "team200"@0 SET end_year = 2021` | 结合`UPDATE`和`INSERT`，如果边存在，会更新边的属性；如果边不存在，会插入新的边。 | @@ -407,7 +407,7 @@ | 语法 | 示例 | 说明 | | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | - | `SIGN IN TEXT SERVICE [( [,, ]), (), ...]` | `SIGN IN TEXT SERVICE (127.0.0.1:9200)` | NebulaGraph 的全文索引是基于 [Elasticsearch](https://en.wikipedia.org/wiki/Elasticsearch) 实现，部署 Elasticsearch 集群之后，可以使用`SIGN IN`语句登录 Elasticsearch 客户端。 | + | `SIGN IN TEXT SERVICE [( [,, ]), (), ...]` | `SIGN IN TEXT SERVICE (127.0.0.1:9200)` | {{nebula.name}}的全文索引是基于 [Elasticsearch](https://en.wikipedia.org/wiki/Elasticsearch) 实现，部署 Elasticsearch 集群之后，可以使用`SIGN IN`语句登录 Elasticsearch 客户端。 | | `SHOW TEXT SEARCH CLIENTS` | `SHOW TEXT SEARCH CLIENTS` | 列出文本搜索客户端。 | | `SIGN OUT TEXT SERVICE` | `SIGN OUT TEXT SERVICE` | 退出所有文本搜索客户端。 | | `CREATE FULLTEXT {TAG | EDGE} INDEX ON { | } ([])` | `CREATE FULLTEXT TAG INDEX nebula_index_1 ON player(name)` | 创建全文索引。 | diff --git a/docs-2.0/20.appendix/0.FAQ.md b/docs-2.0/20.appendix/0.FAQ.md index a96ae9735a7..433d8911a54 100644 --- a/docs-2.0/20.appendix/0.FAQ.md +++ b/docs-2.0/20.appendix/0.FAQ.md @@ -1,14 +1,14 @@ # 常见问题 FAQ -本文列出了使用 NebulaGraph {{ nebula.release }} 时可能遇到的常见问题，用户可以使用文档中心或者浏览器的搜索功能查找相应问题。 +本文列出了使用{{nebula.name}} {{ nebula.release }} 时可能遇到的常见问题，用户可以使用文档中心或者浏览器的搜索功能查找相应问题。 -如果按照文中的建议无法解决问题，请到 [NebulaGraph 论坛](https://discuss.nebula-graph.com.cn/) 提问或提交 [GitHub issue](https://github.com/vesoft-inc/nebula/issues)。 +如果按照文中的建议无法解决问题，请到[{{nebula.name}} 论坛](https://discuss.nebula-graph.com.cn/) 提问或提交 [GitHub issue](https://github.com/vesoft-inc/nebula/issues)。 ## 关于本手册 ### 为什么手册示例和系统行为不一致？ -NebulaGraph 一直在持续开发，功能或操作的行为可能会有变化，如果发现不一致，请提交 [issue](https://github.com/vesoft-inc/nebula/issues/new) 通知 NebulaGraph 团队。 +{{nebula.name}}一直在持续开发，功能或操作的行为可能会有变化，如果发现不一致，请提交 [issue](https://github.com/vesoft-inc/nebula/issues/new) 通知{{nebula.name}}团队。 !!! note @@ -22,9 +22,9 @@ NebulaGraph 一直在持续开发，功能或操作的行为可能会有变化 !!! compatibility "`X`版本兼容性" - NebulaGraph {{ nebula.release }} 与 历史版本 （包括 NebulaGraph 1.x 和 2.x) 的数据格式、客户端通信协议均**双向不兼容**。 + {{nebula.name}} {{ nebula.release }} 与 历史版本 （包括{{nebula.name}} 1.x 和 2.x) 的数据格式、客户端通信协议均**双向不兼容**。 使用**老版本**客户端连接**新版本**服务端，会导致服务进程**退出**。 - 数据格式升级参见[升级 NebulaGraph 历史版本至当前版本](../4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-graph-to-latest.md)。 + 数据格式升级参见[升级{{nebula.name}}历史版本至当前版本](../4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-graph-to-latest.md)。 客户端与工具均需要[下载对应版本](../20.appendix/6.eco-tool-version.md)。 @@ -14,29 +14,29 @@ Nebula Console 的获取方式如下： ## 功能说明 -### 连接 NebulaGraph +### 连接{{nebula.name}} -运行二进制文件 `nebula-console` 连接 NebulaGraph 的命令语法如下： +运行二进制文件 `nebula-console` 连接{{nebula.name}}的命令语法如下： ```bash -addr -port -u -p ``` -`path_of_console`是 Nebula Console 二进制文件的存储路径。 +`path_of_console`是 NebulaGraph Console 二进制文件的存储路径。 常用参数的说明如下。 | 参数 | 说明 | | - | - | | `-h/-help` | 显示帮助菜单。 | -| `-addr/-address` | 设置要连接的 Graph 服务的 IP 地址。默认地址为 127.0.0.1。 | +| `-addr/-address` | 设置要连接的 Graph 服务的 IP 地址。默认地址为 127.0.0.1。 | | `-P/-port` | 设置要连接的 Graph 服务的端口。默认端口为 9669。| -| `-u/-user` | 设置 NebulaGraph 账号的用户名。未启用身份认证时，可以使用任意已存在的用户名（默认为`root`）。 | +| `-u/-user` | 设置{{nebula.name}}账号的用户名。未启用身份认证时，可以使用任意已存在的用户名（默认为`root`）。 | | `-p/-password` | 设置用户名对应的密码。未启用身份认证时，密码可以填写任意字符。 | | `-t/-timeout` | 设置整数类型的连接超时时间。单位为毫秒，默认值为 120。 | | `-e/-eval` | 设置字符串类型的 nGQL 语句。连接成功后会执行一次该语句并返回结果，然后自动断开连接。 | | `-f/-file` | 设置存储 nGQL 语句的文件的路径。连接成功后会执行该文件内的 nGQL 语句并返回结果，执行完毕后自动断开连接。 | -| `-enable_ssl` | 连接 NebulaGraph 时使用 SSL 加密。 | +| `-enable_ssl` | 连接{{nebula.name}}时使用 SSL 加密。 | | `-ssl_root_ca_path` | 指定 CA 证书的存储路径。 | | `-ssl_cert_path` | 指定 CRT 证书的存储路径。 | | `-ssl_private_key_path` | 指定私钥文件的存储路径。 | @@ -51,7 +51,7 @@ Nebula Console 的获取方式如下： ### 管理参数 -Nebula Console 可以保存参数，用于参数化查询。 +NebulaGraph Console 可以保存参数，用于参数化查询。 !!! note @@ -229,7 +229,7 @@ nebula> :sleep N; ### 断开连接 -用户可以使用`:EXIT`或者`:QUIT`从 NebulaGraph 断开连接。为方便使用，Nebula Console 支持使用不带冒号（:）的小写命令，例如`quit`。 +用户可以使用`:EXIT`或者`:QUIT`从{{nebula.name}}断开连接。为方便使用，NebulaGraph Console 支持使用不带冒号（:）的小写命令，例如`quit`。 示例： diff --git a/docs-2.0/nebula-flink-connector.md b/docs-2.0/nebula-flink-connector.md index b0fad5b7843..8a506e42307 100644 --- a/docs-2.0/nebula-flink-connector.md +++ b/docs-2.0/nebula-flink-connector.md @@ -1,6 +1,6 @@ # NebulaGraph Flink Connector -NebulaGraph Flink Connector 是一款帮助 Flink 用户快速访问 NebulaGraph 的连接器，支持从 NebulaGraph 图数据库中读取数据，或者将其他外部数据源读取的数据写入 NebulaGraph 图数据库。 +NebulaGraph Flink Connector 是一款帮助 Flink 用户快速访问{{nebula.name}}的连接器，支持从{{nebula.name}}图数据库中读取数据，或者将其他外部数据源读取的数据写入{{nebula.name}}图数据库。 更多使用说明请参见 [NebulaGraph Flink Connector](https://github.com/vesoft-inc/nebula-flink-connector)。 @@ -8,11 +8,11 @@ NebulaGraph Flink Connector 是一款帮助 Flink 用户快速访问 NebulaGraph NebulaGraph Flink Connector 适用于以下场景： -- 在不同的 NebulaGraph 集群之间迁移数据。 +- 在不同的{{nebula.name}}集群之间迁移数据。 -- 在同一个 NebulaGraph 集群内不同图空间之间迁移数据。 +- 在同一个{{nebula.name}}集群内不同图空间之间迁移数据。 -- NebulaGraph 与其他数据源之间迁移数据。 +- {{nebula.name}}与其他数据源之间迁移数据。 ## 更新说明 diff --git a/docs-2.0/nebula-spark-connector.md b/docs-2.0/nebula-spark-connector.md index 82eccd51dab..787b8375102 100644 --- a/docs-2.0/nebula-spark-connector.md +++ b/docs-2.0/nebula-spark-connector.md @@ -1,22 +1,22 @@ # NebulaGraph Spark Connector -NebulaGraph Spark Connector 是一个 Spark 连接器，提供通过 Spark 标准形式读写 NebulaGraph 数据的能力。NebulaGraph Spark Connector 由 Reader 和 Writer 两部分组成。 +NebulaGraph Spark Connector 是一个 Spark 连接器，提供通过 Spark 标准形式读写{{nebula.name}}数据的能力。NebulaGraph Spark Connector 由 Reader 和 Writer 两部分组成。 - Reader - 提供一个 Spark SQL 接口，用户可以使用该接口编程读取 NebulaGraph 图数据，单次读取一个点或 Edge type 的数据，并将读取的结果组装成 Spark 的 DataFrame。 + 提供一个 Spark SQL 接口，用户可以使用该接口编程读取{{nebula.name}}图数据，单次读取一个点或 Edge type 的数据，并将读取的结果组装成 Spark 的 DataFrame。 - Writer - 提供一个 Spark SQL 接口，用户可以使用该接口编程将 DataFrame 格式的数据逐条或批量写入 NebulaGraph。 + 提供一个 Spark SQL 接口，用户可以使用该接口编程将 DataFrame 格式的数据逐条或批量写入{{nebula.name}}。 更多使用说明请参见 [NebulaGraph Spark Connector](https://github.com/vesoft-inc/nebula-spark-connector/blob/{{sparkconnector.branch}}/README_CN.md)。 ## 版本兼容性 -NebulaGraph Spark Connector、NebulaGraph 内核版本和 Spark 版本对应关系如下。 +NebulaGraph Spark Connector、{{nebula.name}}内核版本和 Spark 版本对应关系如下。 -| Spark Connector 版本 | NebulaGraph 版本 | Spark 版本 | +| Spark Connector 版本 | {{nebula.name}}版本 | Spark 版本 | |:----------|:-----------|:-------| |nebula-spark-connector_3.0-3.0-SNAPSHOT.jar| nightly| 3.x| |nebula-spark-connector_2.2-3.0-SNAPSHOT.jar| nightly| 2.2.x| @@ -38,11 +38,11 @@ NebulaGraph Spark Connector、NebulaGraph 内核版本和 Spark 版本对应关 NebulaGraph Spark Connector 适用于以下场景： -- 在不同的 NebulaGraph 集群之间迁移数据。 +- 在不同的{{nebula.name}}集群之间迁移数据。 -- 在同一个 NebulaGraph 集群内不同图空间之间迁移数据。 +- 在同一个{{nebula.name}}集群内不同图空间之间迁移数据。 -- NebulaGraph 与其他数据源之间迁移数据。 +- {{nebula.name}}与其他数据源之间迁移数据。 - 结合 [NebulaGraph Algorithm](graph-computing/nebula-algorithm.md) 进行图计算。 @@ -56,13 +56,13 @@ NebulaGraph Spark Connector {{sparkconnector.release}}版本特性如下： - Reader 支持无属性读取和全属性读取。 -- Reader 支持将 NebulaGraph 数据读取成 Graphx 的 VertexRDD 和 EdgeRDD，支持非 Long 型点 ID。 +- Reader 支持将{{nebula.name}}数据读取成 Graphx 的 VertexRDD 和 EdgeRDD，支持非 Long 型点 ID。 -- 统一了 SparkSQL 的扩展数据源，统一采用 DataSourceV2 进行 NebulaGraph 数据扩展。 +- 统一了 SparkSQL 的扩展数据源，统一采用 DataSourceV2 进行{{nebula.name}}数据扩展。 - 支持`insert`、`update`和`delete`三种写入模式。`insert`模式会插入（覆盖）数据，`update`模式仅会更新已存在的数据，`delete`模式只删除数据。 -- 支持与 NebulaGraph 之间的 SSL 加密连接。 +- 支持与{{nebula.name}}之间的 SSL 加密连接。 ## 更新说明 @@ -112,21 +112,21 @@ NebulaGraph Spark Connector {{sparkconnector.release}}版本特性如下： ## 使用方法 -使用 NebulaGraph Spark Connector 读写 NebulaGraph 数据库时，只需要编写以下代码即可实现。 +使用 NebulaGraph Spark Connector 读写{{nebula.name}}时，只需要编写以下代码即可实现。 ```scala -# 从 NebulaGraph 读取点边数据。 +# 从{{nebula.name}}读取点边数据。 spark.read.nebula().loadVerticesToDF() spark.read.nebula().loadEdgesToDF() -# 将 dataframe 数据作为点和边写入 NebulaGraph 中。 +# 将 dataframe 数据作为点和边写入{{nebula.name}}中。 dataframe.write.nebula().writeVertices() dataframe.write.nebula().writeEdges() ``` `nebula()`接收两个配置参数，包括连接配置和读写配置。 -### 从 NebulaGraph 读取数据 +### 从{{nebula.name}}读取数据 ```scala val config = NebulaConnectionConfig @@ -160,31 +160,31 @@ val nebulaReadEdgeConfig: ReadNebulaConfig = ReadNebulaConfig val edge = spark.read.nebula(config, nebulaReadEdgeConfig).loadEdgesToDF() ``` -- `NebulaConnectionConfig`是连接 NebulaGraph 的配置，说明如下。 +- `NebulaConnectionConfig`是连接{{nebula.name}}的配置，说明如下。 |参数|是否必须|说明| |:---|:---|:---| |`withMetaAddress` |是| 所有 Meta 服务的地址，多个地址用英文逗号（,）隔开，格式为`ip1:port1,ip2:port2,...`。读取数据不需要配置`withGraphAddress`。 | - |`withConnectionRetry` |否| NebulaGraph Java Client 连接 NebulaGraph 的重试次数。默认值为`1`。 | + |`withConnectionRetry` |否| NebulaGraph Java Client 连接{{nebula.name}}的重试次数。默认值为`1`。 | |`withExecuteRetry` |否| NebulaGraph Java Client 执行查询语句的重试次数。默认值为`1`。 | |`withTimeout` |否| NebulaGraph Java Client 请求响应的超时时间。默认值为`6000`，单位：毫秒（ms）。 | -- `ReadNebulaConfig`是读取 NebulaGraph 数据的配置，说明如下。 +- `ReadNebulaConfig`是读取{{nebula.name}}数据的配置，说明如下。 |参数|是否必须|说明| |:---|:---|:---| - |`withSpace` |是| NebulaGraph 图空间名称。 | - |`withLabel` |是| NebulaGraph 图空间内的 Tag 或 Edge type 名称。 | + |`withSpace` |是| {{nebula.name}}图空间名称。 | + |`withLabel` |是| {{nebula.name}}图空间内的 Tag 或 Edge type 名称。 | |`withNoColumn` |否| 是否不读取属性。默认值为`false`，表示读取属性。取值为`true`时，表示不读取属性，此时`withReturnCols`配置无效。 | |`withReturnCols` |否| 配置要读取的点或边的属性集。格式为`List(property1,property2,...)`，默认值为`List()`，表示读取全部属性。 | |`withLimit` |否| 配置 NebulaGraph Java Storage Client 一次从服务端读取的数据行数。默认值为 1000。 | - |`withPartitionNum` |否| 配置读取 NebulaGraph 数据时 Spark 的分区数。默认值为 100。该值的配置最好不超过图空间的的分片数量（partition_num）。| + |`withPartitionNum` |否| 配置读取{{nebula.name}}数据时 Spark 的分区数。默认值为 100。该值的配置最好不超过图空间的的分片数量（partition_num）。| -### 向 NebulaGraph 写入数据 +### 向{{nebula.name}}写入数据 !!! note - DataFrame 中的列会自动作为属性写入 NebulaGraph。 + DataFrame 中的列会自动作为属性写入{{nebula.name}}。 ```scala val config = NebulaConnectionConfig @@ -246,25 +246,25 @@ val nebulaWriteVertexConfig = WriteNebulaVertexConfig df.write.nebula(config, nebulaWriteVertexConfig).writeVertices() ``` -- `NebulaConnectionConfig`是连接 NebulaGraph 的配置，说明如下。 +- `NebulaConnectionConfig`是连接{{nebula.name}}的配置，说明如下。 |参数|是否必须|说明| |:---|:---|:---| |`withMetaAddress` |是| 所有 Meta 服务的地址，多个地址用英文逗号（,）隔开，格式为`ip1:port1,ip2:port2,...`。 | |`withGraphAddress` |是| Graph 服务的地址，多个地址用英文逗号（,）隔开，格式为`ip1:port1,ip2:port2,...`。 | - |`withConnectionRetry` |否| NebulaGraph Java Client 连接 NebulaGraph 的重试次数。默认值为`1`。 | + |`withConnectionRetry` |否| NebulaGraph Java Client 连接{{nebula.name}}的重试次数。默认值为`1`。 | - `WriteNebulaVertexConfig`是写入点的配置，说明如下。 |参数|是否必须|说明| |:---|:---|:---| - |`withSpace` |是| NebulaGraph 图空间名称。 | + |`withSpace` |是| {{nebula.name}}图空间名称。 | |`withTag` |是| 写入点时需要关联的 Tag 名称。 | |`withVidField` |是| DataFrame 中作为点 ID 的列。 | - |`withVidPolicy` |否| 写入点 ID 时，采用的映射函数，NebulaGraph 仅支持 HASH。默认不做映射。 | + |`withVidPolicy` |否| 写入点 ID 时，采用的映射函数，{{nebula.name}}仅支持 HASH。默认不做映射。 | |`withVidAsProp` |否| DataFrame 中作为点 ID 的列是否也作为属性写入。默认值为`false`。如果配置为`true`，请确保 Tag 中有和`VidField`相同的属性名。 | - |`withUser` |否| NebulaGraph 用户名。若未开启[身份验证](7.data-security/1.authentication/1.authentication.md)，无需配置用户名和密码。 | - |`withPasswd` |否| NebulaGraph 用户名对应的密码。 | + |`withUser` |否| {{nebula.name}}用户名。若未开启[身份验证](7.data-security/1.authentication/1.authentication.md)，无需配置用户名和密码。 | + |`withPasswd` |否| {{nebula.name}}用户名对应的密码。 | |`withBatch` |是| 一次写入的数据行数，默认值为`512`。当`withWriteMode`为`update`时，该参数的最大值为`512`。 | |`withWriteMode`|否|写入模式。可选值为`insert`、`update`和`delete`。默认为`insert`。| |`withDeleteEdge`|否|删除点时是否删除该点关联的边。默认为`false`。当`withWriteMode`为`delete`时生效。 | @@ -273,18 +273,18 @@ df.write.nebula(config, nebulaWriteVertexConfig).writeVertices() |参数|是否必须|说明| |:---|:---|:---| - |`withSpace` |是| NebulaGraph 图空间名称。 | + |`withSpace` |是| {{nebula.name}}图空间名称。 | |`withEdge` |是| 写入边时需要关联的 Edge type 名称。 | |`withSrcIdField` |是| DataFrame 中作为起始点的列。 | - |`withSrcPolicy` |否| 写入起始点时，采用的映射函数，NebulaGraph 仅支持 HASH。默认不做映射。 | + |`withSrcPolicy` |否| 写入起始点时，采用的映射函数，{{nebula.name}}仅支持 HASH。默认不做映射。 | |`withDstIdField` |是| DataFrame 中作为目的点的列。 | - |`withDstPolicy` |否| 写入目的点时，采用的映射函数，NebulaGraph 仅支持 HASH。默认不做映射。 | + |`withDstPolicy` |否| 写入目的点时，采用的映射函数，{{nebula.name}}仅支持 HASH。默认不做映射。 | |`withRankField` |否| DataFrame 中作为 rank 的列。默认不写入 rank。 | |`withSrcAsProperty` |否| DataFrame 中作为起始点的列是否也作为属性写入。默认值为`false`。如果配置为`true`，请确保 Edge type 中有和`SrcIdField`相同的属性名。 | |`withDstAsProperty` |否| DataFrame 中作为目的点的列是否也作为属性写入。默认值为`false`。如果配置为`true`，请确保 Edge type 中有和`DstIdField`相同的属性名。 | |`withRankAsProperty` |否| DataFrame 中作为 rank 的列是否也作为属性写入。默认值为`false`。如果配置为`true`，请确保 Edge type 中有和`RankField`相同的属性名。 | - |`withUser` |否| NebulaGraph 用户名。若未开启[身份验证](7.data-security/1.authentication/1.authentication.md)，无需配置用户名和密码。 | - |`withPasswd` |否| NebulaGraph 用户名对应的密码。 | + |`withUser` |否| {{nebula.name}}用户名。若未开启[身份验证](7.data-security/1.authentication/1.authentication.md)，无需配置用户名和密码。 | + |`withPasswd` |否| {{nebula.name}}用户名对应的密码。 | |`withBatch` |是| 一次写入的数据行数，默认值为`512`。当`withWriteMode`为`update`时，该参数的最大值为`512`。 | |`withWriteMode`|否|写入模式。可选值为`insert`、`update`和`delete`。默认为`insert`。| diff --git a/mkdocs.yml b/mkdocs.yml index 3d820382188..d3eee19e363 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -187,6 +187,12 @@ extra: release: 3.4.0 branch: release-3.4 tag: v3.4.0 + # nav.ent.begin + name: 悦数图探索 + # nav.ent.end + # nav.comm.begin + name: NebulaGraph Explorer + # nav.comm.end exchange_ent: release: 3.4.0 branch: release-3.4 @@ -814,7 +820,9 @@ nav: - 常见问题 FAQ: 20.appendix/0.FAQ.md - 生态工具概览: 20.appendix/6.eco-tool-version.md - 导入工具选择: 20.appendix/write-tools.md + # nav.comm.begin - 社区参与: 15.contribution/how-to-contribute.md + # nav.comm.end - 年表: 20.appendix/history.md - 思维导图: 20.appendix/mind-map.md - 错误码: 20.appendix/error-code.md From 42578644ff9920452c0deb3d53fb15fa04ad3f35 Mon Sep 17 00:00:00 2001 From: cooper-lzy <78672629+cooper-lzy@users.noreply.github.com> Date: Tue, 11 Apr 2023 10:00:56 +0800 Subject: [PATCH 121/137] update --- docs-2.0/20.appendix/6.eco-tool-version.md | 2 +- docs-2.0/20.appendix/8.about-license.md | 27 +++----- docs-2.0/20.appendix/error-code.md | 2 +- docs-2.0/20.appendix/history.md | 25 +++++++- docs-2.0/20.appendix/learning-path.md | 62 +++++++++---------- docs-2.0/20.appendix/mind-map.md | 6 +- .../dashboard-ent-release-note.md | 12 ++-- .../release-notes/nebula-comm-release-note.md | 2 +- .../release-notes/nebula-ent-release-note.md | 2 +- docs-2.0/20.appendix/write-tools.md | 2 +- .../1.nGQL-overview/1.overview.md | 18 +++--- .../1.nGQL-overview/3.graph-patterns.md | 2 +- .../3.ngql-guide/1.nGQL-overview/comments.md | 6 -- .../1.nGQL-overview/ngql-style-guide.md | 2 +- .../10.tag-statements/1.create-tag.md | 2 +- docs-2.0/3.ngql-guide/4.job-statements.md | 4 +- 16 files changed, 89 insertions(+), 87 deletions(-) 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 2ce5383570d..a64290c304c 100644 --- a/docs-2.0/20.appendix/6.eco-tool-version.md +++ b/docs-2.0/20.appendix/6.eco-tool-version.md @@ -35,7 +35,7 @@ ## NebulaGraph Studio -NebulaGraph Studio（简称 Studio）是一款可以通过 Web 访问的图数据库可视化工具，搭配 NebulaGraph DBMS 使用，提供构图、数据导入、编写 nGQL 查询、图探索等一站式服务。详情请参见[什么是 NebulaGraph Studio](../nebula-studio/about-studio/st-ug-what-is-graph-studio.md)。 +NebulaGraph Studio（简称 Studio）是一款可以通过 Web 访问的图数据库可视化工具，搭配{{nebula.name}}使用，提供构图、数据导入、编写 nGQL 查询、图探索等一站式服务。详情请参见[什么是 NebulaGraph Studio](../nebula-studio/about-studio/st-ug-what-is-graph-studio.md)。 !!! Note diff --git a/docs-2.0/20.appendix/8.about-license.md b/docs-2.0/20.appendix/8.about-license.md index c743dcc7f63..8cd9d104221 100644 --- a/docs-2.0/20.appendix/8.about-license.md +++ b/docs-2.0/20.appendix/8.about-license.md @@ -1,13 +1,13 @@ # 关于 License -License 是一种软件许可证，用以规定和限制用户使用软件的权利。在 NebulaGraph 内核及生态工具中，License 被用于限制企业版软件的使用权限。本文介绍需设置 License 的产品及 License 的相关信息。 +License 是一种软件许可证，用以规定和限制用户使用软件的权利。在{{nebula.name}}内核及生态工具中，License 被用于限制企业版软件的使用权限。本文介绍需设置 License 的产品及 License 的相关信息。 {{ ent.ent_begin }} -## NebulaGraph 企业版 +## {{nebula.name}} -部署 NebulaGraph 企业版时，用户需设置 NebulaGraph 企业版 License。 +部署{{nebula.name}}时，用户需设置 License。 -更多信息，参见[设置 NebulaGraph 企业版 License](../4.deployment-and-installation/deploy-license.md)。 +更多信息，参见[设置 License](../4.deployment-and-installation/deploy-license.md)。 {{ ent.ent_end }} @@ -25,20 +25,9 @@ NebulaGraph Explorer 企业版是一款通过 Web 访问的图探索可视化工 ## License 常见问题 -### Dashboard/Explorer/NebulaGraph 企业版的 License 一样吗？ - -不一样，Dashboard、Explorer、NebulaGraph 企业版的 License 相互独立，不可互用。 +### Dashboard/Explorer/{{nebula.name}}的 License 一样吗？ -{{ ent.ent_begin }} -### 在 NebulaGraph 企业版的 License 使用有效期期间，将企业版 Meta 替换成社区版 Meta 后，可以和企业版的 Graph、Storage一起使用吗？ - -不可以，不支持企业版和社区版的 NebulaGraph 的混合部署。 - -### NebulaGraph 企业版的 License 到期后，是否可以将`data`目录的数据替换至社区版的 NebulaGraph 中使用？ - -可以。企业版和社区版的数据可以通用。只有在都是社区版部署的服务中才可以正常使用替换后的数据。不支持企业版和社区版的混合部署，例如，不支持混合部署企业版的 Meta 服务和社区版的 Graph、Storage 服务。 - -{{ ent.ent_end }} +不一样，Dashboard、Explorer、{{nebula.name}}的 License 相互独立，不可互用。 ### License 过期前，是否有信息提示？License 过期后如何续期？ @@ -50,7 +39,7 @@ License 过期前，系统会发送过期提醒信息。 - 过期前 30 天和过期当天，在启动服务时有过期提醒。 - - 到期后有 14 天缓冲期。在缓冲期期间，有过期提示，用户能继续使用 NebulaGraph/Dashboard/Explorer。缓冲期结束后，服务会停机并无法启动。 + - 到期后有 14 天缓冲期。在缓冲期期间，有过期提示，用户能继续使用{{nebula.name}}/Dashboard/Explorer。缓冲期结束后，服务会停机并无法启动。 - 试用版的 License 过期提醒： @@ -59,5 +48,3 @@ License 过期前，系统会发送过期提醒信息。 - 无缓冲期。License 到期后，无法启动服务。 License 过期后，请及时联系销售（[inqury@vesoft.com](mailto:inqury@vesoft.com)）更换新的证书。 - - diff --git a/docs-2.0/20.appendix/error-code.md b/docs-2.0/20.appendix/error-code.md index 790d0536661..6bca1a53704 100644 --- a/docs-2.0/20.appendix/error-code.md +++ b/docs-2.0/20.appendix/error-code.md @@ -1,6 +1,6 @@ # 错误码 -NebulaGraph 运行出现问题时，会返回错误码。本文介绍错误码的详细信息。 +{{nebula.name}}运行出现问题时，会返回错误码。本文介绍错误码的详细信息。 !!! note diff --git a/docs-2.0/20.appendix/history.md b/docs-2.0/20.appendix/history.md index 79f769a7cde..bedc219fa11 100644 --- a/docs-2.0/20.appendix/history.md +++ b/docs-2.0/20.appendix/history.md @@ -1,5 +1,6 @@ -# NebulaGraph 年表 +# {{nebula.name}}年表 +{{ comm.comm_begin }} 1. 2018.9.5 由 @[dutor](https://github.com/dutor) 提交了第一行代码。 ![image](https://docs-cdn.nebula-graph.com.cn/books/images/dutor.png) @@ -41,4 +42,24 @@ 12. 2022.10 发布 v3.3.0 -13. 2023.2 发布 v3.4.0 \ No newline at end of file +13. 2023.2 发布 v3.4.0 + +{{ comm.comm_end }} + +{{ ent.ent_begin }} + +1. 2021.8 发布 v2.5.0 + +2. 2021.10 发布 v2.6.0 + +3. 2022.2 发布 v3.0.0 + +4. 2022.4 发布 v3.1.0 + +5. 2022.7 发布 v3.2.0 + +6. 2022.10 发布 v3.3.0 + +7. 2023.2 发布 v3.4.0 + +{{ ent.ent_end }} \ No newline at end of file diff --git a/docs-2.0/20.appendix/learning-path.md b/docs-2.0/20.appendix/learning-path.md index 8a25cae290c..b77613fcf07 100644 --- a/docs-2.0/20.appendix/learning-path.md +++ b/docs-2.0/20.appendix/learning-path.md @@ -1,20 +1,20 @@ -# NebulaGraph 学习路径 +# {{nebula.name}}学习路径 -本文介绍 NebulaGraph 学习路径，用户可以通过路径中的文档及视频由浅入深地学习图数据库 NebulaGraph。 +本文介绍{{nebula.name}}学习路径，用户可以通过路径中的文档及视频由浅入深地学习图数据库 NebulaGraph。 ![learning path](https://docs-cdn.nebula-graph.com.cn/figures/learning-path.png) -完成 NebulaGraph 学习后，参加[技能认证](https://www.bilibili.com/video/BV1Ga411x7RE)考试还可以获取认证证书。详情参见下文**通过 CI/CP 考试**。 +完成{{nebula.name}}学习后，参加[技能认证](https://www.bilibili.com/video/BV1Ga411x7RE)考试还可以获取认证证书。详情参见下文**通过 CI/CP 考试**。 -## 1. 关于 NebulaGraph +## 1. 关于{{nebula.name}} -### 1.1 什么是 NebulaGraph？ +### 1.1 什么是{{nebula.name}}？ | 文档 | 视频 | PPT | | ------------------------------------------------------------ | ------------------------------------------------------------ | -- | -| [什么是 NebulaGraph](https://docs.nebula-graph.com.cn/{{nebula.release}}/1.introduction/1.what-is-nebula-graph/) | [NebulaGraph 介绍](https://www.bilibili.com/video/BV1kf4y1v7LM)、[万亿级别的图数据库 NebulaGraph](https://www.bilibili.com/video/BV1aK4y1e7Q4?spm_id_from=333.999.0.0)| [NebulaGraph 3年回顾](https://mp.weixin.qq.com/s/25TfLXR89kg0BpiMAbQ_Iw) | +| [什么是{{nebula.name}}](https://docs.nebula-graph.com.cn/{{nebula.release}}/1.introduction/1.what-is-nebula-graph/) | [{{nebula.name}}介绍](https://www.bilibili.com/video/BV1kf4y1v7LM)、[万亿级别的{{nebula.name}}](https://www.bilibili.com/video/BV1aK4y1e7Q4?spm_id_from=333.999.0.0)| [{{nebula.name}} 3年回顾](https://mp.weixin.qq.com/s/25TfLXR89kg0BpiMAbQ_Iw) | ### 1.2 图相关术语 @@ -52,27 +52,27 @@ ## 2. 快速入门 -### 2.1 安装 NebulaGraph +### 2.1 安装{{nebula.name}} | 文档 | 视频 | | ------------------------------------------------------------ | ------------------------------------------------------------ | | [使用 RPM/DEB 包](https://docs.nebula-graph.com.cn/{{nebula.release}}/4.deployment-and-installation/2.compile-and-install-nebula-graph/2.install-nebula-graph-by-rpm-or-deb/) | - | | [使用 TAR 包](https://docs.nebula-graph.com.cn/{{nebula.release}}/4.deployment-and-installation/2.compile-and-install-nebula-graph/4.install-nebula-graph-from-tar/) | - | | [使用 Docker](https://docs.nebula-graph.com.cn/{{nebula.release}}/4.deployment-and-installation/2.compile-and-install-nebula-graph/3.deploy-nebula-graph-with-docker-compose/) | - | - | [使用源码](https://docs.nebula-graph.com.cn/{{nebula.release}}/4.deployment-and-installation/2.compile-and-install-nebula-graph/1.install-nebula-graph-by-compiling-the-source-code/) | [图数据库入门教程（零）通过编译源码来安装 NebulaGraph](https://www.bilibili.com/video/BV1YJ411i7Jn?spm_id_from=333.999.0.0) | + | [使用源码](https://docs.nebula-graph.com.cn/{{nebula.release}}/4.deployment-and-installation/2.compile-and-install-nebula-graph/1.install-nebula-graph-by-compiling-the-source-code/) | [图数据库入门教程（零）通过编译源码来安装{{nebula.name}}](https://www.bilibili.com/video/BV1YJ411i7Jn?spm_id_from=333.999.0.0) | |-|[如何选择部署方式？](https://www.bilibili.com/video/BV1vy4y1K7S5)| -### 2.2 启动 NebulaGraph +### 2.2 启动{{nebula.name}} | 文档 | | ------------------------------------------------------------ | - | [启停 NebulaGraph](https://docs.nebula-graph.com.cn/{{nebula.release}}/2.quick-start/5.start-stop-service/) | + | [启停{{nebula.name}}](https://docs.nebula-graph.com.cn/{{nebula.release}}/2.quick-start/5.start-stop-service/) | -### 2.3 连接 NebulaGraph +### 2.3 连接{{nebula.name}} | 文档 | ------------------------------------------------------------ | - | [连接 NebulaGraph](https://docs.nebula-graph.com.cn/{{nebula.release}}/2.quick-start/3.connect-to-nebula-graph/) | + | [连接{{nebula.name}}](https://docs.nebula-graph.com.cn/{{nebula.release}}/2.quick-start/3.connect-to-nebula-graph/) | ### 2.4 使用 nGQL 命令 @@ -88,13 +88,13 @@ | 文档 | | ------------------------------------------------------------ | - | [使用 RPM/DEB 包部署 NebulaGraph 多机集群](https://docs.nebula-graph.com.cn/{{nebula.release}}/4.deployment-and-installation/2.compile-and-install-nebula-graph/deploy-nebula-graph-cluster/) | + | [使用 RPM/DEB 包部署{{nebula.name}}多机集群](https://docs.nebula-graph.com.cn/{{nebula.release}}/4.deployment-and-installation/2.compile-and-install-nebula-graph/deploy-nebula-graph-cluster/) | ### 3.2 升级集群版本 | 文档 | | ------------------------------------------------------------ | - | [升级 NebulaGraph](https://docs.nebula-graph.com.cn/{{nebula.release}}/4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-graph-to-latest/) | + | [升级{{nebula.name}}](https://docs.nebula-graph.com.cn/{{nebula.release}}/4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-graph-to-latest/) | ### 3.3 配置Nebula @@ -190,7 +190,7 @@ | 数据导入 | [Nebula Importer](https://docs.nebula-graph.com.cn/{{nebula.release}}/nebula-importer/use-importer/) | [Nebula Importer](https://www.bilibili.com/video/BV1ny4y1u7i4) | | 数据导入 | [Nebula Spark Connector](https://docs.nebula-graph.com.cn/{{nebula.release}}/nebula-spark-connector/) | - | | 数据导入 | [Nebula Flink Connector](https://docs.nebula-graph.com.cn/{{nebula.release}}/nebula-flink-connector/) | - | - | 数据导入 | [Nebula Exchange 社区版](https://docs.nebula-graph.com.cn/{{nebula.release}}/nebula-exchange/about-exchange/ex-ug-what-is-exchange/) | [NebulaGraph 数据导入工具——Exchange](https://www.bilibili.com/video/BV1Pq4y177D9)、[Exchange 导入 SST 数据](https://www.bilibili.com/video/BV1y34y1o7Di?) | + | 数据导入 | [Nebula Exchange 社区版](https://docs.nebula-graph.com.cn/{{nebula.release}}/nebula-exchange/about-exchange/ex-ug-what-is-exchange/) | [{{nebula.name}}数据导入工具——Exchange](https://www.bilibili.com/video/BV1Pq4y177D9)、[Exchange 导入 SST 数据](https://www.bilibili.com/video/BV1y34y1o7Di?) | | 数据导出 | [Nebula Exchange 企业版](https://docs.nebula-graph.com.cn/{{nebula.release}}/nebula-exchange/about-exchange/ex-ug-what-is-exchange/) | - | @@ -198,7 +198,7 @@ | 文档 | 视频 | | ------------------------|------------------------------------ | - |[Nebula BR](../backup-and-restore/nebula-br/1.what-is-br.md)|[NebulaGraph 容灾备份工具 nebula-br](https://www.bilibili.com/video/BV11L4y1g7rD)| + |[Nebula BR](../backup-and-restore/nebula-br/1.what-is-br.md)|[{{nebula.name}}容灾备份工具 nebula-br](https://www.bilibili.com/video/BV11L4y1g7rD)| - 性能测试 @@ -241,13 +241,13 @@ | 文档 & 视频 | | ------------------------------------------------------------ | | [LDBC 数据导入及 nGQL 实践](https://nebula-graph.com.cn/posts/query-graph-with-ldbc-dataset/) | - | [基于 NebulaGraph 的 Betweenness Centrality 算法](https://nebula-graph.com.cn/posts/introduction-to-betweenness-centrality-algorithm/) | + | [基于{{nebula.name}}的 Betweenness Centrality 算法](https://nebula-graph.com.cn/posts/introduction-to-betweenness-centrality-algorithm/) | | [百亿级图数据在快手安全情报的应用与挑战](https://nebula-graph.com.cn/posts/kuaishou-security-intelligence-platform-with-nebula-graph/) | | [美团图数据库平台建设及业务实践](https://nebula-graph.com.cn/posts/meituan-graph-database-platform-practice/) | | [Akulaku 的智能风控实践](https://nebula-graph.com.cn/posts/intelligent-risk-control-practice-akulaku/) | - | [微信使用 NebulaGraph 的定制化开发](https://nebula-graph.com.cn/posts/nebula-graph-for-social-networking/) | - | [知乎使用 NebulaGraph 实践](https://mp.weixin.qq.com/s/K2QinpR5Rplw1teHpHtf4w) | - |[NebulaGraph 在微众银行的数据治理业务的实践](https://www.bilibili.com/video/BV1Pr4y1F7kA)| + | [微信使用{{nebula.name}}的定制化开发](https://nebula-graph.com.cn/posts/nebula-graph-for-social-networking/) | + | [知乎使用{{nebula.name}}实践](https://mp.weixin.qq.com/s/K2QinpR5Rplw1teHpHtf4w) | + |[{{nebula.name}}在微众银行的数据治理业务的实践](https://www.bilibili.com/video/BV1Pr4y1F7kA)| |[图数据库在安全风控场景的应用 @BOSS 直聘](https://www.bilibili.com/video/BV1Rh41117G9)| |[更多文档](https://nebula-graph.com.cn/posts/) 、[视频](https://space.bilibili.com/472621355/channel/series) | ## 6. 常见问题 @@ -257,34 +257,34 @@ | [常见问题 FAQ](https://docs.nebula-graph.com.cn/{{nebula.release}}/20.appendix/0.FAQ/#faq) | ## 7. 实操作业 - 用户可以通过完成以下实操作业来检测是否玩转 NebulaGraph。 + 用户可以通过完成以下实操作业来检测是否玩转{{nebula.name}}。 | 作业内容 | 参考 | | ------------------------------------------------------- | ------------------------------------------------------------ | - | 编译内核 | [使用源码安装 NebulaGraph](https://docs.nebula-graph.com.cn/{{nebula.release}}/4.deployment-and-installation/2.compile-and-install-nebula-graph/1.install-nebula-graph-by-compiling-the-source-code/) | + | 编译内核 | [使用源码安装{{nebula.name}}](https://docs.nebula-graph.com.cn/{{nebula.release}}/4.deployment-and-installation/2.compile-and-install-nebula-graph/1.install-nebula-graph-by-compiling-the-source-code/) | | 部署可视化工具 Studio、Dashboard、Explorer | [部署 Studio](https://docs.nebula-graph.com.cn/{{nebula.release}}/nebula-studio/deploy-connect/st-ug-deploy/)、[部署 Dashboard](https://docs.nebula-graph.com.cn/{{nebula.release}}/nebula-dashboard/2.deploy-dashboard/)、[部署 Explorer](https://docs.nebula-graph.com.cn/{{nebula.release}}/nebula-explorer/deploy-connect/ex-ug-deploy/) | - | 使用 K6 压测 NebulaGraph | [K6 在 NebulaGraph 上的压测实践](https://nebula-graph.com.cn/posts/practice-k6-at-nebula-graph/) | + | 使用 K6 压测{{nebula.name}} | [K6 在{{nebula.name}}上的压测实践](https://nebula-graph.com.cn/posts/practice-k6-at-nebula-graph/) | | 导入 LDBC 数据 | [LDBC 数据导入及 nGQL 实践](https://mp.weixin.qq.com/s/tbLGuuX6vNzLIw6o8ZGKpw) | | 查询 LDBC 数据（点查、K度邻居查询、路径查询、子图查询） | [LDBC](chrome-extension://gfbliohnnapiefjpjlpjnehglfpaknnc/pages/pdf_viewer.html?r=http://ldbcouncil.org/ldbc_snb_docs/ldbc-snb-specification.pdf) 和 [interactive-short-1.cypher](https://github.com/ldbc/ldbc_snb_interactive/blob/main/cypher/queries/interactive-short-1.cypher) | ## 8. 通过 CI/CP 考试 -图数据库 NebulaGraph 提供2个不同等级的图数据库技能认证考试： +{{nebula.name}}提供2个不同等级的图数据库技能认证考试： -- NebulaGraph Certified Insider (NGCI)：通过该考试证明用户对图数据库及 NebulaGraph 有基础的了解，是合格的 NebulaGraph 使用者。 +- NebulaGraph Certified Insider (NGCI)：通过该考试证明用户对图数据库及{{nebula.name}}有基础的了解，是合格的{{nebula.name}}使用者。 -- NebulaGraph Certified Professional (NGCP)：通过该考试证明用户对图数据库及 NebulaGraph 有深入的了解，是 NebulaGraph 专业人士。 +- NebulaGraph Certified Professional (NGCP)：通过该考试证明用户对图数据库及{{nebula.name}}有深入的了解，是{{nebula.name}}专业人士。 -考试用书[《开源分布式图数据库 NebulaGraph 完全指南》](https://docs.nebula-graph.com.cn/site/pdf/NebulaGraph-book.pdf) +考试用书[《开源分布式图数据库{{nebula.name}}完全指南》](https://docs.nebula-graph.com.cn/site/pdf/NebulaGraph-book.pdf) -单击[NebulaGraph 个人技能认证](https://discuss.nebula-graph.com.cn/t/topic/8728)查看考试说明及入口。 +单击[{{nebula.name}}个人技能认证](https://discuss.nebula-graph.com.cn/t/topic/8728)查看考试说明及入口。 ## 参考文档 -- 有关 NebulaGraph 的原理介绍，参见[开源分布式图数库论文](https://arxiv.org/pdf/2206.07278.pdf)。 +- 有关{{nebula.name}}的原理介绍，参见[开源分布式图数库论文](https://arxiv.org/pdf/2206.07278.pdf)。 -- 有关 [NebulaGraph 索引](../3.ngql-guide/14.native-index-statements/README.md)原理的介绍，参见[开源分布式图数库论文](https://arxiv.org/pdf/2206.07278.pdf)中的 2.4 节。 +- 有关 [{{nebula.name}}索引](../3.ngql-guide/14.native-index-statements/README.md)原理的介绍，参见[开源分布式图数库论文](https://arxiv.org/pdf/2206.07278.pdf)中的 2.4 节。 -- 有关 NebulaGraph 语言的概述，参见[开源分布式图数库论文](https://arxiv.org/pdf/2206.07278.pdf)中的 2.8 节。 +- 有关{{nebula.name}}语言的概述，参见[开源分布式图数库论文](https://arxiv.org/pdf/2206.07278.pdf)中的 2.8 节。 diff --git a/docs-2.0/20.appendix/mind-map.md b/docs-2.0/20.appendix/mind-map.md index 4826b00bc43..eff13e9f957 100644 --- a/docs-2.0/20.appendix/mind-map.md +++ b/docs-2.0/20.appendix/mind-map.md @@ -1,9 +1,9 @@ # 思维导图 -以下给出 NebulaGraph 结构框架的思维导图，用户可以[点击](https://www.mubucm.com/doc/34QEdbrFRwZ) 并查看大图。 +以下给出{{nebula.name}}结构框架的思维导图，用户可以[点击](https://www.mubucm.com/doc/34QEdbrFRwZ) 并查看大图。 -![NebulaGraph](https://docs-cdn.nebula-graph.com.cn/figures/Unknown-2.png) +![{{nebula.name}}](https://docs-cdn.nebula-graph.com.cn/figures/Unknown-2.png) 以下给出 nGQL 的思维导图，用户可以[点击](https://www.mubucm.com/doc/3heEUeLwbMZ) 并查看大图。 -![NebulaGraph nGQL](https://docs-cdn.nebula-graph.com.cn/figures/Unknown-3.png) +![nGQL](https://docs-cdn.nebula-graph.com.cn/figures/Unknown-3.png) 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 27e5a43340b..6152cdb3ccb 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 @@ -5,7 +5,7 @@ - 优化 - 支持在备份恢复页面查看数据备份恢复的进度。 - - 内置 NebulaGraph 企业版 v3.4.1 安装包。 + - 内置{{nebula.name}} v3.4.1 安装包。 ## 企业版 v3.4.1 @@ -18,8 +18,8 @@ ## 企业版 v3.4.0 - 功能 - - 支持查看 NebulaGraph 集群[运行日志](../../nebula-dashboard-ent/4.cluster-operator/cluster-information/runtime-log.md)。 - - 支持查看 NebulaGraph 集群[审计日志](../../nebula-dashboard-ent/4.cluster-operator/cluster-information/audit-log.md)。 + - 支持查看{{nebula.name}}集群[运行日志](../../nebula-dashboard-ent/4.cluster-operator/cluster-information/runtime-log.md)。 + - 支持查看{{nebula.name}}集群[审计日志](../../nebula-dashboard-ent/4.cluster-operator/cluster-information/audit-log.md)。 - 支持[作业管理](../../nebula-dashboard-ent/4.cluster-operator/cluster-information/job-management.md)。 - 备份恢复支持[增量备份](../../nebula-dashboard-ent/4.cluster-operator/operator/backup-and-restore.md)。 - 内置 [dashboard.service](../../nebula-dashboard-ent/2.deploy-connect-dashboard-ent.md) 脚本，支持一键管理 Dashboard 服务和查看 Dashboard 版本。 @@ -28,7 +28,7 @@ - 优化 - 创建集群时自动检测安装包是否适配操作系统。 - - 批量导入节点时支持指定 NebulaGraph 安装目录。 + - 批量导入节点时支持指定{{nebula.name}}安装目录。 - 删除集群时支持同时删除安装目录。 - 导入集群和服务监控中显示依赖服务。 - 告警规则静默支持中途取消。 @@ -39,7 +39,7 @@ - LDAP 开启后支持自动注册。 - 任务中心日志信息更加详细。 - 浏览器兼容提示。 - - NebulaGraph 许可证到期提醒。 + - {{nebula.name}}许可证到期提醒。 - 支持红旗操作系统 Asianux Linux 7 (Core)。 - 优化连接数据库、创建集群、扩缩容、批量导入节点等多处交互。 - 优化接口报错提示。 @@ -49,6 +49,6 @@ - 缺陷修复 - 修复服务监控的总览页面中选择监控时间范围不生效的问题。 - - 修复缩容时删除空节点没有删除对应 NebulaGraph 文件的问题。 + - 修复缩容时删除空节点没有删除对应{{nebula.name}}文件的问题。 - 修复切换诊断报告语言时，同时切换了全局语言的问题。 - 修复某个导入集群任务阻塞导致其他导入任务一直处于等待状态的问题。 diff --git a/docs-2.0/20.appendix/release-notes/nebula-comm-release-note.md b/docs-2.0/20.appendix/release-notes/nebula-comm-release-note.md index 975c4ad9904..e675a5e6435 100644 --- a/docs-2.0/20.appendix/release-notes/nebula-comm-release-note.md +++ b/docs-2.0/20.appendix/release-notes/nebula-comm-release-note.md @@ -1,4 +1,4 @@ -# NebulaGraph 社区版 {{ nebula.release }} release notes +# {{nebula.name}}社区版 {{ nebula.release }} release notes ## 缺陷修复 diff --git a/docs-2.0/20.appendix/release-notes/nebula-ent-release-note.md b/docs-2.0/20.appendix/release-notes/nebula-ent-release-note.md index cb7642a0ac0..7e99df94ea4 100644 --- a/docs-2.0/20.appendix/release-notes/nebula-ent-release-note.md +++ b/docs-2.0/20.appendix/release-notes/nebula-ent-release-note.md @@ -1,4 +1,4 @@ -# NebulaGraph 企业版 {{ nebula.release }} release notes +# {{nebula.name}} {{ nebula.release }} release notes ## 缺陷修复 diff --git a/docs-2.0/20.appendix/write-tools.md b/docs-2.0/20.appendix/write-tools.md index 22088a23e07..64418c37d74 100644 --- a/docs-2.0/20.appendix/write-tools.md +++ b/docs-2.0/20.appendix/write-tools.md @@ -1,6 +1,6 @@ # 导入工具选择 -有多种方式可以写入 NebulaGraph {{ nebula.release }}： +有多种方式可以写入{{nebula.name}} {{ nebula.release }}： - 使用[命令行 -f 的方式](../2.quick-start/3.quick-start-on-premise/3.connect-to-nebula-graph.md)导入：可以导入少量准备好的 nGQL 文件，适合少量手工测试数据准备； - 使用 [studio 导入](../nebula-studio/quick-start/st-ug-import-data.md)：可以用过浏览器导入本机多个 csv 文件，格式有限制； diff --git a/docs-2.0/3.ngql-guide/1.nGQL-overview/1.overview.md b/docs-2.0/3.ngql-guide/1.nGQL-overview/1.overview.md index f793631bee2..4d7d138b870 100644 --- a/docs-2.0/3.ngql-guide/1.nGQL-overview/1.overview.md +++ b/docs-2.0/3.ngql-guide/1.nGQL-overview/1.overview.md @@ -1,8 +1,8 @@ # 什么是 nGQL -nGQL（NebulaGraph Query Language）是 NebulaGraph 使用的的声明式图查询语言，支持灵活高效的[图模式](3.graph-patterns.md)，而且 nGQL 是为开发和运维人员设计的类 SQL 查询语言，易于学习。 +nGQL是{{nebula.name}}使用的的声明式图查询语言，支持灵活高效的[图模式](3.graph-patterns.md)，而且 nGQL 是为开发和运维人员设计的类 SQL 查询语言，易于学习。 -nGQL 是一个进行中的项目，会持续发布新特性和优化，因此可能会出现语法和实际操作不一致的问题，如果遇到此类问题，请提交 [issue](https://github.com/vesoft-inc/nebula/issues) 通知 NebulaGraph 团队。NebulaGraph 3.0 及更新版本正在支持 [openCypher 9](https://www.opencypher.org/resources)。 +nGQL 是一个进行中的项目，会持续发布新特性和优化，因此可能会出现语法和实际操作不一致的问题，如果遇到此类问题，请提交 [issue](https://github.com/vesoft-inc/nebula/issues) 通知{{nebula.name}}团队。{{nebula.name}} 3.0 及更新版本正在支持 [openCypher 9](https://www.opencypher.org/resources)。 ## nGQL 可以做什么 @@ -24,7 +24,7 @@ nGQL 是一个进行中的项目，会持续发布新特性和优化，因此可 ## 示例数据 Basketballplayer -用户可以下载 NebulaGraph 示例数据 [basketballplayer 文件](https://docs.nebula-graph.io/2.0/basketballplayer-2.X.ngql)，然后使用 [NebulaGraph Console](../../2.quick-start/3.quick-start-on-premise/3.connect-to-nebula-graph.md)，使用选项`-f`执行脚本。 +用户可以下载{{nebula.name}}示例数据 [basketballplayer 文件](https://docs.nebula-graph.io/2.0/basketballplayer-2.X.ngql)，然后使用 [NebulaGraph Console](../../2.quick-start/3.quick-start-on-premise/3.connect-to-nebula-graph.md)，使用选项`-f`执行脚本。 !!! note @@ -33,7 +33,7 @@ nGQL 是一个进行中的项目，会持续发布新特性和优化，因此可 ## 占位标识符和占位符值 -NebulaGraph 查询语言 nGQL 参照以下标准设计： +{{nebula.name}}查询语言 nGQL 参照以下标准设计： - (Draft) ISO/IEC JTC1 N14279 SC 32 - Database_Languages - GQL @@ -80,7 +80,7 @@ nebula> CREATE TAG IF NOT EXISTS player(name string, age int); ### 原生 nGQL 和 openCypher 的关系 -原生 nGQL 是由 NebulaGraph 自行创造和实现的图查询语言。openCypher 是由 openCypher Implementers Group 组织所开源和维护的图查询语言，最新版本为 openCypher 9。 +原生 nGQL 是由{{nebula.name}}自行创造和实现的图查询语言。openCypher 是由 openCypher Implementers Group 组织所开源和维护的图查询语言，最新版本为 openCypher 9。 由于 nGQL 语言部分兼容了 openCypher，这个部分在本文中称为 openCypher 兼容语句。 @@ -104,7 +104,7 @@ nebula> CREATE TAG IF NOT EXISTS player(name string, age int); 在本文搜索 "compatibility" 或者 “兼容性” 查看具体不兼容的细节。 - 在 [NebulaGraph Issues](https://github.com/vesoft-inc/nebula/issues?q=is%3Aissue+is%3Aopen+label%3Aincompatible) 中已经列出已知的兼容错误。如果发现这种类型的新问题，请提交问题并附带`incompatible`标签。 + 在 [Issues](https://github.com/vesoft-inc/nebula/issues?q=is%3Aissue+is%3Aopen+label%3Aincompatible) 中已经列出已知的兼容错误。如果发现这种类型的新问题，请提交问题并附带`incompatible`标签。 ### nGQL 和 openCypher 9 的 主要差异有哪些？ @@ -132,7 +132,7 @@ nebula> CREATE TAG IF NOT EXISTS player(name string, age int); ### 哪里可以找到更多 nGQL 的示例？ -用户可以在 NebulaGraph GitHub 的 [features](https://github.com/vesoft-inc/nebula/tree/master/tests/tck/features) 目录内查看超过 2500 条 nGQL 示例。 +用户可以在 GitHub 的 [features](https://github.com/vesoft-inc/nebula/tree/master/tests/tck/features) 目录内查看超过 2500 条 nGQL 示例。 features 目录内包含很多。features 格式的文件，每个文件都记录了使用 nGQL 的场景和示例。例如： @@ -197,7 +197,7 @@ Feature: Comparison of where clause |`Given`|描述执行示例语句的前提条件。| |`Scenario`|描述具体场景。如果场景之前有`@skip`标识，表示这个场景下示例语句可能无法正常工作，请不要在生产环境中使用该示例语句。| |`When`|描述要执行的 nGQL 示例语句。可以是`executing query`或`profiling query`。| -|`Then`|描述执行`When`内语句的预期返回结果。如果返回结果和文档不同，请提交 [issue](https://github.com/vesoft-inc/nebula/issues) 通知 NebulaGraph 团队。| +|`Then`|描述执行`When`内语句的预期返回结果。如果返回结果和文档不同，请提交 [issue](https://github.com/vesoft-inc/nebula/issues) 通知{{nebula.name}}团队。| |`And`|描述执行`When`内语句的副作用或执行计划。| | `@skip` | 跳过这个示例。通常表示测试代码还没有准备好。 | @@ -211,6 +211,6 @@ Feature: Comparison of where clause 不支持。也没有计划。 -NebulaGraph 的数据模型是属性图，是一个强 Schema 系统，不支持 RDF 标准。 +{{nebula.name}}的数据模型是属性图，是一个强 Schema 系统，不支持 RDF 标准。 nGQL 也不支持 SPARQL 和 GraphQL。 diff --git a/docs-2.0/3.ngql-guide/1.nGQL-overview/3.graph-patterns.md b/docs-2.0/3.ngql-guide/1.nGQL-overview/3.graph-patterns.md index 265b2544a52..1711bde8273 100644 --- a/docs-2.0/3.ngql-guide/1.nGQL-overview/3.graph-patterns.md +++ b/docs-2.0/3.ngql-guide/1.nGQL-overview/3.graph-patterns.md @@ -1,6 +1,6 @@ # 模式 -模式（pattern）和图模式匹配，是图查询语言的核心功能，本文介绍 NebulaGraph 设计的各种模式，部分还未实现。 +模式（pattern）和图模式匹配，是图查询语言的核心功能，本文介绍{{nebula.name}}设计的各种模式，部分还未实现。 ## 单点模式 diff --git a/docs-2.0/3.ngql-guide/1.nGQL-overview/comments.md b/docs-2.0/3.ngql-guide/1.nGQL-overview/comments.md index 89c1827f310..486a3c2fed4 100644 --- a/docs-2.0/3.ngql-guide/1.nGQL-overview/comments.md +++ b/docs-2.0/3.ngql-guide/1.nGQL-overview/comments.md @@ -2,12 +2,6 @@ 本文介绍 nGQL 中的注释方式。 - -!!! compatibility "历史版本兼容性" - - - NebulaGraph 1.x 支持四种注释方式：`#`、`--`、`//`、`/* */`。 - - NebulaGraph 2.x 中，`--`不再是注释符。 - ## Examples ```ngql diff --git a/docs-2.0/3.ngql-guide/1.nGQL-overview/ngql-style-guide.md b/docs-2.0/3.ngql-guide/1.nGQL-overview/ngql-style-guide.md index a0c7cfb1b24..3608b4f7e27 100644 --- a/docs-2.0/3.ngql-guide/1.nGQL-overview/ngql-style-guide.md +++ b/docs-2.0/3.ngql-guide/1.nGQL-overview/ngql-style-guide.md @@ -190,7 +190,7 @@ nGQL 没有严格的构建格式要求，但根据恰当而统一的风格创建 字符串中需要嵌套单引号或双引号时，用反斜线（\）转义。例如： ```ngql - RETURN "\"NebulaGraph is amazing,\" the user says."; + RETURN "\"The database is amazing,\" the user says."; ``` diff --git a/docs-2.0/3.ngql-guide/10.tag-statements/1.create-tag.md b/docs-2.0/3.ngql-guide/10.tag-statements/1.create-tag.md index 2c82375186b..698843515d3 100644 --- a/docs-2.0/3.ngql-guide/10.tag-statements/1.create-tag.md +++ b/docs-2.0/3.ngql-guide/10.tag-statements/1.create-tag.md @@ -35,7 +35,7 @@ CREATE TAG [IF NOT EXISTS] |``|属性名称。每个 Tag 中的属性名称必须唯一。属性的命名规则与 Tag 相同。| |``|属性的数据类型，目前支持[数值](../3.data-types/1.numeric.md)、[布尔](../3.data-types/2.boolean.md)、[字符串](../3.data-types/3.string.md)以及[日期与时间](../3.data-types/4.date-and-time.md)。| |`NULL \| NOT NULL`|指定属性值是否支持为`NULL`。默认值为`NULL`。当指定属性值为`NOT NULL`时，必需指定属性的默认值，也就是`DEFAULT`的值。| -|`DEFAULT`|指定属性的默认值。默认值可以是一个文字值或 NebulaGraph 支持的表达式。如果插入点时没有指定某个属性的值，则使用默认值。| +|`DEFAULT`|指定属性的默认值。默认值可以是一个文字值或{{nebula.name}}支持的表达式。如果插入点时没有指定某个属性的值，则使用默认值。| |`COMMENT`|对单个属性或 Tag 的描述。最大为 256 字节。默认无描述。| |`TTL_DURATION`|指定时间戳差值，单位：秒。时间戳差值必须为 64 位非负整数。属性值和时间戳差值之和如果小于当前时间戳，属性就会过期。默认值为`0`，表示属性永不过期。| |`TTL_COL`|指定要设置存活时间的属性。属性的数据类型必须是`int`或者`timestamp`。一个 Tag 只能指定一个字段为`TTL_COL`。更多 TTL 的信息请参见 [TTL](../8.clauses-and-options/ttl-options.md)。| diff --git a/docs-2.0/3.ngql-guide/4.job-statements.md b/docs-2.0/3.ngql-guide/4.job-statements.md index 32d3a6b4699..34142c4c0f4 100644 --- a/docs-2.0/3.ngql-guide/4.job-statements.md +++ b/docs-2.0/3.ngql-guide/4.job-statements.md @@ -104,7 +104,7 @@ nebula> SUBMIT JOB FLUSH; !!! Note - 如果存储在 NebulaGraph 中的数据有变化，为了获取最新的统计结果，请重新执行`SUBMIT JOB STATS`。 + 如果存储在{{nebula.name}}中的数据有变化，为了获取最新的统计结果，请重新执行`SUBMIT JOB STATS`。 示例： @@ -119,7 +119,7 @@ nebula> SUBMIT JOB STATS; ## SUBMIT JOB DOWNLOAD/INGEST -`SUBMIT JOB DOWNLOAD HDFS`和`SUBMIT JOB INGEST`命令用于将 SST 文件导入 NebulaGraph。详情参见[导入 SST 文件数据](../nebula-exchange/use-exchange/ex-ug-import-from-sst.md)。 +`SUBMIT JOB DOWNLOAD HDFS`和`SUBMIT JOB INGEST`命令用于将 SST 文件导入{{nebula.name}}。详情参见[导入 SST 文件数据](../nebula-exchange/use-exchange/ex-ug-import-from-sst.md)。 `SUBMIT JOB DOWNLOAD HDFS`语句会下载指定的 HDFS 上的 SST 文件。 From ed13aecb9edc8445baac71e08e17ea6cc4f7d9f3 Mon Sep 17 00:00:00 2001 From: cooper-lzy <78672629+cooper-lzy@users.noreply.github.com> Date: Tue, 11 Apr 2023 10:21:08 +0800 Subject: [PATCH 122/137] update --- docs-2.0/3.ngql-guide/10.tag-statements/2.drop-tag.md | 2 +- .../10.tag-statements/improve-query-by-tag-index.md | 2 +- .../3.ngql-guide/11.edge-type-statements/1.create-edge.md | 2 +- .../3.ngql-guide/12.vertex-statements/1.insert-vertex.md | 6 +++--- .../3.ngql-guide/12.vertex-statements/2.update-vertex.md | 2 +- .../3.ngql-guide/12.vertex-statements/4.delete-vertex.md | 6 +++--- docs-2.0/3.ngql-guide/13.edge-statements/1.insert-edge.md | 4 ++-- docs-2.0/3.ngql-guide/13.edge-statements/2.update-edge.md | 2 +- .../14.native-index-statements/1.create-native-index.md | 6 +++--- .../14.native-index-statements/4.rebuild-native-index.md | 2 +- .../3.ngql-guide/14.native-index-statements/README.md | 4 ++-- .../1.search-with-text-based-index.md | 2 +- .../17.query-tuning-statements/1.explain-and-profile.md | 2 +- .../.1.configs-syntax.md | 4 ++-- docs-2.0/3.ngql-guide/3.data-types/1.numeric.md | 4 ++-- docs-2.0/3.ngql-guide/3.data-types/2.boolean.md | 2 +- docs-2.0/3.ngql-guide/3.data-types/3.string.md | 6 +++--- docs-2.0/3.ngql-guide/3.data-types/4.date-and-time.md | 8 ++++---- docs-2.0/3.ngql-guide/3.data-types/5.null.md | 6 +++--- docs-2.0/3.ngql-guide/3.data-types/9.type-conversion.md | 2 +- 20 files changed, 37 insertions(+), 37 deletions(-) diff --git a/docs-2.0/3.ngql-guide/10.tag-statements/2.drop-tag.md b/docs-2.0/3.ngql-guide/10.tag-statements/2.drop-tag.md index a49df6306f6..2fb4cc36705 100644 --- a/docs-2.0/3.ngql-guide/10.tag-statements/2.drop-tag.md +++ b/docs-2.0/3.ngql-guide/10.tag-statements/2.drop-tag.md @@ -12,7 +12,7 @@ !!! Compatibility - NebulaGraph {{nebula.release}} 中默认不支持插入无 Tag 的点。如需使用无 Tag 的点，在集群内所有 Graph 服务的配置文件（`nebula-graphd.conf`）中新增`--graph_use_vertex_key=true`；在所有 Storage 服务的配置文件（`nebula-storaged.conf`）中新增`--use_vertex_key=true`。 + {{nebula.name}} {{nebula.release}} 中默认不支持插入无 Tag 的点。如需使用无 Tag 的点，在集群内所有 Graph 服务的配置文件（`nebula-graphd.conf`）中新增`--graph_use_vertex_key=true`；在所有 Storage 服务的配置文件（`nebula-storaged.conf`）中新增`--use_vertex_key=true`。 ## 前提条件 diff --git a/docs-2.0/3.ngql-guide/10.tag-statements/improve-query-by-tag-index.md b/docs-2.0/3.ngql-guide/10.tag-statements/improve-query-by-tag-index.md index a7ba3adb440..4bbd6777d02 100644 --- a/docs-2.0/3.ngql-guide/10.tag-statements/improve-query-by-tag-index.md +++ b/docs-2.0/3.ngql-guide/10.tag-statements/improve-query-by-tag-index.md @@ -2,7 +2,7 @@ 在 openCypher 中，有增加标签（`SET label`）和移除标签（`REMOVE label`）的功能，可以用于加速查询或者标记过程。 -在 NebulaGraph 中，可以通过 Tag 变相实现相同操作，创建 Tag 并将 Tag 插入到已有的点上，就可以根据 Tag 名称快速查找点，也可以通过`DELETE TAG`删除某些点上不再需要的 Tag。 +在{{nebula.name}}中，可以通过 Tag 变相实现相同操作，创建 Tag 并将 Tag 插入到已有的点上，就可以根据 Tag 名称快速查找点，也可以通过`DELETE TAG`删除某些点上不再需要的 Tag。 ## 示例 diff --git a/docs-2.0/3.ngql-guide/11.edge-type-statements/1.create-edge.md b/docs-2.0/3.ngql-guide/11.edge-type-statements/1.create-edge.md index c0e9c16b57b..3c3e85c7a94 100644 --- a/docs-2.0/3.ngql-guide/11.edge-type-statements/1.create-edge.md +++ b/docs-2.0/3.ngql-guide/11.edge-type-statements/1.create-edge.md @@ -35,7 +35,7 @@ CREATE EDGE [IF NOT EXISTS] |``|属性名称。每个 Edge type 中的属性名称必须唯一。属性的命名规则与 Edge type 相同。| |``|属性的数据类型，目前支持[数值](../3.data-types/1.numeric.md)、[布尔](../3.data-types/2.boolean.md)、[字符串](../3.data-types/3.string.md)以及[日期与时间](../3.data-types/4.date-and-time.md)。| |`NULL \| NOT NULL`|指定属性值是否支持为`NULL`。默认值为`NULL`。当指定属性值为`NOT NULL`时，必需指定属性的默认值，也就是`DEFAULT`的值。| -|`DEFAULT`|指定属性的默认值。默认值可以是一个文字值或 NebulaGraph 支持的表达式。如果插入边时没有指定某个属性的值，则使用默认值。| +|`DEFAULT`|指定属性的默认值。默认值可以是一个文字值或{{nebula.name}}支持的表达式。如果插入边时没有指定某个属性的值，则使用默认值。| |`COMMENT`|对单个属性或 Edge type 的描述。最大为 256 字节。默认无描述。| |`TTL_DURATION`|指定时间戳差值，单位：秒。时间戳差值必须为 64 位非负整数。属性值和时间戳差值之和如果小于当前时间戳，属性就会过期。默认值为`0`，表示属性永不过期。| |`TTL_COL`|指定要设置存活时间的属性。属性的数据类型必须是`int`或者`timestamp`。一个 Edge type 只能指定一个字段为`TTL_COL`。更多 TTL 的信息请参见 [TTL](../8.clauses-and-options/ttl-options.md)。| diff --git a/docs-2.0/3.ngql-guide/12.vertex-statements/1.insert-vertex.md b/docs-2.0/3.ngql-guide/12.vertex-statements/1.insert-vertex.md index 21b2fefafea..38ce4a2967b 100644 --- a/docs-2.0/3.ngql-guide/12.vertex-statements/1.insert-vertex.md +++ b/docs-2.0/3.ngql-guide/12.vertex-statements/1.insert-vertex.md @@ -1,6 +1,6 @@ # INSERT VERTEX -`INSERT VERTEX`语句可以在 NebulaGraph 实例的指定图空间中插入一个或多个点。 +`INSERT VERTEX`语句可以在{{nebula.name}}实例的指定图空间中插入一个或多个点。 ## 前提条件 @@ -57,11 +57,11 @@ prop_value_list: !!! caution - NebulaGraph {{nebula.release}} 中默认不支持插入无 Tag 的点。如需使用无 Tag 的点，在集群内所有 Graph 服务的配置文件（`nebula-graphd.conf`）中新增`--graph_use_vertex_key=true`；在所有 Storage 服务的配置文件（`nebula-storaged.conf`）中新增`--use_vertex_key=true`。插入无 Tag 点的命令示例如`INSERT VERTEX VALUES "1":();`。 + {{nebula.name}} {{nebula.release}} 中默认不支持插入无 Tag 的点。如需使用无 Tag 的点，在集群内所有 Graph 服务的配置文件（`nebula-graphd.conf`）中新增`--graph_use_vertex_key=true`；在所有 Storage 服务的配置文件（`nebula-storaged.conf`）中新增`--use_vertex_key=true`。插入无 Tag 点的命令示例如`INSERT VERTEX VALUES "1":();`。 - `property_name`：需要设置的属性名称。 -- `vid`：点 ID。在 NebulaGraph {{ nebula.release }} 中支持字符串和整数，需要在创建图空间时设置，详情请参见 [CREATE SPACE](../9.space-statements/1.create-space.md)。 +- `vid`：点 ID。在{{nebula.name}} {{ nebula.release }} 中支持字符串和整数，需要在创建图空间时设置，详情请参见 [CREATE SPACE](../9.space-statements/1.create-space.md)。 - `property_value`：根据`prop_name_list`填写属性值。如果没有填写属性值，而 Tag 中对应的属性设置为`NOT NULL`，会返回错误。详情请参见 [CREATE TAG](../10.tag-statements/1.create-tag.md)。 diff --git a/docs-2.0/3.ngql-guide/12.vertex-statements/2.update-vertex.md b/docs-2.0/3.ngql-guide/12.vertex-statements/2.update-vertex.md index 75ae28c4a5b..3e8b2315c1d 100644 --- a/docs-2.0/3.ngql-guide/12.vertex-statements/2.update-vertex.md +++ b/docs-2.0/3.ngql-guide/12.vertex-statements/2.update-vertex.md @@ -2,7 +2,7 @@ `UPDATE VERTEX`语句可以修改点上 Tag 的属性值。 -NebulaGraph 支持 CAS（compare and set）操作。 +{{nebula.name}}支持 CAS（compare and set）操作。 !!! note diff --git a/docs-2.0/3.ngql-guide/12.vertex-statements/4.delete-vertex.md b/docs-2.0/3.ngql-guide/12.vertex-statements/4.delete-vertex.md index aa540230e58..8616689b49b 100644 --- a/docs-2.0/3.ngql-guide/12.vertex-statements/4.delete-vertex.md +++ b/docs-2.0/3.ngql-guide/12.vertex-statements/4.delete-vertex.md @@ -4,7 +4,7 @@ !!! Compatibility - NebulaGraph 2.x 默认删除点及关联该点的出边和入，NebulaGraph {{nebula.release}} 默认只删除点，不删除该点关联的出边和入边，此时将默认存在悬挂边。 + {{nebula.name}} 2.x 默认删除点及关联该点的出边和入，{{nebula.name}} {{nebula.release}} 默认只删除点，不删除该点关联的出边和入边，此时将默认存在悬挂边。 `DELETE VERTEX`语句一次可以删除一个或多个点。用户可以结合管道符一起使用，详情请参见[管道符](../5.operators/4.pipe.md)。 @@ -41,7 +41,7 @@ nebula> GO FROM "player100" OVER serve WHERE properties(edge).start_year == "202 ## 删除过程 -NebulaGraph 找到目标点并删除，该目标点的所有邻边（出边和入边）将成为悬挂边。 +{{nebula.name}}找到目标点并删除，该目标点的所有邻边（出边和入边）将成为悬挂边。 !!! caution @@ -50,5 +50,5 @@ NebulaGraph 找到目标点并删除，该目标点的所有邻边（出边和 ## 悬挂边视频 -* [NebulaGraph 的悬挂边小科普](https://www.bilibili.com/video/BV1GR4y1F7ko)（2 分 28 秒） +* [{{nebula.name}} 的悬挂边小科普](https://www.bilibili.com/video/BV1GR4y1F7ko)（2 分 28 秒） diff --git a/docs-2.0/3.ngql-guide/13.edge-statements/1.insert-edge.md b/docs-2.0/3.ngql-guide/13.edge-statements/1.insert-edge.md index 19c5a240311..ecafeb50a3d 100644 --- a/docs-2.0/3.ngql-guide/13.edge-statements/1.insert-edge.md +++ b/docs-2.0/3.ngql-guide/13.edge-statements/1.insert-edge.md @@ -1,6 +1,6 @@ # INSERT EDGE -`INSERT EDGE`语句可以在 NebulaGraph 实例的指定图空间中插入一条或多条边。边是有方向的，从起始点（src_vid）到目的点（dst_vid）。 +`INSERT EDGE`语句可以在{{nebula.name}}实例的指定图空间中插入一条或多条边。边是有方向的，从起始点（src_vid）到目的点（dst_vid）。 `INSERT EDGE`的执行方式为覆盖式插入。如果已有 Edge type、起点、终点、rank 都相同的边，则**覆盖**原边。 @@ -96,7 +96,7 @@ nebula> FETCH PROP ON e2 "14"->"15"@1 YIELD edge AS e; !!! Note - * NebulaGraph {{ nebula.release }} 允许存在悬挂边（Dangling edge）。因此可以在起点或者终点存在前，先写边；此时就可以通过 `._src`或`._dst`获取到（尚未写入的）点 VID（不建议这样使用）。 + * {{nebula.name}} {{ nebula.release }} 允许存在悬挂边（Dangling edge）。因此可以在起点或者终点存在前，先写边；此时就可以通过 `._src`或`._dst`获取到（尚未写入的）点 VID（不建议这样使用）。 * 目前还不能保证操作的原子性，如果失败请重试，否则会发生部分写入。此时读取该数据的行为是未定义的。例如写入操作涉及到多个机器时，可能会出现插入单个边的正反向边只写入成功一个，或者插入多个边时只写入成功一部分，此时会返回报错，请重新执行命令。 * 并发写入同一条边会报`edge conflict`错误，可稍后重试。 * `边的 INSERT 速度`大约是点的 INSERT 速度一半。原因是 INSERT 边会对应 storaged 的两个 INSERT，`INSERT 点`对应 storaged 的一个 INSERT。 diff --git a/docs-2.0/3.ngql-guide/13.edge-statements/2.update-edge.md b/docs-2.0/3.ngql-guide/13.edge-statements/2.update-edge.md index bca1739c98b..4d7224de0de 100644 --- a/docs-2.0/3.ngql-guide/13.edge-statements/2.update-edge.md +++ b/docs-2.0/3.ngql-guide/13.edge-statements/2.update-edge.md @@ -2,7 +2,7 @@ `UPDATE EDGE`语句可以修改边上 Edge type 的属性。 -NebulaGraph 支持 CAS（compare and swap）操作。 +{{nebula.name}}支持 CAS（compare and swap）操作。 ## 语法 diff --git a/docs-2.0/3.ngql-guide/14.native-index-statements/1.create-native-index.md b/docs-2.0/3.ngql-guide/14.native-index-statements/1.create-native-index.md index af4643fae96..eb0302c0515 100644 --- a/docs-2.0/3.ngql-guide/14.native-index-statements/1.create-native-index.md +++ b/docs-2.0/3.ngql-guide/14.native-index-statements/1.create-native-index.md @@ -40,13 +40,13 @@ 如果必须使用索引，通常按照如下步骤： -1. 初次导入数据至 NebulaGraph。 +1. 初次导入数据至{{nebula.name}}。 2. 创建索引。 3. [重建索引](4.rebuild-native-index.md)。 -4. 使用 [LOOKUP](../7.general-query-statements/5.lookup.md) 或 [MATCH](../7.general-query-statements/2.match.md) 语句查询数据。不需要（也无法）指定使用哪个索引，NebulaGraph 会自动计算。 +4. 使用 [LOOKUP](../7.general-query-statements/5.lookup.md) 或 [MATCH](../7.general-query-statements/2.match.md) 语句查询数据。不需要（也无法）指定使用哪个索引，{{nebula.name}}会自动计算。 !!! Note @@ -54,7 +54,7 @@ 日常增量写入时保持 `--disable_auto_compaction = false`。 - 新创建的索引并不会立刻生效。创建新的索引并尝试立刻使用（例如`LOOKUP`或者`REBUILD INDEX`) 通常会失败（报错`can't find xxx in the space`）。因为创建步骤是异步实现的，NebulaGraph 要在下一个心跳周期才能完成索引的创建。为确保数据同步，后续操作能顺利进行，请等待 2 个心跳周期（20 秒）。如果需要修改心跳间隔，请为[所有配置文件](../../5.configurations-and-logs/1.configurations/1.configurations.md)修改参数`heartbeat_interval_secs`。 + 新创建的索引并不会立刻生效。创建新的索引并尝试立刻使用（例如`LOOKUP`或者`REBUILD INDEX`) 通常会失败（报错`can't find xxx in the space`）。因为创建步骤是异步实现的，{{nebula.name}}要在下一个心跳周期才能完成索引的创建。为确保数据同步，后续操作能顺利进行，请等待 2 个心跳周期（20 秒）。如果需要修改心跳间隔，请为[所有配置文件](../../5.configurations-and-logs/1.configurations/1.configurations.md)修改参数`heartbeat_interval_secs`。 !!! danger diff --git a/docs-2.0/3.ngql-guide/14.native-index-statements/4.rebuild-native-index.md b/docs-2.0/3.ngql-guide/14.native-index-statements/4.rebuild-native-index.md index 5ce23a6cbe1..f147e6b82d4 100644 --- a/docs-2.0/3.ngql-guide/14.native-index-statements/4.rebuild-native-index.md +++ b/docs-2.0/3.ngql-guide/14.native-index-statements/4.rebuild-native-index.md @@ -60,5 +60,5 @@ nebula> SHOW JOB 31; +----------------+---------------------+------------+-------------------------+-------------------------+-------------+ ``` -NebulaGraph 创建一个任务去重建索引，因此可以根据返回的任务 ID，通过`SHOW JOB `语句查看任务状态。详情请参见 [SHOW JOB](../4.job-statements.md#show_job)。 +{{nebula.name}}创建一个任务去重建索引，因此可以根据返回的任务 ID，通过`SHOW JOB `语句查看任务状态。详情请参见 [SHOW JOB](../4.job-statements.md#show_job)。 diff --git a/docs-2.0/3.ngql-guide/14.native-index-statements/README.md b/docs-2.0/3.ngql-guide/14.native-index-statements/README.md index 8b77e0c654f..134940a807e 100644 --- a/docs-2.0/3.ngql-guide/14.native-index-statements/README.md +++ b/docs-2.0/3.ngql-guide/14.native-index-statements/README.md @@ -1,8 +1,8 @@ # 索引介绍 -NebulaGraph 支持两种类型索引：原生索引和全文索引。 +{{nebula.name}}支持两种类型索引：原生索引和全文索引。 -和一般数据库意义上的索引概念不同，NebulaGraph 中的索引没有加速查询的功能，是用于定位到数据的必要前置条件。 +和一般数据库意义上的索引概念不同，{{nebula.name}}中的索引没有加速查询的功能，是用于定位到数据的必要前置条件。 ## 原生索引 diff --git a/docs-2.0/3.ngql-guide/15.full-text-index-statements/1.search-with-text-based-index.md b/docs-2.0/3.ngql-guide/15.full-text-index-statements/1.search-with-text-based-index.md index d5120423162..b96ade8ce86 100644 --- a/docs-2.0/3.ngql-guide/15.full-text-index-statements/1.search-with-text-based-index.md +++ b/docs-2.0/3.ngql-guide/15.full-text-index-statements/1.search-with-text-based-index.md @@ -89,7 +89,7 @@ nebula> SHOW TEXT SEARCH CLIENTS; //切换图空间。 nebula> USE basketballplayer; -//添加 listener 到 NebulaGraph 集群。 +//添加 listener 到{{nebula.name}}集群。 nebula> ADD LISTENER ELASTICSEARCH 192.168.8.5:9789; //检查是否成功添加 listener，当状态为 Online 时表示成功添加。 diff --git a/docs-2.0/3.ngql-guide/17.query-tuning-statements/1.explain-and-profile.md b/docs-2.0/3.ngql-guide/17.query-tuning-statements/1.explain-and-profile.md index a569564ec51..b3ad6dfc76a 100644 --- a/docs-2.0/3.ngql-guide/17.query-tuning-statements/1.explain-and-profile.md +++ b/docs-2.0/3.ngql-guide/17.query-tuning-statements/1.explain-and-profile.md @@ -6,7 +6,7 @@ ## 执行计划 -执行计划由 NebulaGraph 查询引擎中的执行计划器决定。 +执行计划由{{nebula.name}}查询引擎中的执行计划器决定。 执行计划器将解析后的 nGQL 语句处理为`action`。`action`是最小的执行单元。典型的`action`包括获取指定点的所有邻居、获取边的属性、根据条件过滤点或边等。每个`action`都被分配给一个`operator`。 diff --git a/docs-2.0/3.ngql-guide/18.operation-and-maintenance-statements/.1.configs-syntax.md b/docs-2.0/3.ngql-guide/18.operation-and-maintenance-statements/.1.configs-syntax.md index 64d2de432a8..851b7f9da5b 100644 --- a/docs-2.0/3.ngql-guide/18.operation-and-maintenance-statements/.1.configs-syntax.md +++ b/docs-2.0/3.ngql-guide/18.operation-and-maintenance-statements/.1.configs-syntax.md @@ -1,10 +1,10 @@ # CONFIG -第一次启动 NebulaGraph 集群时，系统会从本地配置文件中读取配置，然后保存在 Meta 服务中，后续重启集群，也会从 Meta 服务中读取配置。`CONFIG`语句可以修改 Meta 服务中保存的 NebulaGraph 配置，不会修改本地配置文件。 +第一次启动{{nebula.name}}集群时，系统会从本地配置文件中读取配置，然后保存在 Meta 服务中，后续重启集群，也会从 Meta 服务中读取配置。`CONFIG`语句可以修改 Meta 服务中保存的{{nebula.name}}配置，不会修改本地配置文件。 !!! Note - 根据过往实践，建议让 NebulaGraph 从本地文件获取配置。详情请参见[配置简介](../../5.configurations-and-logs/1.configurations/1.configurations.md#修改配置)。 + 根据过往实践，建议让{{nebula.name}}从本地文件获取配置。详情请参见[配置简介](../../5.configurations-and-logs/1.configurations/1.configurations.md#修改配置)。 ## SHOW CONFIGS diff --git a/docs-2.0/3.ngql-guide/3.data-types/1.numeric.md b/docs-2.0/3.ngql-guide/3.data-types/1.numeric.md index 6f9276cb306..3647b8ef83c 100644 --- a/docs-2.0/3.ngql-guide/3.data-types/1.numeric.md +++ b/docs-2.0/3.ngql-guide/3.data-types/1.numeric.md @@ -43,13 +43,13 @@ nGQL 支持科学计数法，例如`1e2`、`1.1e2`、`.3e4`、`1.e4`、`-1234E-1 例如，nGQL 不支持设置 INT8 类型的 [VID](../../1.introduction/3.vid.md)，但支持将 [TAG](../10.tag-statements/1.create-tag.md) 或 [Edge type](../11.edge-type-statements/1.create-edge.md) 的某个属性类型设置为 INT8。当使用 nGQL 语句读取 INT8 类型的属性时，获取到的值的类型为 INT64。 -- NebulaGraph 支持写入多种进制的数值： +- {{nebula.name}}支持写入多种进制的数值： - 十进制，例如`123456`。 - 十六进制，例如`0x1e240`。 - 八进制，例如`0361100`。 - 但 NebulaGraph 会将写入的非十进制数值解析为十进制的值保存。读取到的值为十进制。 + 但{{nebula.name}}会将写入的非十进制数值解析为十进制的值保存。读取到的值为十进制。 例如，属性`score`的类型为`INT`，通过 INSERT 语句为其赋值`0xb`，使用 FETCH 等语句查询该属性值获取到的结果是`11`，即将十六进制的`0xb`转换为十进制后的值。 diff --git a/docs-2.0/3.ngql-guide/3.data-types/2.boolean.md b/docs-2.0/3.ngql-guide/3.data-types/2.boolean.md index c166df7e043..2824f4b8849 100644 --- a/docs-2.0/3.ngql-guide/3.data-types/2.boolean.md +++ b/docs-2.0/3.ngql-guide/3.data-types/2.boolean.md @@ -1,6 +1,6 @@ # 布尔 -NebulaGraph 使用关键字`BOOL`声明布尔数据类型，可选值为`true`或`false`。 +{{nebula.name}}使用关键字`BOOL`声明布尔数据类型，可选值为`true`或`false`。 nGQL 支持以如下方式使用布尔值： diff --git a/docs-2.0/3.ngql-guide/3.data-types/3.string.md b/docs-2.0/3.ngql-guide/3.data-types/3.string.md index 24b18d85555..387194f2dc2 100644 --- a/docs-2.0/3.ngql-guide/3.data-types/3.string.md +++ b/docs-2.0/3.ngql-guide/3.data-types/3.string.md @@ -1,6 +1,6 @@ # 字符串 -NebulaGraph 支持定长字符串和变长字符串。 +{{nebula.name}}支持定长字符串和变长字符串。 ## 声明与表示方式 @@ -35,8 +35,8 @@ nGQL 支持以如下方式使用字符串： 如果尝试写入的定长字符串超出长度限制： -- 当该定长字符串为属性值时，写入会成功，NebulaGraph 将截断字符串，仅存入符合长度限制的部分。 -- 当该定长字符串为 VID 时，写入会失败，NebulaGraph 将报错。 +- 当该定长字符串为属性值时，写入会成功，{{nebula.name}}将截断字符串，仅存入符合长度限制的部分。 +- 当该定长字符串为 VID 时，写入会失败，{{nebula.name}}将报错。 ## 转义字符 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 3f3aff60fa9..2156b7e3499 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 @@ -4,7 +4,7 @@ ## 注意事项 -- 在插入时间类型的属性值时，NebulaGraph 会根据[配置文件](../../5.configurations-and-logs/1.configurations/1.configurations.md)中`timezone_name`参数指定的时区，将该`DATE`、`TIME`、`DATETIME`转换成相应的世界协调时间（UTC）时间。 +- 在插入时间类型的属性值时，{{nebula.name}}会根据[配置文件](../../5.configurations-and-logs/1.configurations/1.configurations.md)中`timezone_name`参数指定的时区，将该`DATE`、`TIME`、`DATETIME`转换成相应的世界协调时间（UTC）时间。 !!! Note @@ -33,7 +33,7 @@ ## DATE -`DATE`包含日期，但是不包含时间。NebulaGraph 检索和显示`DATE`的格式为`YYYY-MM-DD`。支持的范围是`-32768-01-01`到`32767-12-31`。 +`DATE`包含日期，但是不包含时间。{{nebula.name}}检索和显示`DATE`的格式为`YYYY-MM-DD`。支持的范围是`-32768-01-01`到`32767-12-31`。 `date()`支持的属性名称包括`year`、`month`和`day`。`date()`支持输入`YYYY`、`YYYY-MM`或`YYYY-MM-DD`，未输入的月份或日期默认为`01`。 @@ -54,13 +54,13 @@ nebula> RETURN DATE("23333"); ## TIME -`TIME`包含时间，但是不包含日期。NebulaGraph 检索和显示`TIME`的格式为`hh:mm:ss.msmsmsususus`。支持的范围是`00:00:00.000000`到`23:59:59.999999`。 +`TIME`包含时间，但是不包含日期。{{nebula.name}}检索和显示`TIME`的格式为`hh:mm:ss.msmsmsususus`。支持的范围是`00:00:00.000000`到`23:59:59.999999`。 `time()`支持的属性名称包括`hour`、`minute`和`second`。 ## DATETIME -`DATETIME`包含日期和时间。NebulaGraph 检索和显示`DATETIME`的格式为`YYYY-MM-DDThh:mm:ss.msmsmsususus`。支持的范围是`-32768-01-01T00:00:00.000000`到`32767-12-31T23:59:59.999999`。 +`DATETIME`包含日期和时间。{{nebula.name}}检索和显示`DATETIME`的格式为`YYYY-MM-DDThh:mm:ss.msmsmsususus`。支持的范围是`-32768-01-01T00:00:00.000000`到`32767-12-31T23:59:59.999999`。 - `datetime()`支持的属性名称包括`year`、`month`、`day`、`hour`、`minute`和`second`。 diff --git a/docs-2.0/3.ngql-guide/3.data-types/5.null.md b/docs-2.0/3.ngql-guide/3.data-types/5.null.md index 3f808d7bd9c..ef4a8cf83ad 100644 --- a/docs-2.0/3.ngql-guide/3.data-types/5.null.md +++ b/docs-2.0/3.ngql-guide/3.data-types/5.null.md @@ -20,15 +20,15 @@ ## OpenCypher 兼容性 -NebulaGraph 中，NULL 的比较和操作与 openCypher 不同，后续也可能会有变化。 +{{nebula.name}}中，NULL 的比较和操作与 openCypher 不同，后续也可能会有变化。 ### NULL 的比较 -NebulaGraph 中，NULL 的比较操作不兼容 openCypher。 +{{nebula.name}}中，NULL 的比较操作不兼容 openCypher。 ### NULL 的操作和返回 -NebulaGraph 中，对 NULL 的操作以及返回结果不兼容 openCypher。 +{{nebula.name}}中，对 NULL 的操作以及返回结果不兼容 openCypher。 ## 示例 diff --git a/docs-2.0/3.ngql-guide/3.data-types/9.type-conversion.md b/docs-2.0/3.ngql-guide/3.data-types/9.type-conversion.md index e0e4bfc837b..51c5da1063c 100644 --- a/docs-2.0/3.ngql-guide/3.data-types/9.type-conversion.md +++ b/docs-2.0/3.ngql-guide/3.data-types/9.type-conversion.md @@ -2,7 +2,7 @@ 类型转换是指将表达式的类型转换为另一个类型。 -NebulaGraph 支持显式地转换类型。详情参见[类型转换函数](../6.functions-and-expressions/16.type-conversion.md)。 +{{nebula.name}}支持显式地转换类型。详情参见[类型转换函数](../6.functions-and-expressions/16.type-conversion.md)。 ## 示例 From 222e1b34dd68844f93c64d0e2b19507eca8ad44a Mon Sep 17 00:00:00 2001 From: cooper-lzy <78672629+cooper-lzy@users.noreply.github.com> Date: Tue, 11 Apr 2023 10:25:11 +0800 Subject: [PATCH 123/137] update --- .github/workflows/deploy.yaml | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/.github/workflows/deploy.yaml b/.github/workflows/deploy.yaml index 568c8da62a7..cc5c4b1df70 100644 --- a/.github/workflows/deploy.yaml +++ b/.github/workflows/deploy.yaml @@ -2,7 +2,7 @@ name: Publish docs via GitHub Pages on: push: branches: - - v3.4.1 + - master jobs: deploy: @@ -27,8 +27,7 @@ jobs: - name: mike run: | git fetch origin gh-pages --depth=1 # fix mike's CI update - mike deploy 3.4.1 -p --rebase - mike set-default 3.4.1 -p --rebase + mike deploy master -p --rebase mike list - name: show git branch @@ -38,7 +37,7 @@ jobs: git checkout gh-pages - name: Compress run: | - tar -vczf nebula-docs.tar.gz 3.4.1 versions.json *.html + tar -vczf nebula-docs.tar.gz master versions.json *.html - name: Transfer # uses: garygrossgarten/github-action-scp@release @@ -61,7 +60,7 @@ jobs: mkdir -p /usr/web/nebula-docs/ tar -xzf /usr/web/nebula-docs.tar.gz -C /usr/web/nebula-docs/ mkdir -p /usr/web/nebula-docs/site/pdf/ - cp -f /usr/web/nebula-docs/3.4.1/pdf/NebulaGraph-CN.pdf /usr/web/nebula-docs/site/pdf/NebulaGraph-book.pdf + cp -f /usr/web/nebula-docs/master/pdf/NebulaGraph-CN.pdf /usr/web/nebula-docs/site/pdf/NebulaGraph-book.pdf # pip3 install --upgrade pip # pip3 install -r /usr/web/nebula-docs/requirement.txt From f7caf296988d6fec8d4dec8c756eaaa3ea64f028 Mon Sep 17 00:00:00 2001 From: cooper-lzy <78672629+cooper-lzy@users.noreply.github.com> Date: Tue, 11 Apr 2023 10:38:34 +0800 Subject: [PATCH 124/137] update --- docs-2.0/stylesheets/extra.css | 8 +++---- mkdocs.yml | 8 +++---- scripts/auto_release.py | 42 ++++++++++++++++++++++++++++++++++ 3 files changed, 50 insertions(+), 8 deletions(-) create mode 100644 scripts/auto_release.py diff --git a/docs-2.0/stylesheets/extra.css b/docs-2.0/stylesheets/extra.css index c49ddad8623..8e682a32e8f 100644 --- a/docs-2.0/stylesheets/extra.css +++ b/docs-2.0/stylesheets/extra.css @@ -4,14 +4,14 @@ /* NebulaGraph 黑夜主题色 */ :root{ - --md-primary-fg-color: #FF8BFF; /* 导航栏页面颜色 */ - --md-accent-fg-color: #0FA37F; /* 选中/悬浮链接的颜色 */ + --md-primary-fg-color: #FF0000; /* 导航栏页面颜色 */ + --md-accent-fg-color: #49BDF0; /* 选中/悬浮链接的颜色 */ } /* NebulaGraph 白天主题色 */ [data-md-color-scheme="nebula"]{ - --md-primary-fg-color: #F3A68C; /* 导航栏页面颜色 */ - --md-accent-fg-color: #FF8BFF; /* 选中/悬浮链接的颜色 */ + --md-primary-fg-color: #F7A7A0; /* 导航栏页面颜色 */ + --md-accent-fg-color: #7DBB7C; /* 选中/悬浮链接的颜色 */ --md-typeset-a-color: #0FA37F!important; /* 白天的链接颜色 */ --md-code-fg-color: rgb(12, 21, 26); /* 代码段字体色 */ --md-code-bg-color: #eaebec;/* 代码段背景色 */ diff --git a/mkdocs.yml b/mkdocs.yml index d3eee19e363..39b0a74258e 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -8,7 +8,7 @@ docs_dir: docs-2.0 copyright: Copyright © 2023 NebulaGraph - 浙ICP备20010487号 # modify when release: -edit_uri: 'https://github.com/vesoft-inc/nebula-docs-cn/edit/v3.4.1/docs-2.0/' +edit_uri: 'https://github.com/vesoft-inc/nebula-docs-cn/edit/master/docs-2.0/' # Configuration theme: @@ -64,7 +64,7 @@ markdown_extensions: # Plugins plugins: -# - search # 这个是原有的 mkdocs 搜索插件， 如果想使用algolia搜索，请注释掉这个插件 + - search # 这个是原有的 mkdocs 搜索插件， 如果想使用algolia搜索，请注释掉这个插件 - macros: include_dir: docs-2.0/reuse/ - git-revision-date-localized @@ -124,8 +124,8 @@ plugins: # modify when release: - with-pdf: copyright: 2023 vesoft Inc. - cover_subtitle: v3.4.1 - author: 吴敏，周瑶，梁振亚，杨怡璇，黄凤仙 + cover_subtitle: master + author: 吴敏，周瑶，梁振亚，黄凤仙 cover: true back_cover: true cover_logo: 'https://cloud-cdn.nebula-graph.com.cn/nebula-for-pdf.png' diff --git a/scripts/auto_release.py b/scripts/auto_release.py new file mode 100644 index 00000000000..6ef2ffc4ad2 --- /dev/null +++ b/scripts/auto_release.py @@ -0,0 +1,42 @@ +import re + +def replace_line(file_path, search_text, new_line): + with open(file_path, 'r', encoding='utf-8') as f: + file_content = f.read() + new_content = re.sub(search_text, new_line, file_content) + + with open(file_path, 'w', encoding='utf-8') as f: + f.write(new_content) + +def update_github_actions(doc_version): + if doc_version == 'master': + replace_line('.github/workflows/deploy.yaml', r'branches:\s+-.*', f'branches:\n - {doc_version}') + replace_line('.github/workflows/deploy.yaml', r'mike deploy .* -p --rebase\n mike set-default .* -p --rebase', f'mike deploy {doc_version} -p --rebase') + replace_line('.github/workflows/deploy.yaml', r'tar -vczf nebula-docs.tar.gz.*', f'tar -vczf nebula-docs.tar.gz {doc_version} versions.json *.html') + replace_line('.github/workflows/deploy.yaml', r'cp -f /usr/web/nebula-docs/.*/pdf/NebulaGraph-CN.pdf', f'cp -f /usr/web/nebula-docs/{doc_version}/pdf/NebulaGraph-CN.pdf') + else: + replace_line('.github/workflows/deploy.yaml', r'branches:\s+-.*', f'branches:\n - v{doc_version}') + replace_line('.github/workflows/deploy.yaml', r'mike deploy .* -p --rebase', f'mike deploy {doc_version} -p --rebase\n mike set-default {doc_version} -p --rebase') + replace_line('.github/workflows/deploy.yaml', r'tar -vczf nebula-docs.tar.gz.*', f'tar -vczf nebula-docs.tar.gz {doc_version} versions.json *.html') + replace_line('.github/workflows/deploy.yaml', r'cp -f /usr/web/nebula-docs/.*/pdf/NebulaGraph-CN.pdf', f'cp -f /usr/web/nebula-docs/{doc_version}/pdf/NebulaGraph-CN.pdf') + +def update_mkdocs_yml(doc_version): + if doc_version == 'master': + replace_line('./mkdocs.yml', r'cover_subtitle:.*', f'cover_subtitle: {doc_version}') + replace_line('./mkdocs.yml', r'https://github.com/vesoft-inc/nebula-docs-cn/edit/.*/docs-2.0/', f'https://github.com/vesoft-inc/nebula-docs-cn/edit/{doc_version}/docs-2.0/') + else: + replace_line('./mkdocs.yml', r'cover_subtitle:.*', f'cover_subtitle: v{doc_version}') + replace_line('./mkdocs.yml', r'https://github.com/vesoft-inc/nebula-docs-cn/edit/.*/docs-2.0/', f'https://github.com/vesoft-inc/nebula-docs-cn/edit/v{doc_version}/docs-2.0/') + +if __name__ == "__main__": + with open('./mkdocs.yml', 'r', encoding='utf-8') as f: + file_content = f.read() + doc_version_match = re.search(r'doc_version:.*', file_content) + if doc_version_match: + doc_version = doc_version_match.group().split(':')[1].strip() + if not isinstance(doc_version, str): + raise TypeError("The value of doc_version should be a string") + else: + raise Exception("The value of doc_version is not found in mkdocs.yml") + update_github_actions(doc_version) + update_mkdocs_yml(doc_version) \ No newline at end of file From eae9c5cb87307232b44b0deae5f6a01fea6e3665 Mon Sep 17 00:00:00 2001 From: cooper-lzy <78672629+cooper-lzy@users.noreply.github.com> Date: Tue, 11 Apr 2023 11:40:56 +0800 Subject: [PATCH 125/137] update --- README.md | 2 +- .../3.ngql-guide/3.data-types/10.geography.md | 2 +- .../1.composite-queries.md | 2 +- .../2.user-defined-variables.md | 2 +- .../3.property-reference.md | 4 +-- .../3.ngql-guide/5.operators/1.comparison.md | 2 +- .../3.ngql-guide/5.operators/2.boolean.md | 2 +- docs-2.0/3.ngql-guide/5.operators/4.pipe.md | 2 +- docs-2.0/3.ngql-guide/5.operators/6.set.md | 2 +- docs-2.0/3.ngql-guide/5.operators/7.string.md | 4 +-- docs-2.0/3.ngql-guide/5.operators/8.list.md | 2 +- .../6.functions-and-expressions/1.math.md | 2 +- .../15.aggregating.md | 2 +- .../16.type-conversion.md | 2 +- .../6.functions-and-expressions/2.string.md | 2 +- .../3.date-and-time.md | 2 +- .../6.functions-and-expressions/4.schema.md | 2 +- .../5.conditional-expressions.md | 2 +- .../6.functions-and-expressions/6.list.md | 2 +- .../8.predicate.md | 2 +- .../9.user-defined-functions.md | 2 +- .../7.general-query-statements/2.match.md | 12 ++++---- .../7.general-query-statements/3.go.md | 2 +- .../6.show/1.show-charset.md | 2 +- .../6.show/17.show-sessions.md | 2 +- .../6.show/6.show-hosts.md | 2 +- .../6.show/8.show-indexes.md | 2 +- .../8.clauses-and-options/limit.md | 2 +- .../8.clauses-and-options/ttl-options.md | 2 +- .../9.space-statements/1.create-space.md | 8 ++--- .../9.space-statements/2.use-space.md | 2 +- .../9.space-statements/3.show-spaces.md | 2 +- .../9.space-statements/5.drop-space.md | 4 +-- .../9.space-statements/6.clear-space.md | 6 ++-- .../1.resource-preparations.md | 28 ++++++++--------- ...bula-graph-by-compiling-the-source-code.md | 30 +++++++++---------- .../2.install-nebula-graph-by-rpm-or-deb.md | 2 +- ...deploy-nebula-graph-with-docker-compose.md | 28 ++++++++--------- .../4.uninstall-nebula-graph.md | 28 ++++++++--------- .../4.deployment-and-installation/5.zone.md | 2 +- .../connect-to-nebula-graph.md | 2 +- .../deploy-license.md | 30 +++++++++---------- .../manage-service.md | 2 +- .../manage-storage-host.md | 2 +- .../standalone-deployment.md | 20 ++++++------- 45 files changed, 135 insertions(+), 133 deletions(-) diff --git a/README.md b/README.md index b1f220f39d1..82b3f366a4f 100644 --- a/README.md +++ b/README.md @@ -14,4 +14,4 @@ ## 贡献文档 -如果发现文档问题，请随时创建一个 [Issue](https://github.com/vesoft-inc/nebula-docs-cn/issues) 告知我们或直接创建一个 [PR](https://github.com/vesoft-inc/nebula-docs-cn/pulls) 修复或更新。请参阅 NebulaGraph [中文文档贡献指南](CONTRIBUTING.md)开始贡献。 +如果发现文档问题，请随时创建一个 [Issue](https://github.com/vesoft-inc/nebula-docs-cn/issues) 告知我们或直接创建一个 [PR](https://github.com/vesoft-inc/nebula-docs-cn/pulls) 修复或更新。请参阅{{nebula.name}} [中文文档贡献指南](CONTRIBUTING.md)开始贡献。 diff --git a/docs-2.0/3.ngql-guide/3.data-types/10.geography.md b/docs-2.0/3.ngql-guide/3.data-types/10.geography.md index 17235d89fac..c22cbfb6731 100644 --- a/docs-2.0/3.ngql-guide/3.data-types/10.geography.md +++ b/docs-2.0/3.ngql-guide/3.data-types/10.geography.md @@ -1,6 +1,6 @@ # 地理位置 -地理位置（GEOGRAPHY）是由经纬度构成的表示地理空间信息的数据类型。NebulaGraph 当前支持[简单地理要素](https://en.wikipedia.org/wiki/Simple_Features)中的 Point、LineString 和 Polygon 三种地理形状。支持 [SQL-MM 3](https://www.techrepublic.com/index.php/resource-library/whitepapers/sql-mm-spatial-the-standard-to-manage-spatial-data-in-relational-database-systems/) 中的部分核心 geo 解析、构造、格式设置、转换、谓词和度量等函数。 +地理位置（GEOGRAPHY）是由经纬度构成的表示地理空间信息的数据类型。{{nebula.name}}当前支持[简单地理要素](https://en.wikipedia.org/wiki/Simple_Features)中的 Point、LineString 和 Polygon 三种地理形状。支持 [SQL-MM 3](https://www.techrepublic.com/index.php/resource-library/whitepapers/sql-mm-spatial-the-standard-to-manage-spatial-data-in-relational-database-systems/) 中的部分核心 geo 解析、构造、格式设置、转换、谓词和度量等函数。 ## GEOGRAPHY diff --git a/docs-2.0/3.ngql-guide/4.variable-and-composite-queries/1.composite-queries.md b/docs-2.0/3.ngql-guide/4.variable-and-composite-queries/1.composite-queries.md index f0c4fe0e8a5..ec681d6a10d 100644 --- a/docs-2.0/3.ngql-guide/4.variable-and-composite-queries/1.composite-queries.md +++ b/docs-2.0/3.ngql-guide/4.variable-and-composite-queries/1.composite-queries.md @@ -2,7 +2,7 @@ 复合查询将来自不同请求的数据放在一起，然后进行过滤、分组或者排序等，最后返回结果。 -NebulaGraph 支持三种方式进行复合查询（或子查询）： +{{nebula.name}}支持三种方式进行复合查询（或子查询）： - （opencypher 兼容语句）连接各个子句，让它们在彼此之间提供中间结果集。 diff --git a/docs-2.0/3.ngql-guide/4.variable-and-composite-queries/2.user-defined-variables.md b/docs-2.0/3.ngql-guide/4.variable-and-composite-queries/2.user-defined-variables.md index c56b4ec360b..216ba17cf1c 100644 --- a/docs-2.0/3.ngql-guide/4.variable-and-composite-queries/2.user-defined-variables.md +++ b/docs-2.0/3.ngql-guide/4.variable-and-composite-queries/2.user-defined-variables.md @@ -1,6 +1,6 @@ # 自定义变量 -NebulaGraph 允许将一条语句的结果作为自定义变量传递给另一条语句。 +{{nebula.name}}允许将一条语句的结果作为自定义变量传递给另一条语句。 ## OpenCypher 兼容性 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 8ba2acbf036..357dbfd54ee 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 @@ -88,7 +88,7 @@ nebula> GO FROM "player100" OVER follow YIELD follow._src, follow._dst, follow._ !!! compatibility "历史版本兼容性" - 从 NebulaGraph 2.6.0 起支持了新的 [Schema 相关函数](../6.functions-and-expressions/4.schema.md)。以上示例在 NebulaGraph {{ nebula.release}} 中的近似写法如下： + 从{{nebula.name}} 2.6.0 起支持了新的 [Schema 相关函数](../6.functions-and-expressions/4.schema.md)。以上示例在{{nebula.name}} {{ nebula.release}} 中的近似写法如下： ```ngql GO FROM "player100" OVER follow YIELD properties($^).name AS startName, properties($$).age AS endAge; @@ -96,4 +96,4 @@ nebula> GO FROM "player100" OVER follow YIELD follow._src, follow._dst, follow._ GO FROM "player100" OVER follow YIELD src(edge), dst(edge), type(edge), rank(edge); ``` - NebulaGraph {{ nebula.release}} 兼容新旧语法。 + {{nebula.name}} {{ nebula.release}} 兼容新旧语法。 diff --git a/docs-2.0/3.ngql-guide/5.operators/1.comparison.md b/docs-2.0/3.ngql-guide/5.operators/1.comparison.md index a1c2a87bdf7..5c17025c5a9 100644 --- a/docs-2.0/3.ngql-guide/5.operators/1.comparison.md +++ b/docs-2.0/3.ngql-guide/5.operators/1.comparison.md @@ -1,6 +1,6 @@ # 比较符 -NebulaGraph 支持的比较符如下。 +{{nebula.name}}支持的比较符如下。 | 符号 | 说明 | |:----|:----:| diff --git a/docs-2.0/3.ngql-guide/5.operators/2.boolean.md b/docs-2.0/3.ngql-guide/5.operators/2.boolean.md index 30233161316..2b92d2ccfc0 100644 --- a/docs-2.0/3.ngql-guide/5.operators/2.boolean.md +++ b/docs-2.0/3.ngql-guide/5.operators/2.boolean.md @@ -1,6 +1,6 @@ # 布尔符 -NebulaGraph 支持的布尔符如下。 +{{nebula.name}}支持的布尔符如下。 | 符号 | 说明 | | :------- | :-------------: | diff --git a/docs-2.0/3.ngql-guide/5.operators/4.pipe.md b/docs-2.0/3.ngql-guide/5.operators/4.pipe.md index a7f36628911..29bfc7617e8 100644 --- a/docs-2.0/3.ngql-guide/5.operators/4.pipe.md +++ b/docs-2.0/3.ngql-guide/5.operators/4.pipe.md @@ -35,7 +35,7 @@ nebula> GO FROM "player100" OVER follow \ ## 性能提示 -NebulaGraph 中的管道对性能有影响，以`A | B`为例，体现在以下几个方面： +{{nebula.name}}中的管道对性能有影响，以`A | B`为例，体现在以下几个方面： 1. 管道是同步操作。也即需要管道之前的子句`A`执行完毕后，数据才能整体进入管道子句。 diff --git a/docs-2.0/3.ngql-guide/5.operators/6.set.md b/docs-2.0/3.ngql-guide/5.operators/6.set.md index 6c83007d7a7..c7662b97906 100644 --- a/docs-2.0/3.ngql-guide/5.operators/6.set.md +++ b/docs-2.0/3.ngql-guide/5.operators/6.set.md @@ -2,7 +2,7 @@ 合并多个请求时，可以使用集合运算符，包括`UNION`、`UNION ALL`、`INTERSECT`和`MINUS`。 -所有集合运算符的优先级相同，如果一个 nGQL 语句中有多个集合运算符，NebulaGraph 会从左到右进行计算，除非用括号指定顺序。 +所有集合运算符的优先级相同，如果一个 nGQL 语句中有多个集合运算符，{{nebula.name}}会从左到右进行计算，除非用括号指定顺序。 !!! caution diff --git a/docs-2.0/3.ngql-guide/5.operators/7.string.md b/docs-2.0/3.ngql-guide/5.operators/7.string.md index d413f1f05d6..ba82144a188 100644 --- a/docs-2.0/3.ngql-guide/5.operators/7.string.md +++ b/docs-2.0/3.ngql-guide/5.operators/7.string.md @@ -1,6 +1,6 @@ # 字符串运算符 -NebulaGraph 支持使用字符串运算符进行连接、搜索、匹配运算。支持的运算符如下。 +{{nebula.name}}支持使用字符串运算符进行连接、搜索、匹配运算。支持的运算符如下。 | 名称 | 说明 | |:----- | :------------------ | @@ -111,7 +111,7 @@ nebula> RETURN 'apple' ENDS WITH 'app', 'apple' ENDS WITH 'e', 'apple' ENDS WITH 当前仅 opencypher 兼容语句（`MATCH`、`WITH`等）支持正则表达式，原生 nGQL 语句（`FETCH`、`GO`、`LOOKUP`等）不支持正则表达式。 -NebulaGraph 支持使用正则表达式进行过滤，正则表达式的语法是继承自`std::regex`，用户可以使用语法`=~ ''`进行正则表达式匹配。例如： +{{nebula.name}}支持使用正则表达式进行过滤，正则表达式的语法是继承自`std::regex`，用户可以使用语法`=~ ''`进行正则表达式匹配。例如： ```ngql nebula> RETURN "384748.39" =~ "\\d+(\\.\\d{2})?"; diff --git a/docs-2.0/3.ngql-guide/5.operators/8.list.md b/docs-2.0/3.ngql-guide/5.operators/8.list.md index 257ad25f95f..217c5023cd2 100644 --- a/docs-2.0/3.ngql-guide/5.operators/8.list.md +++ b/docs-2.0/3.ngql-guide/5.operators/8.list.md @@ -1,6 +1,6 @@ # 列表运算符 -NebulaGraph 支持使用列表（List）运算符进行运算。支持的运算符如下。 +{{nebula.name}}支持使用列表（List）运算符进行运算。支持的运算符如下。 | 名称 | 说明 | |:----- |:------------------| 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 9cbbaaf1d44..ff70ebe63b3 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 @@ -1,6 +1,6 @@ # 内置数学函数 -本文介绍 NebulaGraph 支持的数学函数。 +本文介绍{{nebula.name}}支持的数学函数。 ## abs() diff --git a/docs-2.0/3.ngql-guide/6.functions-and-expressions/15.aggregating.md b/docs-2.0/3.ngql-guide/6.functions-and-expressions/15.aggregating.md index ff86d1cb4d7..f94db19ee87 100644 --- a/docs-2.0/3.ngql-guide/6.functions-and-expressions/15.aggregating.md +++ b/docs-2.0/3.ngql-guide/6.functions-and-expressions/15.aggregating.md @@ -1,6 +1,6 @@ # 聚合函数 -本文介绍 NebulaGraph 支持的聚合函数。 +本文介绍{{nebula.name}}支持的聚合函数。 ## avg() diff --git a/docs-2.0/3.ngql-guide/6.functions-and-expressions/16.type-conversion.md b/docs-2.0/3.ngql-guide/6.functions-and-expressions/16.type-conversion.md index 1a4e2433fe9..78851047d43 100644 --- a/docs-2.0/3.ngql-guide/6.functions-and-expressions/16.type-conversion.md +++ b/docs-2.0/3.ngql-guide/6.functions-and-expressions/16.type-conversion.md @@ -1,6 +1,6 @@ # 类型转换函数 -本文介绍 NebulaGraph 支持的类型转换函数。 +本文介绍{{nebula.name}}支持的类型转换函数。 ## toBoolean() 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 bda86ca0916..55e0378ca1b 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 @@ -1,6 +1,6 @@ # 内置字符串函数 -本文介绍 NebulaGraph 支持的字符串函数。 +本文介绍{{nebula.name}}支持的字符串函数。 ## 注意事项 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 0fafe547e94..e9f05d55ced 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 @@ -1,6 +1,6 @@ # 内置日期时间函数 -NebulaGraph 支持以下内置日期时间函数。 +{{nebula.name}}支持以下内置日期时间函数。 |函数| 说明 | |:---- | :----| 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 831bf971b6a..4da445b0e0d 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 相关函数 -本文介绍 NebulaGraph 支持的 [Schema](../../1.introduction/2.data-model.md) 相关的函数。 +本文介绍{{nebula.name}}支持的 [Schema](../../1.introduction/2.data-model.md) 相关的函数。 Schema 相关的函数分为两类： diff --git a/docs-2.0/3.ngql-guide/6.functions-and-expressions/5.conditional-expressions.md b/docs-2.0/3.ngql-guide/6.functions-and-expressions/5.conditional-expressions.md index 8094c902e81..7ec83a88dbe 100644 --- a/docs-2.0/3.ngql-guide/6.functions-and-expressions/5.conditional-expressions.md +++ b/docs-2.0/3.ngql-guide/6.functions-and-expressions/5.conditional-expressions.md @@ -1,6 +1,6 @@ # 条件表达式函数 -本文介绍 NebulaGraph 支持的条件表达式函数。 +本文介绍{{nebula.name}}支持的条件表达式函数。 ## CASE diff --git a/docs-2.0/3.ngql-guide/6.functions-and-expressions/6.list.md b/docs-2.0/3.ngql-guide/6.functions-and-expressions/6.list.md index 454a82716c9..4e2d746aa25 100644 --- a/docs-2.0/3.ngql-guide/6.functions-and-expressions/6.list.md +++ b/docs-2.0/3.ngql-guide/6.functions-and-expressions/6.list.md @@ -1,6 +1,6 @@ # 列表函数 -本文介绍 NebulaGraph 支持的列表（List）函数。部分列表函数在原生 nGQL 语句和 openCypher 兼容语句中的语法不同。 +本文介绍{{nebula.name}}支持的列表（List）函数。部分列表函数在原生 nGQL 语句和 openCypher 兼容语句中的语法不同。 ## 注意事项 diff --git a/docs-2.0/3.ngql-guide/6.functions-and-expressions/8.predicate.md b/docs-2.0/3.ngql-guide/6.functions-and-expressions/8.predicate.md index 2326bc38812..eac7764f8ca 100644 --- a/docs-2.0/3.ngql-guide/6.functions-and-expressions/8.predicate.md +++ b/docs-2.0/3.ngql-guide/6.functions-and-expressions/8.predicate.md @@ -2,7 +2,7 @@ 谓词函数只返回`true`或`false`，通常用于`WHERE`子句中。 -NebulaGraph 支持以下谓词函数。 +{{nebula.name}}支持以下谓词函数。 | 函数 | 说明 | |:----- |:-------- | diff --git a/docs-2.0/3.ngql-guide/6.functions-and-expressions/9.user-defined-functions.md b/docs-2.0/3.ngql-guide/6.functions-and-expressions/9.user-defined-functions.md index 449257fcc8f..35ebbb087d0 100644 --- a/docs-2.0/3.ngql-guide/6.functions-and-expressions/9.user-defined-functions.md +++ b/docs-2.0/3.ngql-guide/6.functions-and-expressions/9.user-defined-functions.md @@ -2,4 +2,4 @@ ## openCypher 兼容性 -NebulaGraph {{ nebula.release }} 不支持自定义函数（UDF）和存储过程。 +{{nebula.name}} {{ nebula.release }} 不支持自定义函数（UDF）和存储过程。 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 36c43368afd..b4977093d6b 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 @@ -2,7 +2,7 @@ `MATCH`语句提供基于模式（pattern）匹配的搜索功能。 -一个`MATCH`语句定义了一个搜索模式，用该模式匹配存储在 NebulaGraph 中的数据，然后用`RETURN`子句检索数据。 +一个`MATCH`语句定义了一个搜索模式，用该模式匹配存储在{{nebula.name}}中的数据，然后用`RETURN`子句检索数据。 本文示例使用测试数据集 [basketballplayer](../1.nGQL-overview/1.overview.md#basketballplayer) 进行演示。 @@ -99,7 +99,7 @@ nebula> SHOW JOB 122; !!! Compatibility "历史版本兼容性" - 从 NebulaGraph 3.0.0 开始，支持`MATCH (v) RETURN v LIMIT n`，不需要创建索引; 但是必须使用 `LIMIT` 限制输出结果数量。 + 从{{nebula.name}} 3.0.0 开始，支持`MATCH (v) RETURN v LIMIT n`，不需要创建索引; 但是必须使用 `LIMIT` 限制输出结果数量。 不可以直接执行 `MATCH (v) RETURN v`。 @@ -122,7 +122,7 @@ nebula> MATCH (v) \ !!! Compatibility "历史版本兼容性" - 在 NebulaGraph 3.0.0 之前，匹配 Tag 的前提是 Tag 本身有索引或者 Tag 的某个属性有索引，否则，用户无法基于该 Tag 执行 `MATCH` 语句。从 NebulaGraph 3.0.0 开始，匹配 Tag 可以不创建索引，但需要使用 `LIMIT` 限制输出结果数量。 + 在{{nebula.name}} 3.0.0 之前，匹配 Tag 的前提是 Tag 本身有索引或者 Tag 的某个属性有索引，否则，用户无法基于该 Tag 执行 `MATCH` 语句。从{{nebula.name}} 3.0.0 开始，匹配 Tag 可以不创建索引，但需要使用 `LIMIT` 限制输出结果数量。 用户可以在点的右侧用`:`表示模式中的 Tag。 @@ -352,7 +352,7 @@ nebula> MATCH p=(v:player{name:"Tim Duncan"})-->(v2) \ !!! Compatibility "历史版本兼容性" - 在 NebulaGraph 3.0.0 之前，匹配边的前提是边本身有对应属性的索引，否则，用户无法基于边执行 `MATCH` 语句。从 NebulaGraph 3.0.0 开始，匹配边可以不创建索引，但需要使用 `LIMIT` 限制输出结果数量，并且必须指定边的方向。 + 在{{nebula.name}} 3.0.0 之前，匹配边的前提是边本身有对应属性的索引，否则，用户无法基于边执行 `MATCH` 语句。从{{nebula.name}} 3.0.0 开始，匹配边可以不创建索引，但需要使用 `LIMIT` 限制输出结果数量，并且必须指定边的方向。 ```ngql nebula> MATCH ()<-[e]-() \ @@ -373,7 +373,7 @@ nebula> MATCH ()<-[e]-() \ !!! Compatibility "历史版本兼容性" - 在 NebulaGraph 3.0.0 之前，匹配 Edge Type 的前提是 Edge type 本身有对应属性的索引，否则，用户无法基于 Edge Type 执行 `MATCH` 语句。从 NebulaGraph 3.0.0 开始，匹配 Edge Type 可以不创建索引，但需要使用 `LIMIT` 限制输出结果数量，并且必须指定边的方向。 + 在{{nebula.name}} 3.0.0 之前，匹配 Edge Type 的前提是 Edge type 本身有对应属性的索引，否则，用户无法基于 Edge Type 执行 `MATCH` 语句。从{{nebula.name}} 3.0.0 开始，匹配 Edge Type 可以不创建索引，但需要使用 `LIMIT` 限制输出结果数量，并且必须指定边的方向。 ```ngql nebula> MATCH ()-[e:follow]->() \ @@ -672,4 +672,4 @@ nebula> MATCH (m)-[]->(n) WHERE id(m)=="player100" \ !!! Performance - NebulaGraph {{ nebula.release }} 中`MATCH`语句的性能和资源占用得到了优化.但对性能要求较高时，仍建议使用 `GO`, `LOOKUP`, `|` 和 `FETCH` 等来替代`MATCH`。 + {{nebula.name}} {{ nebula.release }} 中`MATCH`语句的性能和资源占用得到了优化.但对性能要求较高时，仍建议使用 `GO`, `LOOKUP`, `|` 和 `FETCH` 等来替代`MATCH`。 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 bd07d2308c5..98523e2ac68 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 @@ -29,7 +29,7 @@ YIELD [DISTINCT] [AS ] [, [AS ] ...] ``` -- ` {STEP|STEPS}`：指定跳数。如果没有指定跳数，默认值`N`为`1`。如果`N`为`0`，NebulaGraph 不会检索任何边。 +- ` {STEP|STEPS}`：指定跳数。如果没有指定跳数，默认值`N`为`1`。如果`N`为`0`，{{nebula.name}} 不会检索任何边。 - `M TO N {STEP|STEPS}`：遍历`M~N`跳的边。如果`M`为`0`，输出结果和`M`为`1`相同，即`GO 0 TO 2`和`GO 1 TO 2`是相同的。 diff --git a/docs-2.0/3.ngql-guide/7.general-query-statements/6.show/1.show-charset.md b/docs-2.0/3.ngql-guide/7.general-query-statements/6.show/1.show-charset.md index 7bc41d99e19..d43270ec9eb 100644 --- a/docs-2.0/3.ngql-guide/7.general-query-statements/6.show/1.show-charset.md +++ b/docs-2.0/3.ngql-guide/7.general-query-statements/6.show/1.show-charset.md @@ -2,7 +2,7 @@ `SHOW CHARSET`语句显示当前的字符集。 -目前可用的字符集为`utf8`和`utf8mb4`。默认字符集为`utf8`。NebulaGraph 扩展`uft8`支持四字节字符，因此`utf8`和`utf8mb4`是等价的。 +目前可用的字符集为`utf8`和`utf8mb4`。默认字符集为`utf8`。{{nebula.name}} 扩展`uft8`支持四字节字符，因此`utf8`和`utf8mb4`是等价的。 ## 语法 diff --git a/docs-2.0/3.ngql-guide/7.general-query-statements/6.show/17.show-sessions.md b/docs-2.0/3.ngql-guide/7.general-query-statements/6.show/17.show-sessions.md index 0e5ea3c92de..2273efa5a08 100644 --- a/docs-2.0/3.ngql-guide/7.general-query-statements/6.show/17.show-sessions.md +++ b/docs-2.0/3.ngql-guide/7.general-query-statements/6.show/17.show-sessions.md @@ -1,6 +1,6 @@ # SHOW SESSIONS -登录 NebulaGraph 数据库时，会创建对应会话，用户可以查询会话信息。 +登录{{nebula.name}}数据库时，会创建对应会话，用户可以查询会话信息。 ## 注意事项 diff --git a/docs-2.0/3.ngql-guide/7.general-query-statements/6.show/6.show-hosts.md b/docs-2.0/3.ngql-guide/7.general-query-statements/6.show/6.show-hosts.md index 5b9bf9f715b..c179414db47 100644 --- a/docs-2.0/3.ngql-guide/7.general-query-statements/6.show/6.show-hosts.md +++ b/docs-2.0/3.ngql-guide/7.general-query-statements/6.show/6.show-hosts.md @@ -10,7 +10,7 @@ SHOW HOSTS [GRAPH | STORAGE | META]; !!! note - 对于使用源码安装的 NebulaGraph，执行添加了服务名的命令后，输出的信息中不显示版本信息。 + 对于使用源码安装的{{nebula.name}}，执行添加了服务名的命令后，输出的信息中不显示版本信息。 ## 示例 diff --git a/docs-2.0/3.ngql-guide/7.general-query-statements/6.show/8.show-indexes.md b/docs-2.0/3.ngql-guide/7.general-query-statements/6.show/8.show-indexes.md index 910cc60cdb6..50ca252837c 100644 --- a/docs-2.0/3.ngql-guide/7.general-query-statements/6.show/8.show-indexes.md +++ b/docs-2.0/3.ngql-guide/7.general-query-statements/6.show/8.show-indexes.md @@ -29,4 +29,4 @@ nebula> SHOW EDGE INDEXES; !!! Compatibility "历史版本兼容性" - NebulaGraph 2.0.1 中， `SHOW TAG/EDGE INDEXES` 语句仅返回 `Names`。 + {{nebula.name}} 2.0.1 中， `SHOW TAG/EDGE INDEXES` 语句仅返回 `Names`。 diff --git a/docs-2.0/3.ngql-guide/8.clauses-and-options/limit.md b/docs-2.0/3.ngql-guide/8.clauses-and-options/limit.md index 571ab8ef3ef..235a6393d47 100644 --- a/docs-2.0/3.ngql-guide/8.clauses-and-options/limit.md +++ b/docs-2.0/3.ngql-guide/8.clauses-and-options/limit.md @@ -179,5 +179,5 @@ nebula> MATCH (v:player{name:"Tim Duncan"}) --> (v2) \ diff --git a/docs-2.0/3.ngql-guide/8.clauses-and-options/ttl-options.md b/docs-2.0/3.ngql-guide/8.clauses-and-options/ttl-options.md index b99a648c4d7..0abc745357c 100644 --- a/docs-2.0/3.ngql-guide/8.clauses-and-options/ttl-options.md +++ b/docs-2.0/3.ngql-guide/8.clauses-and-options/ttl-options.md @@ -49,7 +49,7 @@ nGQL 支持的 TTL 选项如下。 属性过期后，对应的过期数据仍然存储在硬盘上，但是查询时会过滤过期数据。 -NebulaGraph 自动删除过期数据后，会在下一次 [Compaction](../../8.service-tuning/compaction.md) 过程中回收硬盘空间。 +{{nebula.name}}自动删除过期数据后，会在下一次 [Compaction](../../8.service-tuning/compaction.md) 过程中回收硬盘空间。 !!! Note diff --git a/docs-2.0/3.ngql-guide/9.space-statements/1.create-space.md b/docs-2.0/3.ngql-guide/9.space-statements/1.create-space.md index 76e66aac572..49924beb298 100644 --- a/docs-2.0/3.ngql-guide/9.space-statements/1.create-space.md +++ b/docs-2.0/3.ngql-guide/9.space-statements/1.create-space.md @@ -1,6 +1,6 @@ # CREATE SPACE -图空间是 NebulaGraph 中彼此隔离的图数据集合，与 MySQL 中的 database 概念类似。`CREATE SPACE`语句可以创建一个新的图空间，或者克隆现有图空间的 Schema。 +图空间是{{nebula.name}}中彼此隔离的图数据集合，与 MySQL 中的 database 概念类似。`CREATE SPACE`语句可以创建一个新的图空间，或者克隆现有图空间的 Schema。 ## 前提条件 @@ -22,7 +22,7 @@ CREATE SPACE [IF NOT EXISTS] ( |参数|说明| |:---|:---| |`IF NOT EXISTS`|检测待创建的图空间是否存在，只有不存在时，才会创建图空间。仅检测图空间的名称，不会检测具体属性。| -|``|1、在 NebulaGraph 实例中唯一标识一个图空间。
2、图空间名称设置后无法被修改。
3、不能以数字开头；支持 1~4 字节的 UTF-8 编码字符，包括英文字母（区分大小写）、数字、中文等，但是不包括除下划线外的特殊字符；使用特殊字符、保留关键字或数字开头时，需要用反引号（\`）包围且不能使用英文句号（`.`）。详情参见[关键字和保留字](../../3.ngql-guide/1.nGQL-overview/keywords-and-reserved-words.md)。
**注意**：如果以中文为图空间命名，报`SyntaxError`错误时，需使用反引号（\`）包围中文字符。| +|``|1、在{{nebula.name}}实例中唯一标识一个图空间。
2、图空间名称设置后无法被修改。
3、不能以数字开头；支持 1~4 字节的 UTF-8 编码字符，包括英文字母（区分大小写）、数字、中文等，但是不包括除下划线外的特殊字符；使用特殊字符、保留关键字或数字开头时，需要用反引号（\`）包围且不能使用英文句号（`.`）。详情参见[关键字和保留字](../../3.ngql-guide/1.nGQL-overview/keywords-and-reserved-words.md)。
**注意**：如果以中文为图空间命名，报`SyntaxError`错误时，需使用反引号（\`）包围中文字符。| |`partition_num`|指定图空间的分片数量。建议设置为集群中硬盘数量的 20 倍（HDD 硬盘建议为 2 倍）。例如集群中有 3 个硬盘，建议设置 60 个分片。默认值为 100。| |`replica_factor`|指定每个分片的副本数量。建议在生产环境中设置为 3，在测试环境中设置为 1。由于需要基于多数表决，副本数量必须是**奇数**。默认值为 1。| |`vid_type`|必选参数。指定点 ID 的数据类型。可选值为`FIXED_STRING()`和`INT64`。`INT`等同于`INT64`。
`FIXED_STRING()`表示数据类型为定长字符串，长度为`N`字节，超出长度会报错。例如，UTF-8中，一个中文字符的长度为三个字节，如果设置`N`为 12，那么`vid_type`为最多 4 个中文字符。
`INT64`表示数据类型为整数。| @@ -34,11 +34,11 @@ CREATE SPACE [IF NOT EXISTS] ( !!! caution - - 如果将副本数设置为 1，用户将无法使用 [BALANCE](../../8.service-tuning/load-balance.md) 命令为 NebulaGraph 的存储服务平衡负载或扩容。 + - 如果将副本数设置为 1，用户将无法使用 [BALANCE](../../8.service-tuning/load-balance.md) 命令为{{nebula.name}}的存储服务平衡负载或扩容。 - VID 类型变更与长度限制： - - 在 NebulaGraph 1.x 中，VID 的类型只能为`INT64`，不支持字符型；在 NebulaGraph 2.x 中，VID 的类型支持`INT64`和`FIXED_STRING()`。请在创建图空间时指定 VID 类型，使用`INSERT`语句时也需要保持一致，否则会报错 VID 类型不匹配`Wrong vertex id type: 1001`。 + - 在{{nebula.name}} 1.x 中，VID 的类型只能为`INT64`，不支持字符型；在{{nebula.name}} 2.x 中，VID 的类型支持`INT64`和`FIXED_STRING()`。请在创建图空间时指定 VID 类型，使用`INSERT`语句时也需要保持一致，否则会报错 VID 类型不匹配`Wrong vertex id type: 1001`。 - VID 最大长度必须为`N`，不可任意长度；超过该长度也会报错`The VID must be a 64-bit integer or a string fitting space vertex id length limit.`。 diff --git a/docs-2.0/3.ngql-guide/9.space-statements/2.use-space.md b/docs-2.0/3.ngql-guide/9.space-statements/2.use-space.md index 9d2e2be014d..cbdbba56197 100644 --- a/docs-2.0/3.ngql-guide/9.space-statements/2.use-space.md +++ b/docs-2.0/3.ngql-guide/9.space-statements/2.use-space.md @@ -30,4 +30,4 @@ nebula> USE space2; 不能在一条语句中同时操作两个图空间。 - 与 Fabric Cypher 不同，NebulaGraph 的图空间彼此之间是完全隔离的，将一个图空间作为工作空间后，用户无法访问其他空间。使用新图空间的唯一方法是通过`USE`语句切换。而在 Fabric Cypher 中可以在一条语句中 (`USE + CALL`语法）使用两个图空间。 + 与 Fabric Cypher 不同，{{nebula.name}}的图空间彼此之间是完全隔离的，将一个图空间作为工作空间后，用户无法访问其他空间。使用新图空间的唯一方法是通过`USE`语句切换。而在 Fabric Cypher 中可以在一条语句中 (`USE + CALL`语法）使用两个图空间。 diff --git a/docs-2.0/3.ngql-guide/9.space-statements/3.show-spaces.md b/docs-2.0/3.ngql-guide/9.space-statements/3.show-spaces.md index 15ef2c827ca..864680838d6 100644 --- a/docs-2.0/3.ngql-guide/9.space-statements/3.show-spaces.md +++ b/docs-2.0/3.ngql-guide/9.space-statements/3.show-spaces.md @@ -1,6 +1,6 @@ # SHOW SPACES -`SHOW SPACES`语句可以列出 NebulaGraph 示例中的所有图空间。 +`SHOW SPACES`语句可以列出{{nebula.name}}示例中的所有图空间。 ## 语法 diff --git a/docs-2.0/3.ngql-guide/9.space-statements/5.drop-space.md b/docs-2.0/3.ngql-guide/9.space-statements/5.drop-space.md index 4d0b8356719..1b788cb1520 100644 --- a/docs-2.0/3.ngql-guide/9.space-statements/5.drop-space.md +++ b/docs-2.0/3.ngql-guide/9.space-statements/5.drop-space.md @@ -24,7 +24,7 @@ DROP SPACE [IF EXISTS] ; !!! Compatibility "历史版本兼容性" - 在 NebulaGraph 3.1.0 版本前，`DROP SPACE`语句不会删除硬盘上对应图空间的目录和文件。 + 在{{nebula.name}} 3.1.0 版本前，`DROP SPACE`语句不会删除硬盘上对应图空间的目录和文件。 !!! caution @@ -36,4 +36,4 @@ DROP SPACE [IF EXISTS] ; 问：执行`DROP SPACE`语句删除图空间后，为什么磁盘的大小没变化？ -答：如果使用 3.1.0 之前版本的 NebulaGraph, `DROP SPACE`语句仅删除指定的逻辑图空间，不会删除硬盘上对应图空间的目录和文件。如需删除硬盘上的数据，需手动删除相应文件的路径，文件路径为`/data/storage/nebula/`。其中``可以通过`DESCRIBE SPACE {space_name}`查看。 +答：如果使用 3.1.0 之前版本的{{nebula.name}}, `DROP SPACE`语句仅删除指定的逻辑图空间，不会删除硬盘上对应图空间的目录和文件。如需删除硬盘上的数据，需手动删除相应文件的路径，文件路径为`/data/storage/nebula/`。其中``可以通过`DESCRIBE SPACE {space_name}`查看。 diff --git a/docs-2.0/3.ngql-guide/9.space-statements/6.clear-space.md b/docs-2.0/3.ngql-guide/9.space-statements/6.clear-space.md index 3e4d02d45c0..811c06c3a8a 100644 --- a/docs-2.0/3.ngql-guide/9.space-statements/6.clear-space.md +++ b/docs-2.0/3.ngql-guide/9.space-statements/6.clear-space.md @@ -18,15 +18,17 @@ - 图空间中的数据量越大，`CLEAR SPACE`消耗的时间越长。如果`CLEAR SPACE`的执行因客户端连接超时而失败，可以增大 [Graph 服务配置](../../5.configurations-and-logs/1.configurations/3.graph-config.md)中`storage_client_timeout_ms`参数的值。 - 在`CLEAR SPACE`的执行过程中，向该图空间写入数据的行为不会被自动禁止。这样的写入行为可能导致`CLEAR SPACE`清除数据不完全，残留的数据也可能受到损坏。 +{{ comm.comm_begin }} !!! note - 社区版 NebulaGraph 不支持在运行`CLEAR SPACE`的同时禁止写入。 + {{nebula.name}} 不支持在运行`CLEAR SPACE`的同时禁止写入。 +{{ comm.comm_end }} {{ ent.ent_begin }} !!! enterpriseonly - 企业版 NebulaGraph 支持先运行`SET VARIABLE read_only=true`阻止向 NebulaGraph 写入数据，再运行`CLEAR SPACE`。数据清除成功后运行`SET VARIABLE read_only=false`即可重新允许写入。 + 企业版{{nebula.name}}支持先运行`SET VARIABLE read_only=true`阻止向{{nebula.name}}写入数据，再运行`CLEAR SPACE`。数据清除成功后运行`SET VARIABLE read_only=false`即可重新允许写入。 {{ ent.ent_end }} 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 6d47f5d05a3..158ab4519fb 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 @@ -1,10 +1,10 @@ -# 准备编译、安装和运行 NebulaGraph 的环境 +# 准备编译、安装和运行{{nebula.name}}的环境 -本文介绍编译、安装 NebulaGraph 的要求和建议，以及如何预估集群运行所需的资源。 +本文介绍编译、安装{{nebula.name}}的要求和建议，以及如何预估集群运行所需的资源。 ## 关于存储硬件 -NebulaGraph 是针对 NVMe SSD 进行设计和实现的，所有默认参数都是基于 SSD 设备进行调优，要求极高的 IOPS 和极低的 Latency。 +{{nebula.name}}是针对 NVMe SSD 进行设计和实现的，所有默认参数都是基于 SSD 设备进行调优，要求极高的 IOPS 和极低的 Latency。 - 不建议使用 HDD；因为其 IOPS 性能差，随机寻道延迟高；会遇到大量问题。 @@ -25,7 +25,7 @@ NebulaGraph 是针对 NVMe SSD 进行设计和实现的，所有默认参数都 !!! note - 从 3.0.2 开始，NebulaGraph 在 Docker Hub 上的 Docker 支持 ARM64 架构。社区用户可以在 ARM macOS 的 Docker Desktop 上或者 ARM Linux Server 上运行容器化的 NebulaGraph。 + 从 3.0.2 开始，{{nebula.name}}在 Docker Hub 上的 Docker 支持 ARM64 架构。社区用户可以在 ARM macOS 的 Docker Desktop 上或者 ARM Linux Server 上运行容器化的{{nebula.name}}。 ## 编译源码要求 @@ -39,11 +39,11 @@ NebulaGraph 是针对 NVMe SSD 进行设计和实现的，所有默认参数都 ### 操作系统要求 -当前仅支持在 Linux 系统中编译 NebulaGraph，建议使用内核版本为`4.15`及以上版本的 Linux 系统。 +当前仅支持在 Linux 系统中编译{{nebula.name}}，建议使用内核版本为`4.15`及以上版本的 Linux 系统。 !!! note - 在内核版本低于要求的 Linux 系统中安装 NebulaGraph 可使用 [RPM、DEB](2.compile-and-install-nebula-graph/2.install-nebula-graph-by-rpm-or-deb.md) 或者 [TAR](2.compile-and-install-nebula-graph/4.install-nebula-graph-from-tar.md) 文件。 + 在内核版本低于要求的 Linux 系统中安装{{nebula.name}}可使用 [RPM、DEB](2.compile-and-install-nebula-graph/2.install-nebula-graph-by-rpm-or-deb.md) 或者 [TAR](2.compile-and-install-nebula-graph/4.install-nebula-graph-from-tar.md) 文件。 ### 软件要求 @@ -161,7 +161,7 @@ NebulaGraph 是针对 NVMe SSD 进行设计和实现的，所有默认参数都 ### 操作系统要求 -当前仅支持在 Linux 系统中安装 NebulaGraph，建议在测试环境中使用内核版本为`3.9`及以上版本的 Linux 系统。 +当前仅支持在 Linux 系统中安装{{nebula.name}}，建议在测试环境中使用内核版本为`3.9`及以上版本的 Linux 系统。 ### 服务架构建议 @@ -173,7 +173,7 @@ NebulaGraph 是针对 NVMe SSD 进行设计和实现的，所有默认参数都 例如单机测试环境，用户可以在机器上部署 1 个 metad、1 个 storaged 和 1 个 graphd 进程。 -对于更常见的测试环境，例如三台机器构成的集群，用户可以按照如下方案部署 NebulaGraph。 +对于更常见的测试环境，例如三台机器构成的集群，用户可以按照如下方案部署{{nebula.name}}。 | 机器名称 | metad 进程数量 | storaged 进程数量 | graphd 进程数量 | | ------------ | --------------- | ------------------ | ---------------- | @@ -194,9 +194,9 @@ NebulaGraph 是针对 NVMe SSD 进行设计和实现的，所有默认参数都 ### 操作系统要求 -当前仅支持在 Linux 系统中安装 NebulaGraph，建议在生产环境中使用内核版本为`3.9`及以上版本的 Linux 系统。 +当前仅支持在 Linux 系统中安装{{nebula.name}}，建议在生产环境中使用内核版本为`3.9`及以上版本的 Linux 系统。 -用户可以通过调整一些内核参数来提高 NebulaGraph 性能，详情请参见[内核配置](../5.configurations-and-logs/1.configurations/6.kernel-config.md)。 +用户可以通过调整一些内核参数来提高{{nebula.name}}性能，详情请参见[内核配置](../5.configurations-and-logs/1.configurations/6.kernel-config.md)。 ### 服务架构建议 @@ -214,7 +214,7 @@ NebulaGraph 是针对 NVMe SSD 进行设计和实现的，所有默认参数都 storaged 进程的数量不会影响图空间副本的数量。 -用户可以在一台机器上部署多个不同进程，例如五台机器构成的集群，用户可以按照如下方案部署 NebulaGraph。 +用户可以在一台机器上部署多个不同进程，例如五台机器构成的集群，用户可以按照如下方案部署{{nebula.name}}。 | 机器名称 | metad 进程数量 | storaged 进程数量 | graphd 进程数量 | | ------------ | --------------- | ------------------ | ---------------- | @@ -224,9 +224,9 @@ storaged 进程的数量不会影响图空间副本的数量。 | D | - | 1 | 1 | | E | - | 1 | 1 | -## NebulaGraph 资源要求 +## {{nebula.name}}资源要求 -用户可以预估一个 3 副本 NebulaGraph 集群所需的内存、硬盘空间和分区数量。 +用户可以预估一个 3 副本{{nebula.name}}集群所需的内存、硬盘空间和分区数量。 | 资源 |单位 | 计算公式 |说明| |:--- |:---|:--- |:---| @@ -244,7 +244,7 @@ storaged 进程的数量不会影响图空间副本的数量。 - 问题 3：如何获取 RocksDB 实例数量？ - 答：对于社区版 NebulaGraph，每个图空间对应一个 RocksDB 实例，并且`--data_path`选项（`etc`目录下的`nebula-storaged.conf`文件中）中的每个目录对应一个 RocksDB 实例。即，RocksDB 实例数量 = 图空间总数 * 目录总数。对于企业版 NebulaGraph，一个分区对应一个 RocksDB 实例。 + 答：对于社区版{{nebula.name}}，每个图空间对应一个 RocksDB 实例，并且`--data_path`选项（`etc`目录下的`nebula-storaged.conf`文件中）中的每个目录对应一个 RocksDB 实例。即，RocksDB 实例数量 = 图空间总数 * 目录总数。对于企业版{{nebula.name}}，一个分区对应一个 RocksDB 实例。 !!! Note 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 8691d4a3033..642968a7a7b 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 @@ -1,6 +1,6 @@ -# 使用源码安装 NebulaGraph +# 使用源码安装{{nebula.name}} -使用源码安装 NebulaGraph 允许自定义编译和安装设置，并测试最新特性。 +使用源码安装{{nebula.name}}允许自定义编译和安装设置，并测试最新特性。 ## 前提条件 @@ -8,15 +8,15 @@ !!! note - 暂不支持离线编译 NebulaGraph。 + 暂不支持离线编译{{nebula.name}}。 -- 待安装 NebulaGraph 的主机可以访问互联网。 +- 待安装{{nebula.name}}的主机可以访问互联网。 ## 安装步骤 -1. 克隆 NebulaGraph 的源代码到主机。 +1. 克隆{{nebula.name}}的源代码到主机。 - - [推荐] 如果需要安装{{nebula.release}}版本的 NebulaGraph，执行如下命令： + - [推荐] 如果需要安装{{nebula.release}}版本的{{nebula.name}}，执行如下命令： ```bash $ git clone --branch {{nebula.branch}} https://github.com/vesoft-inc/nebula.git @@ -28,7 +28,7 @@ $ git clone https://github.com/vesoft-inc/nebula.git ``` -2. 进入`nebula/third-party`目录，安装 NebulaGraph 依赖的第三方库。 +2. 进入`nebula/third-party`目录，安装{{nebula.name}}依赖的第三方库。 ```bash $ cd nebula/third-party @@ -54,7 +54,7 @@ $ cmake -DCMAKE_INSTALL_PREFIX=/usr/local/nebula -DENABLE_TESTING=OFF -DCMAKE_BUILD_TYPE=Release .. ``` -5. 编译 NebulaGraph。 +5. 编译{{nebula.name}}。 !!! Note @@ -66,7 +66,7 @@ $ make -j{N} # E.g., make -j2 ``` -6. 安装 NebulaGraph。 +6. 安装{{nebula.name}}。 ```bash $ sudo make install @@ -76,7 +76,7 @@ ## 更新 master 版本 -master 分支的代码更新速度快，如果安装了 master 分支对应的开发版 NebulaGraph，可根据以下步骤更新版本。 +master 分支的代码更新速度快，如果安装了 master 分支对应的开发版{{nebula.name}}，可根据以下步骤更新版本。 1. 在目录`nebula`中，执行命令`git pull upstream master`更新源码。 @@ -88,7 +88,7 @@ master 分支的代码更新速度快，如果安装了 master 分支对应的 - （企业版）[设置 License](../deploy-license.md) {{ ent.ent_end }} -- [管理 NebulaGraph 服务](../../2.quick-start/3.quick-start-on-premise/5.start-stop-service.md) +- [管理{{nebula.name}}服务](../../2.quick-start/3.quick-start-on-premise/5.start-stop-service.md) ## CMake 参数 @@ -102,7 +102,7 @@ $ cmake -D= ... ### CMAKE_INSTALL_PREFIX -`CMAKE_INSTALL_PREFIX`指定 NebulaGraph 服务模块、脚本和配置文件的安装路径，默认路径为`/usr/local/nebula`。 +`CMAKE_INSTALL_PREFIX`指定{{nebula.name}}服务模块、脚本和配置文件的安装路径，默认路径为`/usr/local/nebula`。 ### ENABLE_WERROR @@ -110,15 +110,15 @@ $ cmake -D= ... ### ENABLE_TESTING -默认值为`ON`，表示单元测试服务由 NebulaGraph 服务构建。如果只需要服务模块，可以设置为`OFF`。 +默认值为`ON`，表示单元测试服务由{{nebula.name}}服务构建。如果只需要服务模块，可以设置为`OFF`。 ### ENABLE_ASAN -默认值为`OFF`，表示关闭内存问题检测工具 ASan（AddressSanitizer）。该工具是为 NebulaGraph 开发者准备的，如果需要开启，可以设置为`ON`。 +默认值为`OFF`，表示关闭内存问题检测工具 ASan（AddressSanitizer）。该工具是为{{nebula.name}}开发者准备的，如果需要开启，可以设置为`ON`。 ### CMAKE_BUILD_TYPE -`CMAKE_BUILD_TYPE`控制 NebulaGraph 的 build 方法，取值说明如下： +`CMAKE_BUILD_TYPE`控制{{nebula.name}}的 build 方法，取值说明如下： - `Debug` diff --git a/docs-2.0/4.deployment-and-installation/2.compile-and-install-nebula-graph/2.install-nebula-graph-by-rpm-or-deb.md b/docs-2.0/4.deployment-and-installation/2.compile-and-install-nebula-graph/2.install-nebula-graph-by-rpm-or-deb.md index 0a05af235b6..590ec286828 100644 --- a/docs-2.0/4.deployment-and-installation/2.compile-and-install-nebula-graph/2.install-nebula-graph-by-rpm-or-deb.md +++ b/docs-2.0/4.deployment-and-installation/2.compile-and-install-nebula-graph/2.install-nebula-graph-by-rpm-or-deb.md @@ -1,4 +1,4 @@ -# 使用 RPM 或 DEB 包安装 NebulaGraph +# 使用 RPM 或 DEB 包安装{{nebula.name}} {% include "/source_install-nebula-graph-by-rpm-or-deb.md" %} 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 a732d5ee01e..a8f7b2878f9 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 @@ -1,6 +1,6 @@ -# 使用 Docker Compose 部署 NebulaGraph +# 使用 Docker Compose 部署{{nebula.name}} -使用 Docker Compose 可以基于准备好的配置文件快速部署 NebulaGraph 服务，仅建议在测试 NebulaGraph 功能时使用该方式。 +使用 Docker Compose 可以基于准备好的配置文件快速部署{{nebula.name}}服务，仅建议在测试{{nebula.name}}功能时使用该方式。 ## 前提条件 @@ -12,13 +12,13 @@ |Docker Compose|最新版本|[Install Docker Compose](https://docs.docker.com/compose/install/)| |Git|最新版本|[Download Git](https://git-scm.com/download/)| -- 如果使用非 root 用户部署 NebulaGraph，请授权该用户 Docker 相关的权限。详细信息，请参见 [Manage Docker as a non-root user](https://docs.docker.com/engine/install/linux-postinstall/#manage-docker-as-a-non-root-user)。 +- 如果使用非 root 用户部署{{nebula.name}}，请授权该用户 Docker 相关的权限。详细信息，请参见 [Manage Docker as a non-root user](https://docs.docker.com/engine/install/linux-postinstall/#manage-docker-as-a-non-root-user)。 - 启动主机上的 Docker 服务。 -- 如果已经通过 Docker Compose 在主机上部署了另一个版本的 NebulaGraph，为避免兼容性问题，需要删除目录`nebula-docker-compose/data`。 +- 如果已经通过 Docker Compose 在主机上部署了另一个版本的{{nebula.name}}，为避免兼容性问题，需要删除目录`nebula-docker-compose/data`。 -## 部署 NebulaGraph +## 部署{{nebula.name}} 1. 通过 Git 克隆`nebula-docker-compose`仓库的`{{dockercompose.release}}`分支到主机。 @@ -40,11 +40,11 @@ $ cd nebula-docker-compose/ ``` -3. 执行如下命令启动 NebulaGraph 服务。 +3. 执行如下命令启动{{nebula.name}}服务。 !!! note - - 如果长期未内核更新镜像，请先更新 [NebulaGraph 镜像](#nebulagraph_docker)和 [NebulaGraph Console 镜像](#nebulagraph_console)。 + - 如果长期未内核更新镜像，请先更新 [{{nebula.name}}镜像](#nebulagraph_docker)和 [NebulaGraph Console 镜像](#nebulagraph_console)。 - 执行命令后的返回结果因安装目录不同而不同。 ```bash @@ -68,11 +68,11 @@ 上述服务的更多信息，请参见[架构总览](../../1.introduction/3.nebula-graph-architecture/1.architecture-overview.md)。 -## 连接 NebulaGraph +## 连接{{nebula.name}} -连接 NebulaGraph 有两种方式： +连接{{nebula.name}}有两种方式： -- 在容器外通过 Nebula Console 连接。因为容器的配置文件中将 Graph 服务的外部映射端口也固定为 9669，因此可以直接通过默认端口连接。详情参见[连接 NebulaGraph](../../2.quick-start/3.quick-start-on-premise/3.connect-to-nebula-graph.md)。 +- 在容器外通过 Nebula Console 连接。因为容器的配置文件中将 Graph 服务的外部映射端口也固定为 9669，因此可以直接通过默认端口连接。详情参见[连接{{nebula.name}}](../../2.quick-start/3.quick-start-on-premise/3.connect-to-nebula-graph.md)。 - 登录安装了 NebulaGraph Console 的容器，然后再连接 Graph 服务。本小节介绍这种方式。 @@ -94,7 +94,7 @@ / # ``` -3. 通过 NebulaGraph Console 连接 NebulaGraph。 +3. 通过 NebulaGraph Console 连接{{nebula.name}}。 ```bash / # ./usr/local/bin/nebula-console -u -p --address=graphd --port=9669 @@ -119,12 +119,12 @@ 执行两次`exit`可以退出容器。 -## 查看 NebulaGraph 服务的状态和端口 +## 查看{{nebula.name}}服务的状态和端口 -执行命令`docker-compose ps`可以列出 NebulaGraph 服务的状态和端口。 +执行命令`docker-compose ps`可以列出{{nebula.name}}服务的状态和端口。 !!! note - NebulaGraph 默认使用`9669`端口为客户端提供服务，如果需要修改端口，请修改目录`nebula-docker-compose`内的文件`docker-compose.yaml`，然后重启 NebulaGraph 服务。 + {{nebula.name}}默认使用`9669`端口为客户端提供服务，如果需要修改端口，请修改目录`nebula-docker-compose`内的文件`docker-compose.yaml`，然后重启 NebulaGraph 服务。 ```bash $ docker-compose ps diff --git a/docs-2.0/4.deployment-and-installation/4.uninstall-nebula-graph.md b/docs-2.0/4.deployment-and-installation/4.uninstall-nebula-graph.md index f1705ff6e35..eff9caac780 100644 --- a/docs-2.0/4.deployment-and-installation/4.uninstall-nebula-graph.md +++ b/docs-2.0/4.deployment-and-installation/4.uninstall-nebula-graph.md @@ -1,14 +1,14 @@ -# 卸载 NebulaGraph +# 卸载{{nebula.name}} -本文介绍如何卸载 NebulaGraph。 +本文介绍如何卸载{{nebula.name}}。 !!! caution - 如果需要重新部署 NebulaGraph，请务必完全卸载后再重新部署，否则可能会出现问题，包括 Meta 不一致等。 + 如果需要重新部署{{nebula.name}}，请务必完全卸载后再重新部署，否则可能会出现问题，包括 Meta 不一致等。 ## 前提条件 -停止 NebulaGraph 服务。详情参见[管理 NebulaGraph 服务](../2.quick-start/3.quick-start-on-premise/5.start-stop-service.md)。 +停止{{nebula.name}}服务。详情参见[管理{{nebula.name}}服务](../2.quick-start/3.quick-start-on-premise/5.start-stop-service.md)。 ## 步骤 1：删除数据和元数据文件 @@ -39,13 +39,13 @@ 安装路径为参数`--prefix`指定的路径。默认路径为`/usr/local/nebula`。 -### 卸载编译安装的 NebulaGraph +### 卸载编译安装的{{nebula.name}} -找到 NebulaGraph 的安装目录，删除整个安装目录。 +找到{{nebula.name}}的安装目录，删除整个安装目录。 -### 卸载 RPM 包安装的 NebulaGraph +### 卸载 RPM 包安装的{{nebula.name}} -1. 使用如下命令查看 NebulaGraph 版本。 +1. 使用如下命令查看{{nebula.name}}版本。 ```bash $ rpm -qa | grep "nebula" @@ -57,7 +57,7 @@ nebula-graph-{{ nebula.release }}-1.x86_64 ``` -2. 使用如下命令卸载 NebulaGraph。 +2. 使用如下命令卸载{{nebula.name}}。 ```bash sudo rpm -e @@ -71,9 +71,9 @@ 3. 删除安装目录。 -### 卸载 DEB 包安装的 NebulaGraph +### 卸载 DEB 包安装的{{nebula.name}} -1. 使用如下命令查看 NebulaGraph 版本。 +1. 使用如下命令查看{{nebula.name}}版本。 ```bash $ dpkg -l | grep "nebula" @@ -85,7 +85,7 @@ ii nebula-graph {{ nebula.release }} amd64 NebulaGraph Package built using CMake ``` -2. 使用如下命令卸载 NebulaGraph。 +2. 使用如下命令卸载{{nebula.name}}。 ```bash sudo dpkg -r @@ -99,9 +99,9 @@ 3. 删除安装目录。 -### 卸载 Docker Compose 部署的 NebulaGraph +### 卸载 Docker Compose 部署的{{nebula.name}} -1. 在目录`nebula-docker-compose`内执行如下命令停止 NebulaGraph 服务。 +1. 在目录`nebula-docker-compose`内执行如下命令停止{{nebula.name}}服务。 ```bash docker-compose down -v diff --git a/docs-2.0/4.deployment-and-installation/5.zone.md b/docs-2.0/4.deployment-and-installation/5.zone.md index 9c5dcc3817a..d622a25e46c 100644 --- a/docs-2.0/4.deployment-and-installation/5.zone.md +++ b/docs-2.0/4.deployment-and-installation/5.zone.md @@ -1,6 +1,6 @@ # 管理逻辑机架（Zone） -NebulaGraph 提供 Zone 功能，可以管理集群中的 Storage 节点，实现资源隔离。 +{{nebula.name}}提供 Zone 功能，可以管理集群中的 Storage 节点，实现资源隔离。 ## 背景信息 diff --git a/docs-2.0/4.deployment-and-installation/connect-to-nebula-graph.md b/docs-2.0/4.deployment-and-installation/connect-to-nebula-graph.md index 183c122793d..d874231454f 100644 --- a/docs-2.0/4.deployment-and-installation/connect-to-nebula-graph.md +++ b/docs-2.0/4.deployment-and-installation/connect-to-nebula-graph.md @@ -1,4 +1,4 @@ -# 连接 NebulaGraph 服务 +# 连接{{nebula.name}}服务 {% include "/source_connect-to-nebula-graph.md" %} diff --git a/docs-2.0/4.deployment-and-installation/deploy-license.md b/docs-2.0/4.deployment-and-installation/deploy-license.md index 1498c235e3a..8caf30b3072 100644 --- a/docs-2.0/4.deployment-and-installation/deploy-license.md +++ b/docs-2.0/4.deployment-and-installation/deploy-license.md @@ -1,6 +1,6 @@ -# 设置 NebulaGraph 企业版 License +# 设置{{nebula.name}} License -NebulaGraph 企业版需要用户设置 License 才可以正常启动并使用企业版功能，本文介绍如何设置企业版的 License 文件。 +{{nebula.name}}需要用户设置 License 才可以正常启动并使用企业版功能，本文介绍如何设置企业版的 License 文件。 !!! enterpriseonly @@ -8,7 +8,7 @@ NebulaGraph 企业版需要用户设置 License 才可以正常启动并使用 ## 注意事项 -- 没有设置 License 时，NebulaGraph 企业版无法启动。 +- 没有设置 License 时，{{nebula.name}}无法启动。 - 请勿修改 License 文件，否则会导致 License 失效。 @@ -22,7 +22,7 @@ NebulaGraph 企业版需要用户设置 License 才可以正常启动并使用 - 过期 14 天后，服务无法启动，并会打印日志进行提醒。 -## NebulaGraph 企业版 License 说明 +## {{nebula.name}} License 说明 License 文件（`nebula.license`）内容示例如下： @@ -60,19 +60,19 @@ License 文件包含生效时间、过期时间等信息。说明如下。 |`organization`| 用户名称。| |`issuedDate`| License 生效时间。| |`expirationDate`| License 过期时间。| -|`product`| 产品类型。NebulaGraph 的产品类型为`nebula_graph`。| +|`product`| 产品类型。{{nebula.name}}的产品类型为`nebula_graph`。| |`version`| 版本支持的信息。| |`licenseType`| License 类型。包括`enterprise`、`samll_bussiness`、`pro`、`individual`。预留参数。| |`gracePeriod`| 证书过期后可继续使用服务的缓冲时间（单位天），超过缓冲期后停止服务。试用版的 License 过期后无缓冲期，默认值为 0。 | -|`graphdSpec`| 集群中 Graph 服务的数量限制。NebulaGraph 会实时监测当前活动的 Graph 服务数量，超过限制的 Graph 服务无法连接集群。| -|`storagedSpec`| 集群中 Storage 服务的数量限制。NebulaGraph 会实时监测当前活动的 Storage 服务数量，超过限制的 Storage 服务无法连接集群。| +|`graphdSpec`| 集群中 Graph 服务的数量限制。{{nebula.name}}会实时监测当前活动的 Graph 服务数量，超过限制的 Graph 服务无法连接集群。| +|`storagedSpec`| 集群中 Storage 服务的数量限制。{{nebula.name}}会实时监测当前活动的 Storage 服务数量，超过限制的 Storage 服务无法连接集群。| |`clusterCode`| 用户的硬件信息，也是集群的唯一标识码。试用版的 License 中无此参数。 | -## 设置 NebulaGraph 企业版 License +## 设置{{nebula.name}} License -1. [联系我们](https://www.nebula-graph.com.cn/contact)申请 NebulaGraph 企业版安装包。 +1. [联系我们](https://www.nebula-graph.com.cn/contact)申请{{nebula.name}}安装包。 -2. 安装 NebulaGraph 企业版。安装方式与社区版相同，请参见[使用 RPM 或 DEB 包安装 NebulaGraph](2.compile-and-install-nebula-graph/2.install-nebula-graph-by-rpm-or-deb.md)。 +2. 安装{{nebula.name}}。安装方式与社区版相同，请参见[使用 RPM 或 DEB 包安装{{nebula.name}}](2.compile-and-install-nebula-graph/2.install-nebula-graph-by-rpm-or-deb.md)。 3. [联系我们](https://www.nebula-graph.com.cn/contact)申请 License 文件`nebula.license`。 @@ -82,9 +82,9 @@ License 文件包含生效时间、过期时间等信息。说明如下。 周边工具的 License 文件上传位置，请参见[具体周边工具](../20.appendix/6.eco-tool-version.md)的说明文档。 -## 续期 NebulaGraph 企业版 License +## 续期{{nebula.name}} License -1. 发送邮件至`inqury@vesoft.com`申请新的 NebulaGraph 企业版 License。 +1. 发送邮件至`inqury@vesoft.com`申请新的{{nebula.name}} License。 2. 在所有包含 Meta 服务的机器上，路径为每个 Meta 服务安装目录的`share/resources/`内，使用新的 License 文件`nebula.license`替换旧的 License 文件。 @@ -94,7 +94,7 @@ License 文件包含生效时间、过期时间等信息。说明如下。 当用户的 License 过期时间超过到期后的缓冲期，Graph 和 Storage 服务会自动停止。为了确保服务正常运行，请及时更新 License。 -## 查看 NebulaGraph 企业版 License +## 查看{{nebula.name}} License - 直接查看 License 文件 @@ -102,8 +102,8 @@ License 文件包含生效时间、过期时间等信息。说明如下。 - 通过 HTTP 接口查看 License 文件 - 当 NebulaGraph 正常运行时，可以请求 Meta 服务的 HTTP 接口（默认为19559）获取 License 文件内容。例如`curl -G "http://192.168.10.101:19559/license"`。 + 当{{nebula.name}}正常运行时，可以请求 Meta 服务的 HTTP 接口（默认为19559）获取 License 文件内容。例如`curl -G "http://192.168.10.101:19559/license"`。 ## 下一步 -[启动 NebulaGraph](manage-service.md) +[启动{{nebula.name}}](manage-service.md) diff --git a/docs-2.0/4.deployment-and-installation/manage-service.md b/docs-2.0/4.deployment-and-installation/manage-service.md index ea5c31f0de4..69f707c9ee8 100644 --- a/docs-2.0/4.deployment-and-installation/manage-service.md +++ b/docs-2.0/4.deployment-and-installation/manage-service.md @@ -1,4 +1,4 @@ -# 管理 NebulaGraph 服务 +# 管理{{nebula.name}}服务 {% include "/source_manage-service.md" %} diff --git a/docs-2.0/4.deployment-and-installation/manage-storage-host.md b/docs-2.0/4.deployment-and-installation/manage-storage-host.md index 6c2fb6c15dc..3ca65bba614 100644 --- a/docs-2.0/4.deployment-and-installation/manage-storage-host.md +++ b/docs-2.0/4.deployment-and-installation/manage-storage-host.md @@ -5,7 +5,7 @@ ## 增加 Storage 主机 diff --git a/docs-2.0/4.deployment-and-installation/standalone-deployment.md b/docs-2.0/4.deployment-and-installation/standalone-deployment.md index 02737f536f0..bfbfd954ae8 100644 --- a/docs-2.0/4.deployment-and-installation/standalone-deployment.md +++ b/docs-2.0/4.deployment-and-installation/standalone-deployment.md @@ -1,16 +1,16 @@ -# 存算合并版 NebulaGraph +# 存算合并版{{nebula.name}} -存算合并版 NebulaGraph 将存储服务（Meta 和 Storage）和计算服务（Graph）合并至一个进程，用于部署在单台机器上。本文介绍存算合并版 NebulaGraph 的使用场景、安装步骤等。 +存算合并版{{nebula.name}}将存储服务（Meta 和 Storage）和计算服务（Graph）合并至一个进程，用于部署在单台机器上。本文介绍存算合并版{{nebula.name}}的使用场景、安装步骤等。 !!! danger - 存算合并版 NebulaGraph 不用于生产环境。 + 存算合并版{{nebula.name}}不用于生产环境。 ## 背景信息 -传统的 NebulaGraph 架构由 3 个服务构成，每个服务都有可执行的二进制文件和对应的进程，进程之间通过 RPC 协议进行调用。而在存算合并版 NebulaGraph 中，NebulaGraph 中 3 个服务对应的 3 个进程被合为 1 个进程。 +传统的{{nebula.name}}架构由 3 个服务构成，每个服务都有可执行的二进制文件和对应的进程，进程之间通过 RPC 协议进行调用。而在存算合并版{{nebula.name}}中，{{nebula.name}}中 3 个服务对应的 3 个进程被合为 1 个进程。 -关于 NebulaGraph 的更多信息，参见[架构总览](../1.introduction/3.nebula-graph-architecture/1.architecture-overview.md)。 +关于{{nebula.name}}的更多信息，参见[架构总览](../1.introduction/3.nebula-graph-architecture/1.architecture-overview.md)。 ## 使用场景 @@ -23,11 +23,11 @@ ## 环境准备 -关于安装存算合并版 NebulaGraph 所需的环境，参见[编译 NebulaGraph 源码要求](1.resource-preparations.md)。 +关于安装存算合并版{{nebula.name}}所需的环境，参见[编译{{nebula.name}}源码要求](1.resource-preparations.md)。 ## 安装步骤 -目前仅支持使用源码安装存算合并版 NebulaGraph。其安装步骤与多进程的 NebulaGraph 步骤类似，用户只需在**使用 CMake 生成 makefile 文件**步骤的命令中添加`-DENABLE_STANDALONE_VERSION=on`。示例如下： +目前仅支持使用源码安装存算合并版{{nebula.name}}。其安装步骤与多进程的{{nebula.name}}步骤类似，用户只需在**使用 CMake 生成 makefile 文件**步骤的命令中添加`-DENABLE_STANDALONE_VERSION=on`。示例如下： ```bash cmake -DCMAKE_INSTALL_PREFIX=/usr/local/nebula -DENABLE_TESTING=OFF -DENABLE_STANDALONE_VERSION=on -DCMAKE_BUILD_TYPE=Release .. @@ -35,13 +35,13 @@ cmake -DCMAKE_INSTALL_PREFIX=/usr/local/nebula -DENABLE_TESTING=OFF -DENABLE_STA 有关具体的安装步骤，参见[使用源码安装](2.compile-and-install-nebula-graph/1.install-nebula-graph-by-compiling-the-source-code.md)。 -用户完成存算合并版 NebulaGraph 后，可以参见[连接服务](connect-to-nebula-graph.md)连接 NebulaGraph。 +用户完成存算合并版{{nebula.name}}后，可以参见[连接服务](connect-to-nebula-graph.md)连接{{nebula.name}}。 ## 配置文件 -存算合并版 NebulaGraph 的配置文件的路径默认为`/usr/local/nebula/etc`。 +存算合并版{{nebula.name}}的配置文件的路径默认为`/usr/local/nebula/etc`。 -用户可执行`sudo cat nebula-standalone.conf.default`查看配置文件内容。配置文件参数和描述和多进程的 NebulaGraph 大体一致，除以下参数外： +用户可执行`sudo cat nebula-standalone.conf.default`查看配置文件内容。配置文件参数和描述和多进程的{{nebula.name}}大体一致，除以下参数外： | 参数 | 预设值 | 说明 | | ---------------- | ----------- | --------------------- | From 53431b6b229d4d9f97b794746e3da24429316622 Mon Sep 17 00:00:00 2001 From: randomJoe211 <69501902+randomJoe211@users.noreply.github.com> Date: Tue, 11 Apr 2023 11:58:20 +0800 Subject: [PATCH 126/137] update --- docs-2.0/nebula-flink/nf-ug-compile.md | 49 ---- docs-2.0/nebula-flink/nf-ug-customize-sink.md | 213 ------------------ .../nebula-flink/nf-ug-customize-source.md | 105 --------- docs-2.0/nebula-flink/nf-ug-limitations.md | 14 -- docs-2.0/nebula-flink/nf-ug-notes.md | 80 ------- docs-2.0/nebula-flink/nf-ug-toc.md | 7 - .../nf-ug-what-is-flink-connector.md | 16 -- .../quick-start/st-ug-plan-schema.md | 4 +- .../st-ug-config-server-errors.md | 22 +- .../st-ug-connection-errors.md | 2 +- .../troubleshooting/st-ug-faq.md | 2 +- .../reuse/source_connect-to-nebula-graph.md | 18 +- ...urce_install-nebula-graph-by-rpm-or-deb.md | 40 +--- docs-2.0/reuse/source_manage-service.md | 26 +-- docs-2.0/reuse/source_ngql_for_quick_start.md | 8 +- .../reader/sc-ug-reader-example.md | 134 ----------- .../reader/sc-ug-what-is-reader.md | 49 ---- docs-2.0/spark-connector/sc-ug-compile.md | 45 ---- docs-2.0/spark-connector/sc-ug-limitations.md | 22 -- docs-2.0/spark-connector/sc-ug-toc.md | 11 - .../sc-ug-what-is-spark-connector.md | 13 -- .../writer/sc-ug-what-is-writer.md | 45 ---- .../writer/sc-ug-writer-example.md | 134 ----------- docs-2.0/stylesheets/extra.css | 4 +- .../2.balance-syntax.md | 2 +- .../replication-between-clusters.md | 8 +- 26 files changed, 57 insertions(+), 1016 deletions(-) delete mode 100644 docs-2.0/nebula-flink/nf-ug-compile.md delete mode 100644 docs-2.0/nebula-flink/nf-ug-customize-sink.md delete mode 100644 docs-2.0/nebula-flink/nf-ug-customize-source.md delete mode 100644 docs-2.0/nebula-flink/nf-ug-limitations.md delete mode 100644 docs-2.0/nebula-flink/nf-ug-notes.md delete mode 100644 docs-2.0/nebula-flink/nf-ug-toc.md delete mode 100644 docs-2.0/nebula-flink/nf-ug-what-is-flink-connector.md delete mode 100644 docs-2.0/spark-connector/reader/sc-ug-reader-example.md delete mode 100644 docs-2.0/spark-connector/reader/sc-ug-what-is-reader.md delete mode 100644 docs-2.0/spark-connector/sc-ug-compile.md delete mode 100644 docs-2.0/spark-connector/sc-ug-limitations.md delete mode 100644 docs-2.0/spark-connector/sc-ug-toc.md delete mode 100644 docs-2.0/spark-connector/sc-ug-what-is-spark-connector.md delete mode 100644 docs-2.0/spark-connector/writer/sc-ug-what-is-writer.md delete mode 100644 docs-2.0/spark-connector/writer/sc-ug-writer-example.md diff --git a/docs-2.0/nebula-flink/nf-ug-compile.md b/docs-2.0/nebula-flink/nf-ug-compile.md deleted file mode 100644 index 72c649c3b6b..00000000000 --- a/docs-2.0/nebula-flink/nf-ug-compile.md +++ /dev/null @@ -1,49 +0,0 @@ -# 编译 NebulaGraph Flink Connector - -按以下步骤编译 NebulaGraph Flink Connector v1.x： - -1. 克隆 `nebula-java` 源代码。 - - ```bash - git clone -b v1.0 https://github.com/vesoft-inc/nebula-java.git - ``` - -2. 切换到 `nebula-java` 目录，并打包 NebulaGraph Java 1.x。 - - ```bash - cd nebula-java - mvn clean install -Dgpg.skip -Dmaven.javadoc.skip=true -Dmaven.test.skip=true - ``` - -3. 进入 `tools/nebula-flink` 目录，并编译 NebulaGraph Flink Connector v1.x。 - - ```bash - cd nebula-java/tools/nebula-flink - mvn clean package -Dgpg.skip -Dmaven.javadoc.skip=true -Dmaven.test.skip=true - ``` - -编译成功后，用户可以在当前目录里看到如下目录结构。在 `target` 目录下，用户可以看到 `nebula-flink-1.x.y.jar` 文件。将这个文件复制到本地 Maven 库的 `com/vesoft/nebula-flink/` 目录中。 - -```text -├── README.md -├── pom.xml -├── src -│ ├── main -│ └── test -└── target - ├── classes - ├── generated-sources - ├── generated-test-sources - ├── maven-archiver - ├── maven-status - ├── nebula-flink-1.x.y-sources.jar - ├── nebula-flink-1.x.y-test-sources.jar - ├── nebula-flink-1.x.y-tests.jar - ├── nebula-flink-1.x.y.jar - ├── original-nebula-flink-1.x.y.jar - └── test-classes -``` - -!!! Note - - JAR 文件版本号会因 NebulaGraph Java Client 的发布版本而异。用户可以在 [nebula-java 仓库的 Releases 页面](https://github.com/vesoft-inc/nebula-java/releases "点击前往 GitHub 网站") 查看最新的 v1.x 版本。 diff --git a/docs-2.0/nebula-flink/nf-ug-customize-sink.md b/docs-2.0/nebula-flink/nf-ug-customize-sink.md deleted file mode 100644 index 8bbe2bf222e..00000000000 --- a/docs-2.0/nebula-flink/nf-ug-customize-sink.md +++ /dev/null @@ -1,213 +0,0 @@ -# 自定义 sink (NebulaSink) - -NebulaGraph Flink Connector 支持以 `DataStream.addSink` 的方式将 Flink 数据流写入 NebulaGraph 数据库。 - -!!! Note - - NebulaGraph Flink Connector 使用 Flink 1.11-SNAPSHOT 开发，这个版本已经不再支持使用 `writeUsingOutputFormat` 方式定义输出端的接口，源码如下。所以，在使用自定义 NebulaSink 时，请务必使用 `DataStream.addSink` 方式。 - /** @deprecated */ - @Deprecated - @PublicEvolving - public DataStreamSink writeUsingOutputFormat(OutputFormat format) { - return this.addSink(new OutputFormatSinkFunction(format)); - } - -NebulaGraph Flink Connector 中实现了自定义的 `NebulaSinkFunction`，开发者通过调用 `dataSource.addSink` 方法并将 `NebulaSinkFunction` 对象作为参数传入即可实现将 Flink 数据流写入 NebulaGraph 数据库中。 - -NebulaSink 的实现类图如下所示。 - -![NebulaGraph Flink Connector 的 sink 实现类图](https://docs-cdn.nebula-graph.com.cn/nebula-java-tools-docs/fl-ug-003.png "sink 实现类图") - -最重要的两个类是 `NebulaSinkFunction` `NebulaBatchOutputFormat`。 - -## `NebulaSinkFunction` - -`NebulaSinkFunction` 继承自 `AbstractRichFunction` 并实现了以下方法： - -- `open`：调用 `NebulaBatchOutputFormat` 的 `open` 方法以准备资源。 -- `close`：调用 `NebulaBatchOutputFormat` 的 `close` 方法以释放资源。 -- `invoke`：是 NebulaSink 中的核心方法，调用 `NebulaBatchOutputFormat` 中的 `write` 方法写入数据。 -- `flush`：调用 `NebulaBatchOutputFormat` 的 `flush` 方法提交数据。 - -## `NebulaBatchOutputFormat` - -`NebulaBatchOutputFormat` 继承自 `AbstractNebulaOutPutFormat`，而后者继承自 `RichOutputFormat`，主要实现了以下方法： - -- `open`：准备 NebulaGraph 数据库的 Graph 服务的连接，并初始化数据写入执行器 `nebulaBatchExecutor`。 -- `close`：提交最后批次的数据，等待最后提交的回调结果并关闭服务连接等资源。 -- `writeRecord`：核心方法，将数据写入 bufferedRow 中，并在达到配置的批量写入上限时提交写入。NebulaSink 的写入操作是异步的，所以需要执行回调来获取执行结果。 -- `flush`：当 bufferedRow 存在数据时，将数据提交到 NebulaGraph 中。 - -在 `AbstractNebulaOutputFormat` 中调用了 `NebulaBatchExecutor`，用于数据的批量管理和批量提交，并通过定义回调函数接收批量提交的结果，代码如下： - -```java - /** - * write one record to buffer - */ - @Override - public final synchronized void writeRecord(T row) throws IOException { - nebulaBatchExecutor.addToBatch(row); - - if (numPendingRow.incrementAndGet() >= executionOptions.getBatch()) { - commit(); - } - } - - /** - * put record into buffer - * - * @param record represent vertex or edge - */ - void addToBatch(T record) { - boolean isVertex = executionOptions.getDataType().isVertex(); - - NebulaOutputFormatConverter converter; - if (isVertex) { - converter = new NebulaRowVertexOutputFormatConverter((VertexExecutionOptions) executionOptions); - } else { - converter = new NebulaRowEdgeOutputFormatConverter((EdgeExecutionOptions) executionOptions); - } - String value = converter.createValue(record, executionOptions.getPolicy()); - if (value == null) { - return; - } - nebulaBufferedRow.putRow(value); - } - - /** - * commit batch insert statements - */ - private synchronized void commit() throws IOException { - graphClient.switchSpace(executionOptions.getGraphSpace()); - future = nebulaBatchExecutor.executeBatch(graphClient); - // clear waiting rows - numPendingRow.compareAndSet(executionOptions.getBatch(),0); - } - - /** - * execute the insert statement - * - * @param client Asynchronous graph client - */ - ListenableFuture executeBatch(AsyncGraphClientImpl client) { - String propNames = String.join(NebulaConstant.COMMA, executionOptions.getFields()); - String values = String.join(NebulaConstant.COMMA, nebulaBufferedRow.getRows()); - // construct insert statement - String exec = String.format(NebulaConstant.BATCH_INSERT_TEMPLATE, executionOptions.getDataType(), executionOptions.getLabel(), propNames, values); - // execute insert statement - ListenableFuture> execResult = client.execute(exec); - // define callback function - Futures.addCallback(execResult, new FutureCallback>() { - @Override - public void onSuccess(Optional integerOptional) { - if (integerOptional.isPresent()) { - if (integerOptional.get() == ErrorCode.SUCCEEDED) { - LOG.info("batch insert Succeed"); - } else { - LOG.error(String.format("batch insert Error: %d", - integerOptional.get())); - } - } else { - LOG.error("batch insert Error"); - } - } - - @Override - public void onFailure(Throwable throwable) { - LOG.error("batch insert Error"); - } - }); - nebulaBufferedRow.clean(); - return execResult; - } -``` - -由于 NebulaSink 的写入是批量、异步的，所以在最后业务结束关闭（`close`）资源之前需要将缓存中的批量数据提交且等待写入操作的完成，以防在写入提交之前提前关闭 NebulaGraph 的客户端，代码如下： - -```java - /** - * commit the batch write operator before release connection - */ - @Override - public final synchronized void close() throws IOException { - if(numPendingRow.get() > 0){ - commit(); - } - while(!future.isDone()){ - try { - Thread.sleep(100); - } catch (InterruptedException e) { - LOG.error("sleep interrupted, ", e); - } - } - - super.close(); - } - -``` - -## 应用实践 - -Flink 将处理完成的数据 sink 到 NebulaGraph 数据库时，需要将 Flink 数据流进行 map 转换成 NebulaSink 可接收的数据格式。自定义 NebulaSink 的使用方式是通过 `addSink` 的形式， - -用户可以按以下步骤使用 NebulaGraph Flink Connector 的 NebulaSink 向 NebulaGraph 写入数据： - -1. 将 Flink 数据转换成 NebulaSink 可以接受的数据格式。 -2. 将 `NebulaSinkFunction` 作为参数传给 `addSink` 方法来实现 Flink 数据流的写入。 - -在构造的 `NebulaSinkFunction` 中分别对客户端参数和执行参数作了如下配置： - -- `NebulaClientOptions` 需要配置： - - NebulaGraph 图数据库 Graph 服务的 IP 地址及端口号。如果有多个地址，使用英文逗号分隔。 - - NebulaGraph 图数据库的账号及其密码。 -- `VertexExecutionOptions` 需要配置： - - 需要写入点数据的 NebulaGraph 图数据库中的图空间名称。 - - 需要写入的 Tag（点类型）名称。 - - 需要写入的 Tag 属性。 - - 需要写入的点 VID 所在 Flink 数据流 Row 中的索引。 - - 单次写入 NebulaGraph 的数据量限值，默认为 2000。 -- `EdgeExecutionOptions` 需要配置： - - 需要写入边数据的 NebulaGraph 图数据库中的图空间名称。 - - 需要写入的 Edge type。 - - 需要写入的 Edge type 属性。 - - 需要写入的边起点 VID（src_Id）所在 Flink 数据流 Row 中的索引。 - - 需要写入的边终点 VID（dst_Id）所在 Flink 数据流 Row 中的索引。 - - 需要写入的边 rank 所在 Flink 数据流 Row 中的索引。如果不配置，则写入边数据时不带 rank 信息。 - - 单次写入的数据量限值，默认值为 2000。 - -假设需要写入点数据的 NebulaGraph 图数据库信息如下： - -- Graph 服务为本地单副本部署，使用默认端口 -- 图空间名称：`flinkSink` -- Tag：`player` -- Tag 属性：`name` 和 `age` - -以下为自定义 NebulaSink 的代码示例。 - -```xml -// 构造 NebulaGraph 的 Graph 服务客户端连接需要的参数 -NebulaClientOptions nebulaClientOptions = new NebulaClientOptions - .NebulaClientOptionsBuilder() - .setAddress("127.0.0.1:3699") - .build(); -NebulaConnectionProvider graphConnectionProvider = new NebulaGraphConnectionProvider(nebulaClientOptions); - -// 构造 NebulaGraph 写入点数据的操作参数 -List cols = Arrays.asList("name", "age") -ExecutionOptions sinkExecutionOptions = new VertexExecutionOptions.ExecutionOptionBuilder() - .setGraphSpace("flinkSink") - .setTag(tag) - .setFields(cols) - .setIdIndex(0) - .setBatch(2) - .builder(); - -// 将点数据写入 NebulaGraph -dataSource.addSink(nebulaSinkFunction); -``` - -### NebulaSink 示例程序 - -用户可以参考 GitHub 上的示例程序 [testSourceSink](https://github.com/vesoft-inc/nebula-java/tree/v1.0/examples/src/main/java/org/apache/flink/FlinkDemo.java) 编写自己的 Flink 应用程序。 - -以 testSourceSink 为例：该程序以 NebulaGraph 的图空间 `flinkSource` 作为 source，通过 Flink 读取进行 `map` 类型转换后的数据，再写入 NebulaGraph 另一个图空间 `flinkSink`，即 NebulaGraph 一个图空间 `flinkSource` 的数据流入另一个图空间 `flinkSink` 中。 diff --git a/docs-2.0/nebula-flink/nf-ug-customize-source.md b/docs-2.0/nebula-flink/nf-ug-customize-source.md deleted file mode 100644 index 05bb12da495..00000000000 --- a/docs-2.0/nebula-flink/nf-ug-customize-source.md +++ /dev/null @@ -1,105 +0,0 @@ -# 自定义 source (NebulaSource) - -NebulaGraph Flink Connector 支持以 `addSource` 或者 `createInput` 方式将 NebulaGraph 图数据库注册为 Flink 的数据源（source）。其中，通过 `addSource` 读取 source 数据得到的是 Flink 的 `DataStreamSource`，表示 DataStream 的起点，而通过 `createInput` 读取 source 数据得到的是 Flink 的 `DataSource`。`DataSource` 会作为进一步转换的数据集。`DataSource` 可以通过 `withParameters` 封装配置参数进行其他操作。 - -NebulaSource 的实现类图如下所示。 - -![NebulaGraph Flink Connector 的 source 实现类图](https://docs-cdn.nebula-graph.com.cn/nebula-java-tools-docs/fl-ug-001.png "source 实现类图") - -## `addSource` - -`addSource` 方式通过 `NebulaSourceFunction` 类实现，该类继承自 `RichSourceFunction` 并实现了以下方法： - -- `open`：准备 NebulaGraph 的连接信息，并获取 NebulaGraph 图数据库 Meta 服务和 Storage 服务的连接。 -- `close`：在数据读取完成后释放资源，并断开与 NebulaGraph 图数据库服务的连接。 -- `run`：开始读取数据，并将数据填充到 `sourceContext`。 -- `cancel`：取消 Flink 作业时调用这个方法以关闭资源。 - -## `createInput` - -`createInput` 方式通过 `NebulaInputFormat` 类实现，该类继承自 `RichInputFormat` 并实现了以下方法： - -- `openInputFormat`：准备 `inputFormat` 以获取连接。 -- `closeInputFormat`：数据读取完成后释放资源。断开与 NebulaGraph 图数据库服务的连接。 -- `open`：开始 `inputFormat` 的数据读取，将读取的数据转换为 Flink 的数据格式，构造迭代器。 -- `close`：在数据读取完成后打印读取日志。 -- `reachedEnd`：判断是否读取完成。 -- `nextRecord`：通过迭代器获取下一条数据。 - -## 应用实践 - -用户可以按以下步骤使用 NebulaGraph Flink Connector 读取 NebulaGraph 的图数据： - -1. 构造 `NebulaSourceFunction` 和 `NebulaOutputFormat`。 -2. 通过 Flink 的 `addSource` 或者 `createInput` 方式将 NebulaGraph 注册为数据源。 - -在构造的 `NebulaSourceFunction` 和 `NebulaOutputFormat` 中，对客户端参数和执行参数作如下配置： - -- `NebulaClientOptions` 需要配置： - - NebulaGraph 图数据库 Meta 服务的 IP 地址及端口号。如果有多个服务，使用逗号分隔，例如 `“ip1:port1,ip2:port2"`。 - - NebulaGraph 图数据库的账号及其密码。 -- `VertexExecutionOptions` 需要配置： - - 需要读取点数据的 NebulaGraph 图数据库中的图空间名称。 - - 需要读取的 Tag（点类型）名称。一次只能一个 Tag。 - - 要读取的 Tag 属性。 - - 是否读取指定 Tag 的所有属性，默认为 `false`。如果配置为 `true` 则 Tag 属性的配置无效。 - - 单次读取的数据量限值，默认为 2000 个点数据。 -- `EdgeExecutionOptions` 需要配置： - - 需要读取边数据的 NebulaGraph 图数据库中的图空间名称。 - - 需要读取的 Edge type。一次只能一个 Edge type。 - - 需要读取的 Edge type 属性。 - - 是否读取指定 Edge type 的所有属性，默认为 `false`。如果配置为 `true` 则 Edge type 属性的配置无效。 - - 单次读取的数据量限值，默认值为 2000 个边数据。 - -假设需要读取点数据的 NebulaGraph 图数据库信息如下： - -- Meta 服务为本地单副本部署，使用默认端口 -- 图空间名称：`flinkSource` -- Tag：`player` -- Tag 属性：`name` 和 `age` -- 单次最多读取 100 个点数据 - -以下为自定义 NebulaSource 的代码示例。 - -```xml -// 构造 NebulaGraph 客户端连接需要的参数 -NebulaClientOptions nebulaClientOptions = new NebulaClientOptions - .NebulaClientOptionsBuilder() - .setAddress("127.0.0.1:45500") - .build(); -// 创建 connectionProvider -NebulaConnectionProvider metaConnectionProvider = new NebulaMetaConnectionProvider(nebulaClientOptions); - -// 构造读取 NebulaGraph 数据需要的参数 -List cols = Arrays.asList("name", "age"); -VertexExecutionOptions sourceExecutionOptions = new VertexExecutionOptions.ExecutionOptionBuilder() - .setGraphSpace("flinkSource") - .setTag(tag) - .setFields(cols) - .setLimit(100) - .builder(); - -// 构造 NebulaInputFormat -NebulaInputFormat inputFormat = new NebulaInputFormat(metaConnectionProvider) - .setExecutionOptions(sourceExecutionOptions); - -// 方式 1 使用 createInput 方式将 NebulaGraph 注册为数据源 -DataSource dataSource1 = ExecutionEnvironment.getExecutionEnvironment() - .createInput(inputFormat); - -// 方式 2 使用 addSource 方式将 NebulaGraph 注册为数据源 -NebulaSourceFunction sourceFunction = new NebulaSourceFunction(metaConnectionProvider) - .setExecutionOptions(sourceExecutionOptions); - DataStreamSource dataSource2 = StreamExecutionEnvironment.getExecutionEnvironment() - .addSource(sourceFunction); -``` - -## 示例程序 - -用户可以参考 GitHub 上的示例程序 [testNebulaSource](https://github.com/vesoft-inc/nebula-java/tree/v1.0/examples/src/main/java/org/apache/flink/FlinkDemo.java) 编写自己的 Flink 应用程序。 - -以 testNebulaSource 为例：该程序以 NebulaGraph 图数据库为 source，以 Print 为 sink，从 NebulaGraph 图数据库中读取 59,671,064 条点数据后再打印。将该程序打包提交到 Flink 集群执行，结果如下图所示。 - -![Flink Dashboard 上显示的 testNebulaSource 执行结果](https://docs-cdn.nebula-graph.com.cn/nebula-java-tools-docs/fl-ug-002.png "testNebulaSource 执行结果") - -由上图可知，source 发送数据 59,671,064 条，sink 接收数据 59,671,064 条。 diff --git a/docs-2.0/nebula-flink/nf-ug-limitations.md b/docs-2.0/nebula-flink/nf-ug-limitations.md deleted file mode 100644 index f1d115a7955..00000000000 --- a/docs-2.0/nebula-flink/nf-ug-limitations.md +++ /dev/null @@ -1,14 +0,0 @@ -# 使用限制 - -本文描述 NebulaGraph Flink Connector 的一些使用限制。 - -## NebulaGraph 版本 - -NebulaGraph Flink Connector 目前仅支持 NebulaGraph v1.1.0 及以前的版本，不支持 NebulaGraph v2.0.0。 - -## 软件依赖 - -为保证 NebulaGraph Flink Connector 正常工作，确认机器上已经安装以下软件： - -- Apache Flink®：1.11 及以后版本 -- JDK 8 diff --git a/docs-2.0/nebula-flink/nf-ug-notes.md b/docs-2.0/nebula-flink/nf-ug-notes.md deleted file mode 100644 index 2f7c57f0208..00000000000 --- a/docs-2.0/nebula-flink/nf-ug-notes.md +++ /dev/null @@ -1,80 +0,0 @@ - -# 特殊说明 - -## Catalog - -Flink 1.11.0 之前，如果依赖 Flink 的 source/sink 读写外部数据源时，用户必须手动读取对应数据系统的 Schema（模式）。例如，如果要读写 NebulaGraph 的数据，则必须先保证明确地知晓 NebulaGraph 中的 Schema 信息。由此带来的问题是：当 NebulaGraph 中的 Schema 发生变化时，用户需要手动更新对应的 Flink 任务以保持类型匹配，否则，任何不匹配都会造成运行时报错使作业失败，整个操作冗余且繁琐，体验极差。 - -Flink 1.11.0 版本后，用户使用 Flink SQL 时可以自动获取表的 Schema 而不再需要输入 DDL，即 Flink 在不了解外部系统数据的 Schema 时仍能完成数据匹配。 - -目前 NebulaGraph Flink Connector 已经支持数据的读写，要实现 Schema 的匹配则需要为 Flink Connector 实现 Catalog 管理。但是，为了确保 NebulaGraph 中的数据安全，NebulaGraph Flink Connector 仅支持 Catalog 的读操作，不允许进行 Catalog 的修改和写入。 - -访问 NebulaGraph 指定类型的数据时，完整路径格式如下：`.` 或者 `.`。 - -具体使用方式如下： - -```java -// 其中 address 可以配置为多个 IP 地址，格式为 "ip1:port,ip2:port" -String catalogName = "testCatalog"; -String defaultSpace = "flinkSink"; -String username = "root"; -String password = "nebula"; -String address = "127.0.0.1:45500"; -String table = "VERTEX.player" - -// define NebulaGraph catalog -Catalog catalog = NebulaCatalogUtils.createNebulaCatalog(catalogName, defaultSpace, address, username, password); -// define Flink table environment -StreamExecutionEnvironment bsEnv = StreamExecutionEnvironment.getExecutionEnvironment(); -tEnv = StreamTableEnvironment.create(bsEnv); -// register customed NebulaGraph catalog -tEnv.registerCatalog(catalogName, catalog); -// use customed NebulaGraph catalog -tEnv.useCatalog(catalogName); - -// show graph spaces of nebula -String[] spaces = tEnv.listDatabases(); - -// // show tags and edges of NebulaGraph -tEnv.useDatabase(defaultSpace); -String[] tables = tEnv.listTables(); - -// check tage player exist in defaultSpace -ObjectPath path = new ObjectPath(defaultSpace, table); -assert catalog.tableExists(path) == true - -// get NebulaGraph tag schema -CatalogBaseTable table = catalog.getTable(new ObjectPath(defaultSpace, table)); -table.getSchema(); -``` - -关于 Catalog 接口的详细信息，参考 [Flink-table 代码](https://github.com/apache/flink/blob/master/flink-table/flink-table-common/src/main/java/org/apache/flink/table/catalog/Catalog.java)。 - -## Exactly-once - -Flink Connector 的 Exactly-once 是指 Flink 借助 checkpoint 机制保证每个输入事件只对最终结果影响一次，在数据处理过程中即使出现故障，也不会出现数据重复和丢失的情况。 - -为了提供端到端的 Exactly-once 语义，Flink 的外部数据系统也必须提供提交或回滚的方法，然后通过 Flink 的 checkpoint 机制协调。Flink 提供了实现端到端的 Exactly-once 的抽象，即实现二阶段提交的抽象类 `TwoPhaseCommitSinkFunction`。 - -要为数据输出端实现 Exactly-once，需要实现四个函数： - -- `beginTransaction`：在事务开始前，在目标文件系统的临时目录中创建一个临时文件，随后可以在数据处理时将数据写入此文件。 - -- `preCommit`：预提交阶段。在这个阶段，刷新文件到存储，关闭文件不再写入。为下一个 checkpoint 的任何后续文件写入启动一个新事务。 - -- `commit`：提交阶段。在这个阶段，将预提交阶段的文件原子地移动到真正的目标目录。二阶段提交过程会增加输出数据可见性的延迟。 - -- `abort`：终止阶段。在这个阶段，删除临时文件。 - -由以上函数可看出，Flink 的二阶段提交对外部数据源有要求，即 source 数据源必须具备重发功能，sink 数据池必须支持事务提交和幂等写。 - -NebulaGraph v1.1.0 虽然不支持事务，但其写入操作是幂等的，即同一条数据的多次写入结果是一致的。因此可以通过 checkpoint 机制实现 NebulaGraph Flink Connector 的 At-least-Once 机制，根据多次写入的幂等性可以间接实现 sink 的 Exactly-once。 - -要使用 NebulaSink 的容错性，请确保在 Flink 的执行环境中开启了 checkpoint 配置，代码如下所示。 - -```java -StreamExecutionEnvironment env = StreamExecutionEnvironment.getExecutionEnvironment(); -env.enableCheckpointing(10000) // checkpoint every 10000 msecs - .getCheckpointConfig() - .setCheckpointingMode(CheckpointingMode.AT_LEAST_ONCE); -``` diff --git a/docs-2.0/nebula-flink/nf-ug-toc.md b/docs-2.0/nebula-flink/nf-ug-toc.md deleted file mode 100644 index 35891238716..00000000000 --- a/docs-2.0/nebula-flink/nf-ug-toc.md +++ /dev/null @@ -1,7 +0,0 @@ -# 欢迎使用 NebulaGraph Flink Connector - -- [什么是 NebulaGraph Flink Connector](nf-ug-what-is-flink-connector.md) -- [使用限制](nf-ug-limitations.md) -- [自定义 source (NebulaSource)](nf-ug-customize-source.md) -- [自定义 sink (NebulaSink)](nf-ug-customize-sink.md) -- [特殊说明](nf-ug-notes.md) diff --git a/docs-2.0/nebula-flink/nf-ug-what-is-flink-connector.md b/docs-2.0/nebula-flink/nf-ug-what-is-flink-connector.md deleted file mode 100644 index 6373d830b0b..00000000000 --- a/docs-2.0/nebula-flink/nf-ug-what-is-flink-connector.md +++ /dev/null @@ -1,16 +0,0 @@ -# 什么是 NebulaGraph Flink Connector - -[NebulaGraph Flink Connector](https://github.com/vesoft-inc/nebula-java/tree/v1.0/tools "点击前往 GitHub 网站") 是一个自定义的 Flink 连接器，支持 Flink 从 NebulaGraph 图数据库中读取数据（source），或者将其他外部数据源读取的数据写入 NebulaGraph 图数据库（sink）。 - -用户可以将 NebulaGraph Flink Connector 应用于以下场景： - -- 在不同的 NebulaGraph 集群之间迁移数据。 -- 在同一个 NebulaGraph 集群内不同图空间之间迁移数据。 -- NebulaGraph 与其他数据源之间迁移数据。 - -用户可以参考以下文档使用 NebulaGraph Flink Connector： - -- [使用限制](nf-ug-limitations.md) -- [自定义 source (NebulaSource)](nf-ug-customize-source.md) -- [自定义 sink (NebulaSink)](nf-ug-customize-sink.md) -- [特殊说明](nf-ug-notes.md) diff --git a/docs-2.0/nebula-studio/quick-start/st-ug-plan-schema.md b/docs-2.0/nebula-studio/quick-start/st-ug-plan-schema.md index 983b7904099..fb9a52798b1 100644 --- a/docs-2.0/nebula-studio/quick-start/st-ug-plan-schema.md +++ b/docs-2.0/nebula-studio/quick-start/st-ug-plan-schema.md @@ -1,6 +1,6 @@ # 规划 Schema -在使用 Studio 之前，用户需要先根据 NebulaGraph 数据库的要求规划 Schema（模式）。 +在使用 Studio 之前，用户需要先根据{{nebula.name}}的要求规划 Schema（模式）。 Schema 至少要包含以下要素： @@ -8,7 +8,7 @@ * Edge type，以及每种 Edge type 的属性。 -用户可以下载 NebulaGraph 示例数据集 [basketballplayer](https://docs-cdn.nebula-graph.com.cn/dataset/dataset.zip "点击下载") ，本文将通过该示例说明如何规划 Schema。 +用户可以下载{{nebula.name}}示例数据集 [basketballplayer](https://docs-cdn.nebula-graph.com.cn/dataset/dataset.zip "点击下载") ，本文将通过该示例说明如何规划 Schema。 下表列出了 Schema 要素。 diff --git a/docs-2.0/nebula-studio/troubleshooting/st-ug-config-server-errors.md b/docs-2.0/nebula-studio/troubleshooting/st-ug-config-server-errors.md index ad63673ebf8..592b405c615 100644 --- a/docs-2.0/nebula-studio/troubleshooting/st-ug-config-server-errors.md +++ b/docs-2.0/nebula-studio/troubleshooting/st-ug-config-server-errors.md @@ -10,22 +10,22 @@ ### 第 1 步。确认 **Host** 字段的格式是否正确 -必须填写 NebulaGraph 图数据库 Graph 服务的 IP 地址（`graph_server_ip`）和端口。如果未做修改，端口默认为 `9669`。即使 NebulaGraph 与 Studio 都部署在当前机器上，用户也必须使用本机 IP 地址，而不能使用 `127.0.0.1`、`localhost` 或者 `0.0.0.0`。 +必须填写{{nebula.name}}图数据库 Graph 服务的 IP 地址（`graph_server_ip`）和端口。如果未做修改，端口默认为 `9669`。即使{{nebula.name}}与 Studio 都部署在当前机器上，用户也必须使用本机 IP 地址，而不能使用 `127.0.0.1`、`localhost` 或者 `0.0.0.0`。 ### 第 2 步。确认 **用户名** 和 **密码** 是否正确 -如果 NebulaGraph 没有开启身份认证，用户可以填写任意字符串登录。 +如果{{nebula.name}}没有开启身份认证，用户可以填写任意字符串登录。 如果已经开启身份认证，用户必须使用分配的账号登录。 -### 第 3 步。确认 NebulaGraph 服务是否正常 +### 第 3 步。确认{{nebula.name}}服务是否正常 -检查 NebulaGraph 服务状态。关于查看服务的操作： +检查{{nebula.name}}服务状态。关于查看服务的操作： -- 如果在 Linux 服务器上通过编译部署的 NebulaGraph，参考[查看 NebulaGraph 服务](../../4.deployment-and-installation/2.compile-and-install-nebula-graph/deploy-nebula-graph-cluster.md "点击查看 NebulaGraph 内核文档")。 -- 如果使用 Docker Compose 部署和 RPM 部署的 NebulaGraph，参考[查看 NebulaGraph 服务状态和端口](../deploy-connect/st-ug-deploy.md "点击前往 GitHub 网站")。 +- 如果在 Linux 服务器上通过编译部署的 NebulaGraph，参考[查看{{nebula.name}}服务](../../4.deployment-and-installation/2.compile-and-install-nebula-graph/deploy-nebula-graph-cluster.md "点击查看{{nebula.name}}内核文档")。 +- 如果使用 Docker Compose 部署和 RPM 部署的 NebulaGraph，参考[查看{{nebula.name}}服务状态和端口](../deploy-connect/st-ug-deploy.md "点击前往 GitHub 网站")。 -如果 NebulaGraph 服务正常，进入第 4 步继续排查问题。否则，请重启 NebulaGraph 服务。 +如果{{nebula.name}}服务正常，进入第 4 步继续排查问题。否则，请重启{{nebula.name}}服务。 !!! Note @@ -33,11 +33,11 @@ ### 第 4 步。确认 Graph 服务的网络连接是否正常 -在 Studio 机器上运行命令（例如 `telnet 9669`）确认 NebulaGraph 的 Graph 服务网络连接是否正常。 +在 Studio 机器上运行命令（例如 `telnet 9669`）确认{{nebula.name}}的 Graph 服务网络连接是否正常。 如果连接失败，则按以下要求检查： -- 如果 Studio 与 NebulaGraph 在同一台机器上，检查端口是否已暴露。 -- 如果两者不在同一台机器上，检查 NebulaGraph 服务器的网络配置，例如，防火墙、网关以及端口。 +- 如果 Studio 与{{nebula.name}}在同一台机器上，检查端口是否已暴露。 +- 如果两者不在同一台机器上，检查{{nebula.name}}服务器的网络配置，例如，防火墙、网关以及端口。 -如果按上述步骤排查后仍无法连接 NebulaGraph 服务，请前往 [NebulaGraph 官方论坛](https://discuss.nebula-graph.com.cn/ "点击前往 NebulaGraph 官方论坛")咨询。 +如果按上述步骤排查后仍无法连接{{nebula.name}}服务，请前往 [{{nebula.name}}官方论坛](https://discuss.nebula-graph.com.cn/ "点击前往{{nebula.name}}官方论坛")咨询。 diff --git a/docs-2.0/nebula-studio/troubleshooting/st-ug-connection-errors.md b/docs-2.0/nebula-studio/troubleshooting/st-ug-connection-errors.md index 8039d0b66e8..dc979e69051 100644 --- a/docs-2.0/nebula-studio/troubleshooting/st-ug-connection-errors.md +++ b/docs-2.0/nebula-studio/troubleshooting/st-ug-connection-errors.md @@ -52,4 +52,4 @@ - 如果浏览器与 Studio 在同一台机器上，检查端口是否已暴露。 - 如果两者不在同一台机器上，检查 Studio 所在机器的网络配置，例如，防火墙、网关以及端口。 -如果按上述步骤排查后仍无法访问 Studio，请前往 [NebulaGraph 官方论坛](https://discuss.nebula-graph.com.cn/ "点击前往 NebulaGraph 官方论坛")咨询。 +如果按上述步骤排查后仍无法访问 Studio，请前往 [{{nebula.name}}官方论坛](https://discuss.nebula-graph.com.cn/ "点击前往{{nebula.name}}官方论坛")咨询。 diff --git a/docs-2.0/nebula-studio/troubleshooting/st-ug-faq.md b/docs-2.0/nebula-studio/troubleshooting/st-ug-faq.md index 1e6cf6064aa..697183e2d57 100644 --- a/docs-2.0/nebula-studio/troubleshooting/st-ug-faq.md +++ b/docs-2.0/nebula-studio/troubleshooting/st-ug-faq.md @@ -4,7 +4,7 @@ 如果发现无法使用某个功能，建议按以下步骤排除问题： -1. 确认 NebulaGraph 是最新版本。如果使用 Docker Compose 部署 NebulaGraph 数据库，建议运行 `docker-compose pull && docker-compose up -d` 拉取最新的 Docker 镜像，并启动容器。 +1. 确认{{nebula.name}}是最新版本。如果使用 Docker Compose 部署{{nebula.name}}数据库，建议运行 `docker-compose pull && docker-compose up -d` 拉取最新的 Docker 镜像，并启动容器。 2. 确认 Studio 是最新版本。详细信息参考[版本更新](../../20.appendix/release-notes/studio-release-note.md)。 3. 搜索[论坛](https://discuss.nebula-graph.com.cn/)或 GitHub 的 [nebula](https://github.com/vesoft-inc/nebula) 和 [nebula-web-docker](https://github.com/vesoft-inc/nebula-web-docker/issues) 项目，确认是否已经有类似的问题。 4. 如果上述操作均未解决问题，欢迎在论坛上提交问题。 diff --git a/docs-2.0/reuse/source_connect-to-nebula-graph.md b/docs-2.0/reuse/source_connect-to-nebula-graph.md index 9884a1bf20e..effcf2f58fd 100644 --- a/docs-2.0/reuse/source_connect-to-nebula-graph.md +++ b/docs-2.0/reuse/source_connect-to-nebula-graph.md @@ -4,21 +4,21 @@ !!! caution - 首次连接到 NebulaGraph 后，必须先[注册 Storage 服务](https://docs.nebula-graph.com.cn/{{nebula.release}}/2.quick-start/3.quick-start-on-premise/3.1add-storage-hosts/)，才能正常查询数据。 + 首次连接到{{nebula.name}}后，必须先[注册 Storage 服务](https://docs.nebula-graph.com.cn/{{nebula.release}}/2.quick-start/3.quick-start-on-premise/3.1add-storage-hosts/)，才能正常查询数据。 -NebulaGraph 支持多种类型的客户端，包括命令行客户端、可视化界面客户端和流行编程语言客户端。详情参见[客户端列表](https://docs.nebula-graph.com.cn/{{nebula.release}}/14.client/1.nebula-client/)。 +{{nebula.name}}支持多种类型的客户端，包括命令行客户端、可视化界面客户端和流行编程语言客户端。详情参见[客户端列表](https://docs.nebula-graph.com.cn/{{nebula.release}}/14.client/1.nebula-client/)。 ## 前提条件 -- NebulaGraph 服务已[启动](https://docs.nebula-graph.com.cn/{{nebula.release}}/4.deployment-and-installation/manage-service/)。 +-{{nebula.name}}服务已[启动](https://docs.nebula-graph.com.cn/{{nebula.release}}/4.deployment-and-installation/manage-service/)。 -- 运行 Nebula Console 的机器和运行 NebulaGraph 的服务器网络互通。 +- 运行 Nebula Console 的机器和运行{{nebula.name}}的服务器网络互通。 -- Nebula Console 的版本兼容 NebulaGraph 的版本。 +- Nebula Console 的版本兼容{{nebula.name}}的版本。 !!! note - 版本相同的 Nebula Console 和 NebulaGraph 兼容程度最高，版本不同的 Nebula Console 连接 NebulaGraph 时，可能会有兼容问题，或者无法连接并报错`incompatible version between client and server`。 + 版本相同的 Nebula Console 和{{nebula.name}}兼容程度最高，版本不同的 Nebula Console 连接{{nebula.name}}时，可能会有兼容问题，或者无法连接并报错`incompatible version between client and server`。 ## 操作步骤 @@ -70,14 +70,14 @@ NebulaGraph 支持多种类型的客户端，包括命令行客户端、可视 | 参数 | 说明 | | - | - | | `-h/-help` | 显示帮助菜单。 | - | `-addr/-address` | 设置要连接的 Graph 服务的 IP 地址。默认地址为 127.0.0.1。| + | `-addr/-address` | 设置要连接的 Graph 服务的 IP 地址。默认地址为 127.0.0.1。| | `-P/-port` | 设置要连接的 Graph 服务的端口。默认端口为 9669。| - | `-u/-user` | 设置 NebulaGraph 账号的用户名。未启用身份认证时，可以使用任意已存在的用户名（默认为`root`）。 | + | `-u/-user` | 设置{{nebula.name}}账号的用户名。未启用身份认证时，可以使用任意已存在的用户名（默认为`root`）。 | | `-p/-password` | 设置用户名对应的密码。未启用身份认证时，密码可以填写任意字符。 | | `-t/-timeout` | 设置整数类型的连接超时时间。单位为毫秒，默认值为 120。 | | `-e/-eval` | 设置字符串类型的 nGQL 语句。连接成功后会执行一次该语句并返回结果，然后自动断开连接。 | | `-f/-file` | 设置存储 nGQL 语句的文件的路径。连接成功后会执行该文件内的 nGQL 语句并返回结果，执行完毕后自动断开连接。 | - | `-enable_ssl` | 连接 NebulaGraph 时使用 SSL 加密。 | + | `-enable_ssl` | 连接{{nebula.name}}时使用 SSL 加密。 | | `-ssl_root_ca_path` | 指定 CA 证书的存储路径。 | | `-ssl_cert_path` | 指定 CRT 证书的存储路径。 | | `-ssl_private_key_path` | 指定私钥文件的存储路径。 | 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 795a6e5c35c..4be7a0c9f46 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 @@ -1,8 +1,8 @@ -RPM 和 DEB 是 Linux 系统下常见的两种安装包格式，本文介绍如何使用 RPM 或 DEB 文件在一台机器上快速安装 NebulaGraph。 +RPM 和 DEB 是 Linux 系统下常见的两种安装包格式，本文介绍如何使用 RPM 或 DEB 文件在一台机器上快速安装{{nebula.name}}。 !!! note - 部署 NebulaGraph 集群的方式参见[使用 RPM/DEB 包部署集群](https://docs.nebula-graph.com.cn/{{nebula.release}}/2.quick-start/3.quick-start-on-premise/3.1add-storage-hosts/)。 + 部署{{nebula.name}}集群的方式参见[使用 RPM/DEB 包部署集群](https://docs.nebula-graph.com.cn/{{nebula.release}}/2.quick-start/3.quick-start-on-premise/3.1add-storage-hosts/)。 {{ ent.ent_begin }} @@ -20,9 +20,9 @@ RPM 和 DEB 是 Linux 系统下常见的两种安装包格式，本文介绍如 !!! note - - 当前仅支持在 Linux 系统下安装 NebulaGraph，且仅支持 CentOS 7.x、CentOS 8.x、Ubuntu 16.04、Ubuntu 18.04、Ubuntu 20.04 操作系统。 + - 当前仅支持在 Linux 系统下安装{{nebula.name}}，且仅支持 CentOS 7.x、CentOS 8.x、Ubuntu 16.04、Ubuntu 18.04、Ubuntu 20.04 操作系统。 - - 如果用户使用的是国产化的 Linux 操作系统，请[安装企业版 NebulaGraph](https://www.nebula-graph.com.cn/contact)。 + - 如果用户使用的是国产化的 Linux 操作系统，请[安装企业版{{nebula.name}}](https://www.nebula-graph.com.cn/contact)。 ### 阿里云 OSS 下载 @@ -99,29 +99,7 @@ RPM 和 DEB 是 Linux 系统下常见的两种安装包格式，本文介绍如 wget https://oss-cdn.nebula-graph.com.cn/package/nightly/2021.11.24/nebula-graph-2021.11.24-nightly.ubuntu1804.amd64.deb.sha256sum.txt ``` - - -## 安装 NebulaGraph +## 安装{{nebula.name}} - 安装 RPM 包 @@ -129,7 +107,7 @@ RPM 和 DEB 是 Linux 系统下常见的两种安装包格式，本文介绍如 $ sudo rpm -ivh --prefix= ``` - `--prefix`为可选项，用于指定安装路径。如不设置，系统会将 NebulaGraph 安装到默认路径`/usr/local/nebula/`。 + `--prefix`为可选项，用于指定安装路径。如不设置，系统会将{{nebula.name}}安装到默认路径`/usr/local/nebula/`。 例如，要在默认路径下安装{{nebula.release}}版本的 RPM 包，运行如下命令： @@ -144,7 +122,7 @@ RPM 和 DEB 是 Linux 系统下常见的两种安装包格式，本文介绍如 ``` !!! note - 使用 DEB 包安装 NebulaGraph 时不支持自定义安装路径。默认安装路径为`/usr/local/nebula/`。 + 使用 DEB 包安装{{nebula.name}}时不支持自定义安装路径。默认安装路径为`/usr/local/nebula/`。 例如安装{{nebula.release}}版本的 DEB 包： @@ -159,5 +137,5 @@ RPM 和 DEB 是 Linux 系统下常见的两种安装包格式，本文介绍如 {{ ent.ent_end }} -- [启动 NebulaGraph](https://docs.nebula-graph.com.cn/{{nebula.release}}/2.quick-start/3.quick-start-on-premise/5.start-stop-service/) -- [连接 NebulaGraph](https://docs.nebula-graph.com.cn/{{nebula.release}}/2.quick-start/3.quick-start-on-premise/3.connect-to-nebula-graph/) +- [启动{{nebula.name}}](https://docs.nebula-graph.com.cn/{{nebula.release}}/2.quick-start/3.quick-start-on-premise/5.start-stop-service/) +- [连接{{nebula.name}}](https://docs.nebula-graph.com.cn/{{nebula.release}}/2.quick-start/3.quick-start-on-premise/3.connect-to-nebula-graph/) diff --git a/docs-2.0/reuse/source_manage-service.md b/docs-2.0/reuse/source_manage-service.md index 86cac43c224..678a8a75d95 100644 --- a/docs-2.0/reuse/source_manage-service.md +++ b/docs-2.0/reuse/source_manage-service.md @@ -1,4 +1,4 @@ -NebulaGraph 支持通过脚本管理服务。 +{{nebula.name}}支持通过脚本管理服务。 {{ ent.ent_begin }} @@ -49,7 +49,7 @@ $ sudo /usr/local/nebula/scripts/nebula.service !!! note - - 安装 NebulaGraph 企业版后，systemd 所需的`.service`文件在安装目录的`etc/unit`目录内，使用 RPM/DEB 包安装的 NebulaGraph，会自动将这些`.service`文件放入`/usr/lib/systemd/system`目录内，并且`ExecStart`也会根据指定的 NebulaGraph 安装路径进行生成，因此可以直接使用`systemctl`命令。 + - 安装{{nebula.name}}企业版后，systemd 所需的`.service`文件在安装目录的`etc/unit`目录内，使用 RPM/DEB 包安装的 NebulaGraph，会自动将这些`.service`文件放入`/usr/lib/systemd/system`目录内，并且`ExecStart`也会根据指定的{{nebula.name}}安装路径进行生成，因此可以直接使用`systemctl`命令。 - 对于使用企业版 Dashboard 安装的企业版 NebulaGraph，不支持使用`systemctl`管理服务。 @@ -74,7 +74,7 @@ $ systemctl +- [连接{{nebula.name}}](https://docs.nebula-graph.com.cn/{{nebula.release}}/2.quick-start/3.quick-start-on-premise/3.connect-to-nebula-graph/) diff --git a/docs-2.0/reuse/source_ngql_for_quick_start.md b/docs-2.0/reuse/source_ngql_for_quick_start.md index 92e482d8750..c4cba6dc7a9 100644 --- a/docs-2.0/reuse/source_ngql_for_quick_start.md +++ b/docs-2.0/reuse/source_ngql_for_quick_start.md @@ -2,9 +2,9 @@ ### 图空间和 Schema -一个 NebulaGraph 实例由一个或多个图空间组成。每个图空间都是物理隔离的，用户可以在同一个实例中使用不同的图空间存储不同的数据集。 +一个{{nebula.name}}实例由一个或多个图空间组成。每个图空间都是物理隔离的，用户可以在同一个实例中使用不同的图空间存储不同的数据集。 -![NebulaGraph and graph spaces](https://docs-cdn.nebula-graph.com.cn/docs-2.0/2.quick-start/nebula-graph-instance-and-graph-spaces.png) +![{{nebula.name}} and graph spaces](https://docs-cdn.nebula-graph.com.cn/docs-2.0/2.quick-start/nebula-graph-instance-and-graph-spaces.png) 为了在图空间中插入数据，需要为图数据库定义一个 Schema。NebulaGraph 的 Schema 是由如下几部分组成。 @@ -25,7 +25,7 @@ !!! caution - NebulaGraph 中执行如下创建和修改操作，是异步实现的。要在**下一个**心跳周期之后才能生效，否则访问会报错。为确保数据同步，后续操作能顺利进行，请等待 2 个心跳周期（20 秒）。 + 在{{nebula.name}}中，下列创建和修改操作是异步实现的。要在**下一个**心跳周期之后才能生效，否则访问会报错。为确保数据同步，后续操作能顺利进行，请等待 2 个心跳周期（20 秒）。 - `CREATE SPACE` - `CREATE TAG` @@ -230,7 +230,7 @@ nebula> CREATE EDGE serve(start_year int, end_year int); - [LOOKUP](https://docs.nebula-graph.com.cn/{{nebula.release}}/3.ngql-guide/7.general-query-statements/5.lookup/) 语句是基于[索引](#_12)的，和`WHERE`子句一起使用，查找符合特定条件的数据。 -- [MATCH](https://docs.nebula-graph.com.cn/{{nebula.release}}/3.ngql-guide/7.general-query-statements/2.match/) 语句是查询图数据最常用的，可以灵活的描述各种图模式，但是它依赖[索引](#_12)去匹配 NebulaGraph 中的数据模型，性能也还需要调优。 +- [MATCH](https://docs.nebula-graph.com.cn/{{nebula.release}}/3.ngql-guide/7.general-query-statements/2.match/) 语句是查询图数据最常用的，可以灵活的描述各种图模式，但是它依赖[索引](#_12)去匹配{{nebula.name}}中的数据模型，性能也还需要调优。 ### nGQL 语法 diff --git a/docs-2.0/spark-connector/reader/sc-ug-reader-example.md b/docs-2.0/spark-connector/reader/sc-ug-reader-example.md deleted file mode 100644 index 1daee646279..00000000000 --- a/docs-2.0/spark-connector/reader/sc-ug-reader-example.md +++ /dev/null @@ -1,134 +0,0 @@ -# NebulaGraph Spark Connector Reader 应用示例 - -本文以一个示例说明如何使用 NebulaGraph Spark Connector Reader 读取 NebulaGraph 的点和边数据。 - -## 前提条件 - -使用 NebulaGraph Spark Connector Reader 前，用户需要确认以下信息： - -- 机器上已经安装了以下软件： - - Apache Spark™ 2.3.0 及更高版本 - - Scala - - Java：1.8 - -- 已经成功编译 NebulaGraph Spark Connector Reader，并已经将 `nebula-spark-1.x.y.jar` 复制到本地 Maven 库。详细信息参考[编译 NebulaGraph Spark Connector](../sc-ug-compile.md) - -- 已经获取 NebulaGraph 数据库的以下信息： - - 图空间名称和分区数量（如果创建图空间时未设置分区数量，则默认使用 100） - - Tag 和 Edge type 的名称以及属性 - - Meta 服务所在机器的 IP 地址及端口号 - -## 操作步骤 - -参考以下步骤使用 NebulaGraph Spark Connector Reader： - -1. 在 Maven 项目的 `pom.xml` 文件中加入 `nebula-spark` 依赖。 - - ```xml - - com.vesoft - nebula-spark - 1.x.y - - ``` - - !!! Note - - `` 建议配置为最新发布的 NebulaGraph Java Client 版本号。用户可以在 [nebula-java 仓库的 Releases 页面](https://github.com/vesoft-inc/nebula-java/releases "点击前往 GitHub 网站") 查看最新的 v1.x 版本。 - -1. 构建 `SparkSession` 类。这是 Spark SQL 的编码入口。 - - ``` - val sparkConf = new SparkConf - sparkConf - .set("spark.serializer", "org.apache.spark.serializer.KryoSerializer") - .registerKryoClasses(Array[Class[_]](classOf[TCompactProtocol])) - val sparkSession = SparkSession - .builder() - .config(sparkConf) - .master("local") - .getOrCreate() - ``` - - 其中，关于 `.master()` 的设置，参考 [Spark 配置的 Master URLs](https://spark.apache.org/docs/latest/submitting-applications.html#master-urls "点击前往 Spark 文档中心")。 - -2. 按以下说明修改配置，利用 Spark 读取 NebulaGraph 的点或者边数据，得到 DataFrame。 - - ```shell - // 读取 NebulaGraph 的点数据 - val vertexDataset: Dataset[Row] = - sparkSession.read - .nebula("127.0.0.1:45500", "spaceName", "100") - .loadVerticesToDF("tag", "*") - vertexDataset.show() - - // 读取 NebulaGraph 的边数据 - val edgeDataset: Dataset[Row] = - sparkSession.read - .nebula("127.0.0.1:45500", "spaceName", "100") - .loadEdgesToDF("edge", "field1,field2") - edgeDataset.show() - ``` - - 其中配置说明如下： - - - `nebula(, , )`，所有参数均为必需参数。 - - - ``：配置为 NebulaGraph 数据库 metad 服务所在的服务器地址及端口，如果有多个 metad 服务复本，则配置为多个地址，以英文逗号分隔，例如 `"ip1:45500,ip2:45500"`。默认端口号为 45500。 - - ``: 配置为 NebulaGraph 的图空间名称。 - - ``：设置 Spark 的分区数量。建议设置为 NebulaGraph 中创建图空间时指定的 `partitionNum`，以确保一个 Spark 分区读取 NebulaGraph 图空间中一个分区的数据。如果在创建 NebulaGraph 图空间时未指定分区数量，则使用默认值 100。 - - - `loadVerticesToDF(, )`，所有参数均为必需参数。 - - - ``：配置为指定 NebulaGraph 图空间中某个 Tag 的名称。 - - ``：配置为指定 Tag 的属性名称，不允许为空。如果一个 Tag 有多个属性，则以英文逗号分隔。如果指定了属性名称，表示只读取指定的属性。如果配置为 `*`，表示读取指定 Tag 的所有属性。 - - - `loadEdgesToDF(, )`，所有参数均为必需参数。 - - - ``：配置为指定 NebulaGraph 图空间中某个 Edge type 的名称。 - - ``：配置为指定 Edge type 的属性名称，不允许为空。如果一个 Edge type 有多个属性，则以英文逗号分隔。如果指定了属性名称，表示只读取指定的属性，如果配置为 `*` 表示读取指定 Edge type 的所有属性。 - -以下为读取结果示例。 - -- 读取点数据 - - ``` - 20/10/27 08:51:04 INFO DAGScheduler: Job 0 finished: show at Main.scala:61, took 1.873141 s - +---------+----------+---+ - |_vertexId| name|age| - +---------+----------+---+ - | 0| Tom55322| 19| - | 84541440|Tom4152378| 27| - | 67829760| Tom24006| 10| - | 51118080| Tom84165| 62| - | 34406400| Tom17308| 1| - | 17694720| Tom73089| 56| - | 983040| Tom82311| 95| - | 68812800| Tom61046| 93| - | 52101120| Tom52116| 45| - | 18677760| Tom4773| 18| - | 1966080| Tom25979| 20| - | 69795840| Tom92575| 9| - | 53084160| Tom48645| 29| - | 36372480| Tom20594| 86| - | 19660800| Tom27071| 32| - | 2949120| Tom630| 61| - | 70778880| Tom82319| 78| - | 37355520| Tom38207| 31| - | 20643840| Tom56158| 73| - | 3932160| Tom36933| 59| - +---------+----------+---+ - only showing top 20 rows - ``` - -- 读取边数据 - - ``` - 20/10/27 08:56:57 INFO DAGScheduler: Job 4 finished: show at Main.scala:71, took 0.085975 s - +------+------+----------+--------+ - |_srcId|_dstId|start_year|end_year| - +------+------+----------+--------+ - | 101| 201| 2002| 2020| - | 102| 201| 2002| 2015| - +------+------+----------+--------+ - ``` diff --git a/docs-2.0/spark-connector/reader/sc-ug-what-is-reader.md b/docs-2.0/spark-connector/reader/sc-ug-what-is-reader.md deleted file mode 100644 index 9d5bd1749ec..00000000000 --- a/docs-2.0/spark-connector/reader/sc-ug-what-is-reader.md +++ /dev/null @@ -1,49 +0,0 @@ -# 什么是 NebulaGraph Spark Connector Reader - -NebulaGraph Spark Connector Reader 是 NebulaGraph Spark Connector 的组成部分，提供了 Spark SQL 接口，用户可以使用 Spark SQL 接口编程读取 NebulaGraph 图数据，单次读取一个 Tag 或 Edge type 的数据，并将读取的结果组装成 Spark 的 DataFrame。读出的 DataFrame 可以通过 NebulaGraph Spark Connector Writer 写入 NebulaGraph 数据库或实现不同图空间之间的数据迁移。 - -## NebulaGraph Spark Connector Reader 实现原理 - -Spark SQL 是 Spark 中用于处理结构化数据的一个编程模块。它提供了一个称为 DataFrame 的编程抽象，并且可以充当分布式 SQL 查询引擎。Spark SQL 允许用户自定义数据源，支持对外部数据源进行扩展。通过 Spark SQL 读取到的数据格式是以命名列方式组织的分布式数据集 DataFrame，而且 Spark SQL 提供了众多 API 方便用户对 DataFrame 进行计算和转换，能对多种数据源使用 DataFrame 接口。 - -### 接口 - -Spark 使用 `org.apache.spark.sql` 调用外部数据源包。以下为 Spark SQL 提供的扩展数据源相关的接口。 - -- 基本接口，包括： - - - `BaseRelation`: 表示具有已知 Schema 的元组的集合。所有继承了 `BaseRelation` 的子类都必须生成 `StructType` 格式的 Schema。换句话说，`BaseRelation` 定义了从数据源中读取的数据在 Spark SQL 的 DataFrame 中存储的数据格式。 - - - `RelationProvider`: 获取参数列表，根据给定的参数返回一个新的 `BaseRelation`。 - - - `DataSourceRegister`: “注册数据源”的简称，在使用数据源时不用写数据源的全限定类名，而只需要写自定义的 `shortName` 即可。 - -- Providers 接口，包括： - - - `RelationProvider`：从指定数据源中生成自定义的 `relation`。`RelationProvider#createRelation` 会基于给定的参数生成新的 `relation`。 - - - `SchemaRelationProvider`：可以基于给定的参数和给定的 Schema 信息生成新的 `relation`。 - -- RDD 接口，包括： - - - `RDD[InternalRow]`: 从数据源中扫描出来后，需要构造成 `RDD[Row]`。 - -NebulaGraph Spark Connector Reader 根据 NebulaGraph 的数据源自定义了上述部分方法，从而实现自定义 Spark 外部数据源。 - -### 实现类图 - -在 NebulaGraph Spark Connector Reader 中，作为 Spark SQL 的外部数据源，NebulaGraph 通过 `sparkSession.read` 的形式读取数据。该功能实现的类图展示如下图所示。 - -![NebulaGraph Spark Connector Reader 实现类图](https://docs-cdn.nebula-graph.com.cn/nebula-java-tools-docs/sc-ug-001.png "NebulaGraph Spark Connector Reader 实现类图") - -处理流程如下： - -1. 定义数据源 `NebulaRelationProvider`：继承 `RelationProvider` 自定义 `relation`，继承 `DataSourceRegister` 注册外部数据源。 - -2. 定义 `NebulaRelation`，实现 NebulaGraph 图数据 Schema 的获取和数据转换方法。在 `NebulaRelation#getSchema` 方法中连接 NebulaGraph 的 Meta 服务获取配置的返回字段对应的 Schema 信息。 - -3. 定义 `NebulaRDD` 读取 NebulaGraph 图数据。其中，`NebulaRDD#compute` 方法定义了如何读取 NebulaGraph 图数据，主要涉及到扫描 NebulaGraph 图数据、将读到的 NebulaGraph 的行（Row）数据转换为 Spark 的 `InternalRow` 数据，以 `InternalRow` 组成 RDD 的一行，其中每一个 `InternalRow` 表示 NebulaGraph 中的一行数据，最终通过分区迭代的形式读取 NebulaGraph 所有数据并组装成最终的 DataFrame 结果数据。 - -## 应用示例 - -参考 [NebulaGraph Spark Connector Reader 应用示例](sc-ug-reader-example.md)。 diff --git a/docs-2.0/spark-connector/sc-ug-compile.md b/docs-2.0/spark-connector/sc-ug-compile.md deleted file mode 100644 index aabb49a8c11..00000000000 --- a/docs-2.0/spark-connector/sc-ug-compile.md +++ /dev/null @@ -1,45 +0,0 @@ -# 编译 NebulaGraph Spark Connector - -按以下步骤编译 NebulaGraph Spark Connector v1.x： - -1. 克隆 `nebula-java` 源代码。 - - ```bash - git clone -b v1.0 https://github.com/vesoft-inc/nebula-java.git - ``` - -2. 切换到 `nebula-java` 目录，并打包 NebulaGraph Java 1.x。 - - ```bash - cd nebula-java - mvn clean install -Dgpg.skip -Dmaven.javadoc.skip=true -Dmaven.test.skip=true - ``` - -3. 进入 `tools/nebula-spark` 目录，并编译 NebulaGraph Spark Connector v1.x。 - - ```bash - cd nebula-java/tools/nebula-spark - mvn clean package -Dgpg.skip -Dmaven.javadoc.skip=true -Dmaven.test.skip=true - ``` - -编译成功后，用户可以在当前目录里看到如下目录结构。在 `target` 目录下，用户可以看到 `nebula-spark-1.x.y.jar` 文件。将这个文件复制到本地 Maven 库以下路径 `com/vesoft/nebula-spark/`。 - -```text -├── README.md -├── pom.xml -├── src -│ └── main -└── target - ├── classes - ├── classes.-1146581144.timestamp - ├── generated-sources - ├── maven-archiver - ├── maven-status - ├── nebula-spark-1.x.y-tests.jar - ├── nebula-spark-1.x.y.jar - └── original-nebula-spark-1.x.y.jar -``` - -!!! Note - - JAR 文件版本号会因 NebulaGraph Java Client 的发布版本而异。用户可以在 [nebula-java 仓库的 Releases 页面](https://github.com/vesoft-inc/nebula-java/releases "点击前往 GitHub 网站") 查看最新的 v1.x 版本。 diff --git a/docs-2.0/spark-connector/sc-ug-limitations.md b/docs-2.0/spark-connector/sc-ug-limitations.md deleted file mode 100644 index 5aa307a130e..00000000000 --- a/docs-2.0/spark-connector/sc-ug-limitations.md +++ /dev/null @@ -1,22 +0,0 @@ -# 使用限制 - -本文描述 NebulaGraph Spark Connector 的使用限制。 - -## NebulaGraph 版本 - -NebulaGraph Spark Connector 目前仅支持 NebulaGraph v1.0.1 和 v1.1.0，不支持 NebulaGraph v2.0。 - -## 软件依赖 - -NebulaGraph Spark Connector 默认依赖以下软件： - -- Apache Spark™ 2.3.0 及更高版本 -- Scala -- Java：1.8 - -## 功能限制 - -目前 NebulaGraph Spark Connector 在使用时有以下功能限制： - -- Reader：目前无法用于读取 NebulaGraph 中属性为空的点和边数据。 -- Writer：用于向 NebulaGraph 写入边数据时，作为起点与终点 VID 的数据必须同时为整数型或非数值型。 diff --git a/docs-2.0/spark-connector/sc-ug-toc.md b/docs-2.0/spark-connector/sc-ug-toc.md deleted file mode 100644 index 35b30705ab8..00000000000 --- a/docs-2.0/spark-connector/sc-ug-toc.md +++ /dev/null @@ -1,11 +0,0 @@ -# NebulaGraph Spark Connector 用户手册 - -- [什么是 NebulaGraph Spark Connector](sc-ug-what-is-spark-connector.md) -- [编译 NebulaGraph Spark Connector](sc-ug-compile.md) -- [使用限制](sc-ug-limitations.md) -- NebulaGraph Spark Connector Reader - - [什么是 NebulaGraph Spark Connector Reader](reader/sc-ug-what-is-reader.md) - - [使用示例](reader/sc-ug-reader-example.md) -- NebulaGraph Spark Connector Writer - - [什么是 NebulaGraph Spark Connector Writer](writer/sc-ug-what-is-writer.md) - - [使用示例](writer/sc-ug-writer-example.md) diff --git a/docs-2.0/spark-connector/sc-ug-what-is-spark-connector.md b/docs-2.0/spark-connector/sc-ug-what-is-spark-connector.md deleted file mode 100644 index bacafe9f906..00000000000 --- a/docs-2.0/spark-connector/sc-ug-what-is-spark-connector.md +++ /dev/null @@ -1,13 +0,0 @@ -# 什么是 NebulaGraph Spark Connector - -[NebulaGraph Spark Connector](https://github.com/vesoft-inc/nebula-java/tree/v1.0/tools "点击前往 GitHub")（在本手册中简称为 Spark Connector）是一个 Spark 连接器，提供了通过 Spark 标准形式读写 NebulaGraph 数据库的能力，由以下两部分组成： - -- Reader：提供了一个 Spark SQL 接口，用户可以使用 Spark SQL 接口编程读取 NebulaGraph 图数据，单次读取一个点或 Edge type 的数据，并将读取的结果组装成 Spark 的 DataFrame。参考 [NebulaGraph Spark Connector Reader](reader/sc-ug-what-is-reader.md)。 - -- Writer：提供了一个 Spark SQL 接口，用户可以使用 Spark SQL 接口编程将 DataFrame 格式的数据逐条或批量写入 NebulaGraph。参考 [NebulaGraph Spark Connector Writer](writer/sc-ug-what-is-writer.md)。 - -用户可以将 NebulaGraph Spark Connector 应用于以下场景： - -- 在不同的 NebulaGraph 集群之间迁移数据。 -- 在同一个 NebulaGraph 集群内不同图空间之间迁移数据。 -- NebulaGraph 与其他数据源之间迁移数据。 diff --git a/docs-2.0/spark-connector/writer/sc-ug-what-is-writer.md b/docs-2.0/spark-connector/writer/sc-ug-what-is-writer.md deleted file mode 100644 index 9623f5652ee..00000000000 --- a/docs-2.0/spark-connector/writer/sc-ug-what-is-writer.md +++ /dev/null @@ -1,45 +0,0 @@ -# 什么是 NebulaGraph Spark Connector Writer - -NebulaGraph Spark Connector Writer 是 NebulaGraph Spark Connector 的组成部分，提供了 Spark SQL 接口，用户可以使用 Spark SQL 接口编程将 DataFrame 数据逐条或批量写入 NebulaGraph。 - -## NebulaGraph Spark Connector Writer 实现原理 - -NebulaGraph Spark Connector Writer 分别提供了两个接口，用于逐条或批量地将数据写入 NebulaGraph。 - -## 逐条写入数据 - -NebulaGraph Spark Connector Writer 基于 Spark 的 `DataSourceV2` 接口实现单条数据写入，实现步骤如下： - -1. 继承 `WriteSupport` 接口并重写 `createWriter` 方法，并使用这个方法创建自定义的 `DataSourceWriter` 接口。 -2. 继承 `DataSourceWriter` 接口，创建 `NebulaDataSourceVertexWriter` 类和 `NebulaDataSourceEdgeWriter` 类。重写 `createWriterFactory` 方法并返回自定义的 `DataWriterFactory`。重写 `commit` 方法，用于提交整个事务。重写 `abort` 方法，用于做事务回滚。 - - !!! Note - - NebulaGraph v1.1.0 不支持事务操作，所以，在这个实现中，`commit` 和 `abort` 无实质性操作。 - -3. 继承 `DataWriterFactory`，创建 `NebulaVertexWriterFactory` 类和 `NebulaEdgeWriterFactory` 类，重写 `createWriter` 方法返回自定义的 `DataWriter`。 -4. 继承 `DataWriter`，创建 `NebulaVertexWriter` 类和 `NebulaEdgeWriter` 类。重写 `write` 方法，用于写出数据。重写 `commit` 方法，用于提交事务。重写 `abort` 方法，用于做事务回滚。 - - !!! Note - - NebulaGraph v1.1.0 不支持事务操作，所以在 `DataWriter` 中，`commit` 和 `abort` 无实质性操作。 - -NebulaGraph Spark Connector Writer 的实现类图如下： - -![NebulaGraph Spark Connector Writer 实现类图](https://docs-cdn.nebula-graph.com.cn/figures/sc-ug-002.png "NebulaGraph Spark Connector Writer 实现类图") - -`NebulaVertexWriter` 和 `NebulaEdgeWriter 的 write` 方法中定义了具体写入逻辑。逐条写入数据的逻辑概括如下： - -1. 创建客户端，连接 NebulaGraph 的 Graph 服务。 -2. 指定即将写入数据的 NebulaGraph 图空间。 -3. 构造 NebulaGraph 插入数据的 nGQL 语句。 -4. 提交 nGQL 语句，执行写入操作。 -5. 定义回调函数接收写入操作执行结果。 - -### 批量数据写入 - -NebulaGraph Spark Connector Writer 批量写入数据的实现与 [NebulaGraph Exchange](../../nebula-exchange/about-exchange/ex-ug-what-is-exchange.md) 类似，即通过对 DataFrame 进行 `map` 操作批量数据的累计提交。 - -## 应用示例 - -参考 [NebulaGraph Spark Connector Writer 应用示例](sc-ug-writer-example.md)。 diff --git a/docs-2.0/spark-connector/writer/sc-ug-writer-example.md b/docs-2.0/spark-connector/writer/sc-ug-writer-example.md deleted file mode 100644 index 36cca6b07e2..00000000000 --- a/docs-2.0/spark-connector/writer/sc-ug-writer-example.md +++ /dev/null @@ -1,134 +0,0 @@ -# NebulaGraph Spark Connector Writer 应用示例 - -本文以一个示例说明如何使用 NebulaGraph Spark Connector Writer 向 NebulaGraph 写入点和边数据。 - -## 前提条件 - -使用 NebulaGraph Spark Connector Writer 前，用户需要确认以下信息： - -- 机器上已经安装了以下软件： - - Apache Spark™ 2.3.0 及更高版本 - - Scala - - Java：1.8 - -- 已经成功编译 NebulaGraph Spark Connector，并已经将 `nebula-spark-1.x.y.jar` 复制到本地 Maven 库。详细信息参考[编译 NebulaGraph Spark Connector](../sc-ug-compile.md)。 - -- 待写入的点和边数据源。在本示例中所用的数据源为 JSON 文件，用户可以从 [nebula-java 库](https://github.com/vesoft-inc/nebula-java/tree/v1.0/examples/src/main/resources "点击前往 GitHub 网站") 中下载。 - -- NebulaGraph 的 Graph 服务 IP 地址及端口号。在本示例中，对应的信息为 `127.0.0.1:3699`。 - -- 在 NebulaGraph 中创建 Schema，并获取以下信息： - - 图空间名称和分区数量。在本示例中，对应的信息为 `nb` 和 `100`。 - - 点的信息，包括 Tag 和 VID 映射策略（`hash`）。 - - 边的信息，包括起点和终点对应的 Tag，以及 VID 映射策略（`hash`）。 - -- （可选）如果是批量写入，需要确认单次写入的最大数据条数，默认为 2000。详见本文 `batchInsert` 配置项说明。 - -## 操作步骤 - -参考以下步骤使用 NebulaGraph Spark Connector Writer 向 NebulaGraph 写入数据。 - -### 第 1 步 - -在 Maven 项目的 POM 文件中加入 `nebula-spark` 依赖。 - -```pom - - com.vesoft - nebula-spark - 1.x.y - -``` - -!!! Note - - `` 建议配置为最新发布的 NebulaGraph Java Client 版本号。用户可以在 [nebula-java 仓库的 Releases 页面](https://github.com/vesoft-inc/nebula-java/releases "点击前往 GitHub 网站") 查看最新的 v1.x 版本。 - -### 第 2 步 - -根据逐条或批量写入需求，参考以下示例在 Spark 应用程序中完成配置。 - -#### 逐条写入数据 - -示例代码如下： - -```shell -// 构造点和边数据的 DataFrame， -// 这里使用 nebula-java 库 v1.0 分支里 nebula-java/examples/src/main/resources 目录下的示例数据， -// 示例数据在本地的存储路径为 examples/src/main/resources - val vertexDF = spark.read.json("examples/src/main/resources/vertex") - vertexDF.show() - val edgeDF = spark.read.json("examples/src/main/resources/edge") - edgeDF.show() - -// 写入点 - vertexDF.write - .nebula("127.0.0.1:3699", "nb", "100") - .writeVertices("player", "vertexId", "hash") - -// 写入边 - edgeDF.write - .nebula("127.0.0.1:3699", "nb", "100") - .wirteEdges("follow", "src_id", "dst_id") -``` - -示例代码中的配置说明如下： - -- `nebula(address: String, space: String, partitionNum: String)` - - `address`：NebulaGraph 的 Graph 服务地址及端口，可以配置多个地址，以英文逗号分隔，如 `“ip1:port,ip2:port”`，端口默认为 `3699`。 - - `space`：NebulaGraph 中即将写入数据的图空间名称。 - - `partitionNum`：在 NebulaGraph 中创建图空间时指定的 `partitionNum` 的值。如果未指定，这里填写 `100`。 - -- `writeVertices(tag: String, vertexField: String, policy: String = "")` - - `tag`：点对应的 NebulaGraph 图空间中的 Tag 名称。 - - `vertexField`：DataFrame 中可作为 NebulaGraph 点 VID 的列。例如，如果 DataFrame 有三列，分别为 a、b、c，其中 a 列作为点 VID 列，则该参数设置为 `"a"`。 - - `policy`：如果 DataFrame 中 `vertexField` 列的数据类型非数值型，则需要配置 NebulaGraph 中 VID 的映射策略，即该参数设置为 `"hash"`。如果 `vertexField` 列的数据类型为整数型，则不需要配置。 - -- `writeEdges(edge: String, srcVertexField: String, dstVertexField: String, policy: String = "")` - - `edge`：边对应的 NebulaGraph 图空间中的 Edge type 名称。 - - `srcVertexField` 和 `dstVertexField`：DataFrame 中可作为边起点和边终点的列。列值必须同为整数型或同为非数值型。 - - `policy`：如果 DataFrame 中 `srcVertexField` 列和 `dstVertexField` 列的数据类型非数值型，则需要配置 NebulaGraph 中 VID 的映射策略，即该参数设置为 `"hash"`。如果 `srcVertexField` 列和 `dstVertexField` 列的数据类型为整数型，则不需要配置。 - -#### 批量写入数据 - -示例代码如下： - -```shell -// 构造点和边数据的 DataFrame， -// 这里使用 nebula-java 库 v1.0 分支里 nebula-java/examples/src/main/resources 目录下的示例数据， -// 示例数据在本地的存储路径为 examples/src/main/resources -val vertexDF = spark.read.json("examples/src/main/resources/vertex") - vertexDF.show() -val edgeDF = spark.read.json("examples/src/main/resources/edge") - edgeDF.show() - -// 批量写入点 -new NebulaBatchWriterUtils() - .batchInsert("127.0.0.1:3699", "nb", 2000) - .batchToNebulaVertex(vertexDF, "player", "vertexId") - -// 批量写入边 -new NebulaBatchWriterUtils() - .batchInsert("127.0.0.1:3699", "nb", 2000) - .batchToNebulaEdge(edgeDF, "follow", "source", "target") -``` - -示例代码中的配置说明如下： - -- `batchInsert(address: String, space: String, batch: Int = 2000)`： - - `address`：NebulaGraph 的 Graph 服务地址及端口，可以配置多个地址，以英文逗号分隔，如 `“ip1:port,ip2:port”`，端口默认为 `3699`。 - - `space`：NebulaGraph 中即将写入数据的图空间名称。 - - `batch`：批量写入时一批次的数据条数，可选，默认为 2000。 - -- `batchToNebulaVertex(data: DataFrame, tag: String, vertexField: String, policy: String = "")`： - - `data`：待写入 NebulaGraph 的 DataFrame 数据。 - - `tag`：NebulaGraph 图空间中对应的 Tag 名称。 - - `vertexField`：DataFrame 中可作为 NebulaGraph 点 VID 的列。例如，如果 DataFrame 有三列，分别为 a、b、c，其中 a 列作为点 VID 列，则该参数设置为 `"a"`。 - - `policy`：如果 DataFrame 中 `vertexField` 列的数据类型非数值型，则需要配置 NebulaGraph 中 VID 的映射策略，即该参数设置为 `"hash"`。如果 `vertexField` 列的数据类型为整数型，则不需要配置。 - -- `batchToNebulaEdge(data: DataFrame,  edge: String, srcVertexField: String, dstVertexField: String, rankField: String = "",  policy: String = "")`： - - `data`：待写入 NebulaGraph 的 DataFrame 数据。 - - `edge`：NebulaGraph 中对应的 Edge type。 - - `srcVertexField` 和 `dstVertexField`：DataFrame 中可作为边起点和边终点的列。列值必须同为整数型或同为非数值型。 - - `rankField`：DataFrame 中可作为边 `rank` 值的列，可选配。 - - `policy`：可选。如果 DataFrame 中 `srcVertexField` 列和 `dstVertexField` 列的数据类型非数值型，则需要配置 NebulaGraph 中 VID 的映射策略，即该参数设置为 `"hash"`。如果 `srcVertexField` 列和 `dstVertexField` 列的数据类型为整数型，则不需要配置。 diff --git a/docs-2.0/stylesheets/extra.css b/docs-2.0/stylesheets/extra.css index 8e682a32e8f..82ab28aaeaf 100644 --- a/docs-2.0/stylesheets/extra.css +++ b/docs-2.0/stylesheets/extra.css @@ -2,13 +2,13 @@ max-width: initial; } -/* NebulaGraph 黑夜主题色 */ +/* 黑夜主题色 */ :root{ --md-primary-fg-color: #FF0000; /* 导航栏页面颜色 */ --md-accent-fg-color: #49BDF0; /* 选中/悬浮链接的颜色 */ } -/* NebulaGraph 白天主题色 */ +/* 白天主题色 */ [data-md-color-scheme="nebula"]{ --md-primary-fg-color: #F7A7A0; /* 导航栏页面颜色 */ --md-accent-fg-color: #7DBB7C; /* 选中/悬浮链接的颜色 */ 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 fbec73345b5..f6ef9441208 100644 --- a/docs-2.0/synchronization-and-migration/2.balance-syntax.md +++ b/docs-2.0/synchronization-and-migration/2.balance-syntax.md @@ -1,6 +1,6 @@ # BALANCE -`BALANCE`语句可以让 NebulaGraph 的 Storage 服务实现负载均衡。更多`BALANCE`语句示例和 Storage 负载均衡，请参见 [Storage 负载均衡](../8.service-tuning/load-balance.md)。 +`BALANCE`语句可以让{{nebula.name}}的 Storage 服务实现负载均衡。更多`BALANCE`语句示例和 Storage 负载均衡，请参见 [Storage 负载均衡](../8.service-tuning/load-balance.md)。 `BALANCE`语法说明如下。 diff --git a/docs-2.0/synchronization-and-migration/replication-between-clusters.md b/docs-2.0/synchronization-and-migration/replication-between-clusters.md index 1473f62c1a9..80a065f929a 100644 --- a/docs-2.0/synchronization-and-migration/replication-between-clusters.md +++ b/docs-2.0/synchronization-and-migration/replication-between-clusters.md @@ -1,6 +1,6 @@ # 集群间数据同步 -NebulaGraph 支持在集群间进行数据同步，即主集群 A 的数据可以近实时地复制到从集群 B 中，方便用户进行异地灾备或分流，降低数据丢失的风险，保证数据安全。 +{{nebula.name}}支持在集群间进行数据同步，即主集群 A 的数据可以近实时地复制到从集群 B 中，方便用户进行异地灾备或分流，降低数据丢失的风险，保证数据安全。 !!! enterpriseonly @@ -24,7 +24,7 @@ NebulaGraph 支持在集群间进行数据同步，即主集群 A 的数据可 ## 注意事项 -- 主从集群必须是同一个 NebulaGraph 版本，否则数据同步会失败。 +- 主从集群的数据库版本必须相同，否则数据同步会失败。 - 数据同步的基本单位是图空间，即只可以设置从一个图空间到另一个图空间的数据同步。 @@ -95,7 +95,7 @@ drainer：机器 IP 地址为`192.168.10.104`，只启动 drainer 服务。 2. 在主从集群和 listener 服务的机器上放置 License 文件，路径为安装目录的`share/resources/`内。 -3. 在所有机器的 NebulaGraph 安装目录内启动对应的服务： +3. 在所有机器的{{nebula.name}}安装目录内启动对应的服务： - 主、从集群启动命令：`sudo scripts/nebula.service start all`。 @@ -182,7 +182,7 @@ drainer：机器 IP 地址为`192.168.10.104`，只启动 drainer 服务。 3. 设置 listener 服务。 ``` - //设置 listener 服务，待同步的图空间名称为replication_basketballplayer（下文将在从集群中创建）。 + //设置 listener 服务，待同步的图空间名称为 replication_basketballplayer（下文将在从集群中创建）。 nebula> ADD LISTENER SYNC META 192.168.10.103:9569 STORAGE 192.168.10.103:9789 TO SPACE replication_basketballplayer; //查看 listener 状态。 nebula> SHOW LISTENER SYNC; From 5f98036df1aa63735a2a1bb53f13039f65e6440f Mon Sep 17 00:00:00 2001 From: cooper-lzy <78672629+cooper-lzy@users.noreply.github.com> Date: Tue, 11 Apr 2023 14:48:53 +0800 Subject: [PATCH 127/137] update --- ...deploy-nebula-graph-with-docker-compose.md | 18 +++++------ .../4.install-nebula-graph-from-tar.md | 24 +++++++-------- .../6.deploy-nebula-graph-with-peripherals.md | 10 +++---- .../deploy-nebula-graph-cluster.md | 24 +++++++-------- .../_upgrade-nebula-from-300-to-latest.md | 16 +++++----- .../upgrade-nebula-ent-from-3.x-3.4.md | 22 +++++++------- .../upgrade-nebula-graph-to-latest.md | 28 ++++++++--------- .../1.text-based-index-restrictions.md | 6 ++-- .../6.deploy-text-based-index/2.deploy-es.md | 4 +-- .../3.deploy-listener.md | 10 +++---- .../1.configurations/1.configurations.md | 28 ++++++++--------- .../1.configurations/2.meta-config.md | 16 +++++----- .../1.configurations/3.graph-config.md | 24 +++++++-------- .../1.configurations/4.storage-config.md | 16 +++++----- .../1.configurations/6.kernel-config.md | 2 +- .../2.log-management/audit-log.md | 6 ++-- .../2.log-management/logs.md | 8 ++--- .../1.query-performance-metrics.md | 10 +++---- .../2.rocksdb-statistics.md | 2 +- .../6.monitor-and-metrics/3.bbox/3.1.bbox.md | 14 ++++----- .../3.bbox/3.2.bbox-reviewer.md | 12 +++----- .../1.authentication/1.authentication.md | 10 +++---- .../1.authentication/2.management-user.md | 12 ++++---- .../1.authentication/3.role-list.md | 2 +- .../1.authentication/4.ldap.md | 14 ++++----- docs-2.0/7.data-security/4.ssl.md | 6 ++-- docs-2.0/8.service-tuning/2.graph-modeling.md | 28 ++++++++--------- docs-2.0/8.service-tuning/3.system-design.md | 6 ++-- docs-2.0/8.service-tuning/4.plan.md | 2 +- docs-2.0/8.service-tuning/compaction.md | 8 ++--- .../enable_autofdo_for_nebulagraph.md | 10 +++---- docs-2.0/8.service-tuning/load-balance.md | 8 ++--- docs-2.0/8.service-tuning/practice.md | 30 +++++++++---------- docs-2.0/8.service-tuning/super-node.md | 8 ++--- .../backup-and-restore/3.manage-snapshot.md | 8 ++--- .../nebula-br-ent/1.br-ent-overview.md | 8 ++--- .../nebula-br-ent/2.install-tools.md | 10 +++---- .../nebula-br-ent/3.backup-data.md | 10 +++---- .../nebula-br-ent/4.restore-data.md | 4 +-- .../nebula-br/1.what-is-br.md | 12 ++++---- .../nebula-br/2.compile-br.md | 6 ++-- .../nebula-br/3.br-backup-data.md | 4 +-- .../nebula-br/4.br-restore-data.md | 4 +-- 43 files changed, 250 insertions(+), 260 deletions(-) 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 a8f7b2878f9..03673f4fb05 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 @@ -166,9 +166,9 @@ a74054c6ae25 vesoft/nebula-graphd:nightly "/usr/local/nebula/b…" 36 mi [root@2a6c56c405f5 nebula]# ``` -## 查看 NebulaGraph 服务的数据和日志 +## 查看{{nebula.name}}服务的数据和日志 -NebulaGraph 的所有数据和日志都持久化存储在`nebula-docker-compose/data`和`nebula-docker-compose/logs`目录中。 +{{nebula.name}}的所有数据和日志都持久化存储在`nebula-docker-compose/data`和`nebula-docker-compose/logs`目录中。 目录的结构如下： @@ -194,9 +194,9 @@ nebula-docker-compose/ └── storage2 ``` -## 停止 NebulaGraph 服务 +## 停止{{nebula.name}}服务 -用户可以执行如下命令停止 NebulaGraph 服务： +用户可以执行如下命令停止{{nebula.name}}服务： ```bash $ docker-compose down @@ -234,7 +234,7 @@ Removing network nebuladockercompose_nebula-net ## 修改配置 -Docker Compose 部署的 NebulaGraph，配置文件位置为`nebula-docker-compose/docker-compose.yaml`，修改该文件内的配置并重启服务即可使新配置生效。 +Docker Compose 部署的{{nebula.name}}，配置文件位置为`nebula-docker-compose/docker-compose.yaml`，修改该文件内的配置并重启服务即可使新配置生效。 具体的配置说明请参见[配置管理](../../5.configurations-and-logs/1.configurations/1.configurations.md)。 @@ -256,15 +256,15 @@ graphd: `9669:9669`表示内部的 9669 映射到外部的端口也是 9669，下方的`19669`表示内部的 19669 映射到外部的端口是随机的。 -### 如何升级/更新 NebulaGraph 服务的 Docker 镜像？ +### 如何升级/更新{{nebula.name}}服务的 Docker 镜像？ 1. 在文件`nebula-docker-compose/docker-compose.yaml`中，找到所有服务的`image`并修改其值为相应的镜像版本。 2. 在目录`nebula-docker-compose`内执行命令`docker-compose pull`，更新 Graph 服务、Storage 服务、Meta 服务和 NebulaGraph Console 的镜像。 -3. 执行命令`docker-compose up -d`启动 NebulaGraph 服务。 +3. 执行命令`docker-compose up -d`启动{{nebula.name}}服务。 -4. 通过 NebulaGraph Console 连接 NebulaGraph 后，分别执行命令`SHOW HOSTS GRAPH`、`SHOW HOSTS STORAGE`、`SHOW HOSTS META`查看各服务版本。 +4. 通过 NebulaGraph Console 连接{{nebula.name}}后，分别执行命令`SHOW HOSTS GRAPH`、`SHOW HOSTS STORAGE`、`SHOW HOSTS META`查看各服务版本。 ### 执行命令`docker-compose pull`报错`ERROR: toomanyrequests` @@ -276,7 +276,7 @@ graphd: ### 如何更新 NebulaGraph Console？ -`docker-compose pull`会同时更新 NebulaGraph 服务和 NebulaGraph Console。 +`docker-compose pull`会同时更新{{nebula.name}}服务和 NebulaGraph Console。 !!! note - 如果您的企业版 NebulaGraph 版本低于 3.0.0，请先升级到企业版 3.1.0 再升级到 {{nebula.release}}。具体操作请参见[升级 NebulaGraph 2.x 至 3.1.0](https://docs.nebula-graph.com.cn/3.1.0/4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-graph-to-latest/)。 + 如果您的{{nebula.name}}版本低于 3.0.0，请先升级到 3.1.0 再升级到 {{nebula.release}}。具体操作请参见[升级{{nebula.name}} 2.x 至 3.1.0](https://docs.nebula-graph.com.cn/3.1.0/4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-graph-to-latest/)。 - 执行升级操作的集群 IP 地址必须与原集群相同。 - 机器硬盘剩余空间至少需为原数据目录的 1.5 倍。 -- 在升级部署了全文索引的 NebulaGraph 前，需要手动删除 Elasticsearch (ES) 中的全文索引。在升级后需要重新使用`SIGN IN`语句登录 ES 并重新创建全文索引。 +- 在升级部署了全文索引的{{nebula.name}}前，需要手动删除 Elasticsearch (ES) 中的全文索引。在升级后需要重新使用`SIGN IN`语句登录 ES 并重新创建全文索引。 !!! note @@ -23,7 +23,7 @@ ## 升级步骤 -1. [联系我们获取](https://www.nebula-graph.com.cn/contact)企业版 NebulaGraph v{{nebula.release}} 的安装包并安装。 +1. [联系我们获取](https://www.nebula-graph.com.cn/contact){{nebula.name}} v{{nebula.release}} 的安装包并安装。 !!! note @@ -33,10 +33,10 @@ 请确保 {{nebula.release}} 集群的 Meta 服务和 Storage 服务的配置文件中的`--data_path`参数设置的存储路径数量与 3.x 集群的配置文件中的`--data_path`参数配置的路径数量相同。否则，升级后的集群无法启动。 -2. 停止企业版 NebulaGraph v3.x 服务。详情请参见[管理 NebulaGraph 服务](../../2.quick-start/3.quick-start-on-premise/5.start-stop-service.md)。 +2. 停止{{nebula.name}} v3.x 服务。详情请参见[管理{{nebula.name}}服务](../../2.quick-start/3.quick-start-on-premise/5.start-stop-service.md)。 运行命令后可继续运行`nebula.service status all`命令以确认所有服务都已停止。 -3. 在企业版 NebulaGraph v{{nebula.release}} 的安装目录下，分别执行以下命令以升级 Storage 和 Meta 服务。 +3. 在{{nebula.name}} v{{nebula.release}} 的安装目录下，分别执行以下命令以升级 Storage 和 Meta 服务。 - 升级 Storage 服务： @@ -91,8 +91,8 @@ 4. 上传 License 文件至 v{{nebula.release}} 的安装目录下的`share/resources`内。 -5. 启动和连接企业版 NebulaGraph v{{nebula.release}} 服务后，验证数据是否正确。参考命令如下： - +5. 启动和连接{{nebula.name}} v{{nebula.release}} 服务后，验证数据是否正确。参考命令如下： + ``` nebula> SHOW HOSTS; nebula> SHOW HOSTS storage; @@ -108,7 +108,7 @@ !!! caution - Docker Compose 部署的 NebulaGraph 建议重新部署新版本后导入数据。 + Docker Compose 部署的{{nebula.name}}建议重新部署新版本后导入数据。 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 dfa24f57ce6..e1f7c7a692e 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 @@ -1,6 +1,6 @@ -# 升级 NebulaGraph 至 {{nebula.release}} 版本 +# 升级{{nebula.name}} 至 {{nebula.release}} 版本 -本文以 NebulaGraph 2.6.1 版本升级到 {{nebula.release}} 版本为例，介绍 NebulaGraph 2.x、3.x 版本升级到 {{nebula.release}} 版本的方法。 +本文以{{nebula.name}} 2.6.1 版本升级到 {{nebula.release}} 版本为例，介绍{{nebula.name}}2.x、3.x 版本升级到 {{nebula.release}} 版本的方法。 !!! caution - 如需从 2.0.0 之前的版本（含 1.x 版本）升级到 {{nebula.release}}，还需找到 {{nebula.release}} 版本文件中`share/resources`目录下的`date_time_zonespec.csv`文件，将其复制到 NebulaGraph 安装路径下的相同目录内。也可从 [GitHub](https://github.com/vesoft-inc/nebula/blob/master/resources/date_time_zonespec.csv) 下载该文件。 + 如需从 2.0.0 之前的版本（含 1.x 版本）升级到 {{nebula.release}}，还需找到 {{nebula.release}} 版本文件中`share/resources`目录下的`date_time_zonespec.csv`文件，将其复制到{{nebula.name}}安装路径下的相同目录内。也可从 [GitHub](https://github.com/vesoft-inc/nebula/blob/master/resources/date_time_zonespec.csv) 下载该文件。 - 不支持轮转热升级，需完全停止整个集群服务。 @@ -46,7 +46,7 @@ ps：如果2.x（x<5）来做到3.4的升级，升级过程不会报错，因为 - 客户端兼容 - 升级后旧版本客户端将无法连接 NebulaGraph，需将所有客户端都升级到兼容 NebulaGraph {{nebula.release}} 的版本。 + 升级后旧版本客户端将无法连接{{nebula.name}}，需将所有客户端都升级到兼容{{nebula.name}} {{nebula.release}} 的版本。 - 配置变化 @@ -64,7 +64,7 @@ ps：如果2.x（x<5）来做到3.4的升级，升级过程不会报错，因为 - 全文索引 - 在升级部署了全文索引的 NebulaGraph 前，需要手动删除 Elasticsearch (ES) 中的全文索引。在升级后需要重新使用`SIGN IN`语句登录 ES 并重新创建全文索引。用户可通过 cURL 命令手动删除 ES 中全文索引。命令为`curl -XDELETE -u : ':/'`，例如`curl -XDELETE -u elastic:elastic 'http://192.168.8.223:9200/nebula_index_2534'`。如果 ES 没有设置用户名及密码，则无需指定`-u`选项。 + 在升级部署了全文索引的{{nebula.name}}前，需要手动删除 Elasticsearch (ES) 中的全文索引。在升级后需要重新使用`SIGN IN`语句登录 ES 并重新创建全文索引。用户可通过 cURL 命令手动删除 ES 中全文索引。命令为`curl -XDELETE -u : ':/'`，例如`curl -XDELETE -u elastic:elastic 'http://192.168.8.223:9200/nebula_index_2534'`。如果 ES 没有设置用户名及密码，则无需指定`-u`选项。 !!! caution @@ -72,7 +72,7 @@ ps：如果2.x（x<5）来做到3.4的升级，升级过程不会报错，因为 ## 升级准备 -- 根据操作系统和架构下载 NebulaGraph {{nebula.release}} 版本的包文件并解压，升级过程中需要其中的二进制文件。下载地址参见 [Download 页面](https://nebula-graph.io/download/)。 +- 根据操作系统和架构下载{{nebula.name}} {{nebula.release}} 版本的包文件并解压，升级过程中需要其中的二进制文件。下载地址参见 [Download 页面](https://nebula-graph.io/download/)。 !!! note @@ -92,13 +92,13 @@ ps：如果2.x（x<5）来做到3.4的升级，升级过程不会报错，因为 ## 升级步骤 -1. 停止所有 NebulaGraph 服务。 +1. 停止所有{{nebula.name}}服务。 ``` /scripts/nebula.service stop all ``` - `nebula_install_path`代表 NebulaGraph 的安装目录。 + `nebula_install_path`代表{{nebula.name}}的安装目录。 `storaged` 进程 flush 数据要等待约 1 分钟。运行命令后可继续运行`nebula.service status all`命令以确认所有服务都已停止。启动和停止服务的详细说明参见[管理服务](../manage-service.md)。 @@ -110,10 +110,10 @@ ps：如果2.x（x<5）来做到3.4的升级，升级过程不会报错，因为 从 3.0.0 开始，支持插入无 Tag 的点。如果用户需要保留无 Tag 的点，在集群内所有 Graph 服务的配置文件（`nebula-graphd.conf`）中新增`--graph_use_vertex_key=true`；在所有 Storage 服务的配置文件（`nebula-storaged.conf`）中新增`--use_vertex_key=true`。 -2. 在**升级准备**中下载的包的目的路径下，用此处`bin`目录中的新版二进制文件替换 NebulaGraph 安装路径下`bin`目录中的旧版二进制文件。 +2. 在**升级准备**中下载的包的目的路径下，用此处`bin`目录中的新版二进制文件替换{{nebula.name}}安装路径下`bin`目录中的旧版二进制文件。 !!! note - 每台部署了 NebulaGraph 服务的机器上都要更新相应服务的二进制文件。 + 每台部署了{{nebula.name}}服务的机器上都要更新相应服务的二进制文件。 3. 编辑所有 Graph 服务的配置文件，修改以下参数以适应新版本的取值范围。如参数值已在规定范围内，忽略该步骤。 @@ -131,7 +131,7 @@ ps：如果2.x（x<5）来做到3.4的升级，升级过程不会报错，因为 启动后，Meta 服务选举 leader。该过程耗时数秒。 - 启动后可以任意启动一个 Graph 服务节点，使用 NebulaGraph 连接该节点并运行[`SHOW HOSTS meta`](../../3.ngql-guide/7.general-query-statements/6.show/6.show-hosts.md)和[`SHOW META LEADER`](../../3.ngql-guide/7.general-query-statements/6.show/19.show-meta-leader.md)，如果能够正常返回 Meta 节点的状态，则 Meta 服务启动成功。 + 启动后可以任意启动一个 Graph 服务节点，使用{{nebula.name}}连接该节点并运行[`SHOW HOSTS meta`](../../3.ngql-guide/7.general-query-statements/6.show/6.show-hosts.md)和[`SHOW META LEADER`](../../3.ngql-guide/7.general-query-statements/6.show/19.show-meta-leader.md)，如果能够正常返回 Meta 节点的状态，则 Meta 服务启动成功。 !!! note 如果启动异常，放弃本次升级，并在[论坛](https://discuss.nebula-graph.com.cn/)或 [GitHub](https://github.com/vesoft-inc/nebula/issues) 提问。 @@ -142,7 +142,7 @@ ps：如果2.x（x<5）来做到3.4的升级，升级过程不会报错，因为 !!! note 如果启动异常，放弃本次升级，并在[论坛](https://discuss.nebula-graph.com.cn/)或 [GitHub](https://github.com/vesoft-inc/nebula/issues) 提问。 -6. 连接新版 NebulaGraph，验证服务是否可用、数据是否正常。连接方法参见[连接服务](../connect-to-nebula-graph.md)。 +6. 连接新版{{nebula.name}}，验证服务是否可用、数据是否正常。连接方法参见[连接服务](../connect-to-nebula-graph.md)。 目前尚无有效方式判断升级是否完全成功，可用于测试的参考命令如下： @@ -213,7 +213,7 @@ ADD HOSTS 192.168.10.100:9779, 192.168.10.101:9779, 192.168.10.102:9779; ### 为什么升级后用`SHOW JOBS`查询到的 Job 的 ID 与升级前一样，但 Job 名称等信息不同了？ -NebulaGraph 2.5.0 版本调整了 Job 的定义，详情参见 [Pull request](https://github.com/vesoft-inc/nebula-common/pull/562/files)。如果是从 2.5.0 之前的版本升级，会出现该问题。 +{{nebula.name}} 2.5.0 版本调整了 Job 的定义，详情参见 [Pull request](https://github.com/vesoft-inc/nebula-common/pull/562/files)。如果是从 2.5.0 之前的版本升级，会出现该问题。 ### 有哪些语法不兼容 ? diff --git a/docs-2.0/4.deployment-and-installation/6.deploy-text-based-index/1.text-based-index-restrictions.md b/docs-2.0/4.deployment-and-installation/6.deploy-text-based-index/1.text-based-index-restrictions.md index db7d4c75299..324449bbd7d 100644 --- a/docs-2.0/4.deployment-and-installation/6.deploy-text-based-index/1.text-based-index-restrictions.md +++ b/docs-2.0/4.deployment-and-installation/6.deploy-text-based-index/1.text-based-index-restrictions.md @@ -26,8 +26,8 @@ - `WHERE`子句只能用单个条件进行全文搜索。 -- 确保同时启动了 Elasticsearch 集群和 NebulaGraph，否则可能导致 Elasticsearch 集群写入的数据不完整。 +- 确保同时启动了 Elasticsearch 集群和{{nebula.name}}，否则可能导致 Elasticsearch 集群写入的数据不完整。 -- 从写入 NebulaGraph，到写入 listener，再到写入 Elasticsearch 并创建索引可能需要一段时间。如果访问全文索引时返回未找到索引，可等待索引生效（但是，该等待时间未知，也无返回码检查）。 +- 从写入{{nebula.name}}，到写入 listener，再到写入 Elasticsearch 并创建索引可能需要一段时间。如果访问全文索引时返回未找到索引，可等待索引生效（但是，该等待时间未知，也无返回码检查）。 -- 使用 K8s 方式部署的 NebulaGraph 集群不支持全文索引。 +- 使用 K8s 方式部署的{{nebula.name}}集群不支持全文索引。 diff --git a/docs-2.0/4.deployment-and-installation/6.deploy-text-based-index/2.deploy-es.md b/docs-2.0/4.deployment-and-installation/6.deploy-text-based-index/2.deploy-es.md index 38f1d2027b6..3370ae9ca6b 100644 --- a/docs-2.0/4.deployment-and-installation/6.deploy-text-based-index/2.deploy-es.md +++ b/docs-2.0/4.deployment-and-installation/6.deploy-text-based-index/2.deploy-es.md @@ -1,6 +1,6 @@ # 部署全文索引 -NebulaGraph 的全文索引是基于 [Elasticsearch](https://en.wikipedia.org/wiki/Elasticsearch) 实现，这意味着用户可以使用 Elasticsearch 全文查询语言来检索想要的内容。全文索引由内置的进程管理，当 listener 集群和 Elasticsearch 集群部署后，内置的进程只能为数据类型为定长字符串或变长字符串的属性创建全文索引。 +{{nebula.name}}的全文索引是基于 [Elasticsearch](https://en.wikipedia.org/wiki/Elasticsearch) 实现，这意味着用户可以使用 Elasticsearch 全文查询语言来检索想要的内容。全文索引由内置的进程管理，当 listener 集群和 Elasticsearch 集群部署后，内置的进程只能为数据类型为定长字符串或变长字符串的属性创建全文索引。 ## 注意事项 @@ -12,7 +12,7 @@ NebulaGraph 的全文索引是基于 [Elasticsearch](https://en.wikipedia.org/wi !!! compatibility - NebulaGraph 3.4 及以后，不需要额外创建模板。 + {{nebula.name}} 3.4 及以后，不需要额外创建模板。 !!! caution diff --git a/docs-2.0/4.deployment-and-installation/6.deploy-text-based-index/3.deploy-listener.md b/docs-2.0/4.deployment-and-installation/6.deploy-text-based-index/3.deploy-listener.md index a8346f4016a..43eab0c816c 100644 --- a/docs-2.0/4.deployment-and-installation/6.deploy-text-based-index/3.deploy-listener.md +++ b/docs-2.0/4.deployment-and-installation/6.deploy-text-based-index/3.deploy-listener.md @@ -6,7 +6,7 @@ - 已经了解全文索引的[使用限制](../../4.deployment-and-installation/6.deploy-text-based-index/1.text-based-index-restrictions.md)。 -- 已经[部署 NebulaGraph 集群](../2.compile-and-install-nebula-graph/deploy-nebula-graph-cluster.md)。 +- 已经[部署{{nebula.name}}集群](../2.compile-and-install-nebula-graph/deploy-nebula-graph-cluster.md)。 - 完成[部署 Elasticsearch 集群](./2.deploy-es.md)。 @@ -14,7 +14,7 @@ ## 注意事项 -- 请保证 NebulaGraph 各组件（Metad、Storaged、Graphd、listener）有相同的版本。 +- 请保证{{nebula.name}}各组件（Metad、Storaged、Graphd、listener）有相同的版本。 - 只能为一个图空间“一次性添加所有的 listener 机器”。尝试向已经存在有 listener 的图空间再添加新 listener 会失败。因此，需在一个命令语句里完整地添加全部的 listener。 @@ -22,7 +22,7 @@ ### 第一步：安装 Storage 服务 -listener 进程与 storaged 进程使用相同的二进制文件，但是二者配置文件不同，进程使用端口也不同，可以在所有需要部署 listener 的服务器上都安装 NebulaGraph，但是仅使用 Storage 服务。详情请参见[使用 RPM 或 DEB 安装包安装 NebulaGraph](../2.compile-and-install-nebula-graph/2.install-nebula-graph-by-rpm-or-deb.md)。 +listener 进程与 storaged 进程使用相同的二进制文件，但是二者配置文件不同，进程使用端口也不同，可以在所有需要部署 listener 的服务器上都安装{{nebula.name}}，但是仅使用 Storage 服务。详情请参见[使用 RPM 或 DEB 安装包安装{{nebula.name}}](../2.compile-and-install-nebula-graph/2.install-nebula-graph-by-rpm-or-deb.md)。 ### 第二步：准备 listener 的配置文件 @@ -60,9 +60,9 @@ listener 进程与 storaged 进程使用相同的二进制文件，但是二者 `listener_config_path`是存放 listener 配置文件的路径。 -### 第四步：添加 listener 到 NebulaGraph 集群 +### 第四步：添加 listener 到{{nebula.name}}集群 -[用命令行连接到 NebulaGraph](../../2.quick-start/3.quick-start-on-premise/3.connect-to-nebula-graph.md)，然后执行 [`USE `](../../3.ngql-guide/9.space-statements/2.use-space.md) 进入需要创建全文索引的图空间。然后执行如下命令添加 listener： +[用命令行连接到{{nebula.name}}](../../2.quick-start/3.quick-start-on-premise/3.connect-to-nebula-graph.md)，然后执行 [`USE `](../../3.ngql-guide/9.space-statements/2.use-space.md) 进入需要创建全文索引的图空间。然后执行如下命令添加 listener： ```ngql ADD LISTENER ELASTICSEARCH [,, ...] diff --git a/docs-2.0/5.configurations-and-logs/1.configurations/1.configurations.md b/docs-2.0/5.configurations-and-logs/1.configurations/1.configurations.md index 08ace1f7558..285ee65ed75 100644 --- a/docs-2.0/5.configurations-and-logs/1.configurations/1.configurations.md +++ b/docs-2.0/5.configurations-and-logs/1.configurations/1.configurations.md @@ -1,6 +1,6 @@ # 配置管理 -NebulaGraph 基于 [gflags](https://gflags.github.io/gflags/) 库打造了系统配置，多数配置项都是其中的 flags。NebulaGraph 服务启动时，默认会从[配置文件](#_4)中获取配置信息。对于文件中没有的配置项，系统使用默认值。 +{{nebula.name}}基于 [gflags](https://gflags.github.io/gflags/) 库打造了系统配置，多数配置项都是其中的 flags。{{nebula.name}}服务启动时，默认会从[配置文件](#_4)中获取配置信息。对于文件中没有的配置项，系统使用默认值。 {{ ent.ent_begin }} @@ -12,7 +12,7 @@ NebulaGraph 基于 [gflags](https://gflags.github.io/gflags/) 库打造了系统 !!! note - * 由于配置项多且可能随着 NebulaGraph 的开发发生变化，文档不会介绍所有配置项。按下文说明可在命令行获取配置项的详细说明。 + * 由于配置项多且可能随着{{nebula.name}}的开发发生变化，文档不会介绍所有配置项。按下文说明可在命令行获取配置项的详细说明。 * 不建议修改文档未介绍的配置项，除非已经熟悉源代码并完全了解配置项的作用。 !!! compatibility "历史版本兼容性" @@ -40,11 +40,11 @@ $ /usr/local/nebula/bin/nebula-graphd --help $ /usr/local/nebula/bin/nebula-storaged --help ``` -以上示例使用了二进制文件的默认存储路径`/usr/local/nebula/bin/`。如果修改了 NebulaGraph 安装路径，使用实际路径查询配置项信息。 +以上示例使用了二进制文件的默认存储路径`/usr/local/nebula/bin/`。如果修改了{{nebula.name}}安装路径，使用实际路径查询配置项信息。 ## 查看运行配置 -使用`curl`命令获取运行中的配置项的值，即 NebulaGraph 的运行配置。 +使用`curl`命令获取运行中的配置项的值，即{{nebula.name}}的运行配置。 ## 数据传输与优化 -- 读写平衡。NebulaGraph 适合读写平衡性的在线场景，也即 OLTP 型的的“并发的发生写入与读取”；而非数仓 OLAP 型的“一次写入多次读取”。 +- 读写平衡。{{nebula.name}}适合读写平衡性的在线场景，也即 OLTP 型的的“并发的发生写入与读取”；而非数仓 OLAP 型的“一次写入多次读取”。 - 选择不同的写入方式。大批量的数据写入可以使用 sst 加载的方式；小批量的写入使用`INSERT`语句。 - 选择合适的时间运行 COMPACTION 和 BALANCE，来分别优化数据格式和存储分布。 -- NebulaGraph {{ nebula.release }} 不支持关系型数据库意义上的事务和隔离性，更接近 NoSQL。 +- {{nebula.name}} {{ nebula.release }} 不支持关系型数据库意义上的事务和隔离性，更接近 NoSQL。 ## 查询预热与数据预热 diff --git a/docs-2.0/8.service-tuning/4.plan.md b/docs-2.0/8.service-tuning/4.plan.md index 8e2232a610d..84c951c52bc 100644 --- a/docs-2.0/8.service-tuning/4.plan.md +++ b/docs-2.0/8.service-tuning/4.plan.md @@ -1,5 +1,5 @@ # 执行计划 -NebulaGraph {{ nebula.release }} 实现了基于规则的执行计划。用户无法改变执行计划，无法进行查询的预编译（及相应的计划缓存），无法通过指定索引来加速查询。 +{{nebula.name}} {{ nebula.release }} 实现了基于规则的执行计划。用户无法改变执行计划，无法进行查询的预编译（及相应的计划缓存），无法通过指定索引来加速查询。 要查看执行计划及执行概要，请参考 [EXPLAIN 和 PROFILE](../3.ngql-guide/17.query-tuning-statements/1.explain-and-profile.md)。 diff --git a/docs-2.0/8.service-tuning/compaction.md b/docs-2.0/8.service-tuning/compaction.md index 0e679199b0b..beb5b36c144 100644 --- a/docs-2.0/8.service-tuning/compaction.md +++ b/docs-2.0/8.service-tuning/compaction.md @@ -2,15 +2,15 @@ 本文介绍 Compaction 的相关信息。 -NebulaGraph 中，`Compaction`是最重要的后台操作，对性能有极其重要的影响。 +{{nebula.name}}中，`Compaction`是最重要的后台操作，对性能有极其重要的影响。 -`Compaction`操作会读取硬盘上的数据，然后重组数据结构和索引，然后再写回硬盘，可以成倍提升读取性能。将大量数据写入 NebulaGraph 后，为了提高读取性能，需要手动触发`Compaction`操作（全量`Compaction`）。 +`Compaction`操作会读取硬盘上的数据，然后重组数据结构和索引，然后再写回硬盘，可以成倍提升读取性能。将大量数据写入{{nebula.name}}后，为了提高读取性能，需要手动触发`Compaction`操作（全量`Compaction`）。 !!! Note `Compaction`操作会长时间占用硬盘的 IO，建议在业务低峰期（例如凌晨）执行该操作。 -NebulaGraph 有两种类型的`Compaction`操作：自动`Compaction`和全量`Compaction`。 +{{nebula.name}}有两种类型的`Compaction`操作：自动`Compaction`和全量`Compaction`。 ## 自动`Compaction` @@ -74,7 +74,7 @@ nebula> SHOW JOB ; ## 操作建议 -为保证 NebulaGraph 的性能，请参考如下操作建议： +为保证{{nebula.name}}的性能，请参考如下操作建议： diff --git a/docs-2.0/backup-and-restore/nebula-br-ent/1.br-ent-overview.md b/docs-2.0/backup-and-restore/nebula-br-ent/1.br-ent-overview.md index 1f33016cd17..aad32a66ac6 100644 --- a/docs-2.0/backup-and-restore/nebula-br-ent/1.br-ent-overview.md +++ b/docs-2.0/backup-and-restore/nebula-br-ent/1.br-ent-overview.md @@ -1,10 +1,10 @@ # 什么是 Backup&Restore（企业版） -Backup&Restore（简称 BR）企业版是一款命令行界面（CLI）工具。通过 NebulaGraph BR（企业版），用户可以备份 NebulaGraph 企业版数据，并基于备份目录进行数据恢复。 +Backup&Restore（简称 BR）企业版是一款命令行界面（CLI）工具。通过 NebulaGraph BR（企业版），用户可以备份{{nebula.name}}数据，并基于备份目录进行数据恢复。 !!! enterpriseonly - 该工具仅适用于 NebulaGraph 企业版。 + 该工具仅适用于{{nebula.name}}企业版。 ## 功能 @@ -19,14 +19,14 @@ Backup&Restore（简称 BR）企业版是一款命令行界面（CLI）工具。 ## 限制 -- NebulaGraph 企业版的版本需要为 v{{ nebula.release }}及以上。 +- {{nebula.name}}的版本需要为 v{{ nebula.release }}及以上。 - 不支持备份 [Listener](../../4.deployment-and-installation/6.deploy-text-based-index/3.deploy-listener.md)。 - 不支持备份全文索引。 - 如果备份数据到本地磁盘，备份的文件将会放置在每个服务器的本地路径中。也可以在本地挂载 NFS 文件系统，以便将备份数据还原到不同的主机上。 - 数据备份过程中，指定图空间中的 DDL 和 DML 语句将会阻塞，我们建议在业务低峰期进行操作，例如凌晨 2 点至 5 点。 - 数据恢复需要原集群和目标集群的 Storage 主机数量及 IP 一致。 - 不支持备份指定图空间数据。 -- 不支持在容器部署的 NebulaGraph 集群中使用 BR 企业版。 +- 不支持在容器部署的{{nebula.name}}集群中使用 BR 企业版。 ## 使用流程 diff --git a/docs-2.0/backup-and-restore/nebula-br-ent/2.install-tools.md b/docs-2.0/backup-and-restore/nebula-br-ent/2.install-tools.md index 1b2c02e07c2..1c4064c9abe 100644 --- a/docs-2.0/backup-and-restore/nebula-br-ent/2.install-tools.md +++ b/docs-2.0/backup-and-restore/nebula-br-ent/2.install-tools.md @@ -1,20 +1,20 @@ # 安装 BR（企业版） -备份和恢复 NebulaGraph 企业版数据需要安装 BR 企业版工具。本文介绍如何安装 BR 企业版工具。 +备份和恢复{{nebula.name}}企业版数据需要安装 BR 企业版工具。本文介绍如何安装 BR 企业版工具。 ## 安装说明 -使用 BR （企业版）工具时，需要安装 NebulaGraph Agent 插件。Agent 是集群中每台机器的一个守护进程，用于启停 NebulaGraph 服务和上传/下载备份文件。BR（企业版）工具和 Agent 插件的安装方式如下文。 +使用 BR （企业版）工具时，需要安装 NebulaGraph Agent 插件。Agent 是集群中每台机器的一个守护进程，用于启停{{nebula.name}}服务和上传/下载备份文件。BR（企业版）工具和 Agent 插件的安装方式如下文。 ## 版本兼容性 -|NebulaGraph 企业版|BR 企业版|Agent | +|{{nebula.name}}|BR 企业版|Agent | |:---|:---|:---| |3.4.1|3.4.1、3.4.0|3.4.0| ## 安装 BR（企业版） -BR 企业版工具是一款命令行界面（CLI）工具，可以帮助备份 NebulaGraph 的图空间数据，或者通过备份目录恢复数据。 +BR 企业版工具是一款命令行界面（CLI）工具，可以帮助备份{{nebula.name}}的图空间数据，或者通过备份目录恢复数据。 操作步骤如下： @@ -66,7 +66,7 @@ NebulaGraph Agent 以二进制形式存在各个机器的安装目录中，通 !!! note - 启动 Agent 前，确保已经启动集群中的 Meta 服务，并且 Agent 有对应 NebulaGraph 服务目录和备份目录的读写权限。 + 启动 Agent 前，确保已经启动集群中的 Meta 服务，并且 Agent 有对应{{nebula.name}}服务目录和备份目录的读写权限。 ``` sudo nohup ./agent --agent=":8888" --meta=":9559" > nebula_agent.log 2>&1 & diff --git a/docs-2.0/backup-and-restore/nebula-br-ent/3.backup-data.md b/docs-2.0/backup-and-restore/nebula-br-ent/3.backup-data.md index aa01af5fd41..6872394ccf9 100644 --- a/docs-2.0/backup-and-restore/nebula-br-ent/3.backup-data.md +++ b/docs-2.0/backup-and-restore/nebula-br-ent/3.backup-data.md @@ -1,12 +1,12 @@ # 使用 BR（企业版）备份数据 -用户可以通过 BR 企业版工具备份 NebulaGraph 企业版数据。支持增量和全量备份，支持备份数据至本地及兼容亚马逊对象存储（Amazon S3）服务接口的云存储服务中。本文介绍如何备份数据。 +用户可以通过 BR 企业版工具备份{{nebula.name}}企业版数据。支持增量和全量备份，支持备份数据至本地及兼容亚马逊对象存储（Amazon S3）服务接口的云存储服务中。本文介绍如何备份数据。 ## 背景信息 - 全量备份是指将数据库中的所有数据进行备份。 - 增量备份是指备份上一次备份后变化或者修改过的数据。上一次备份可以是全量备份或者增量备份。 -- 关于 NebulaGraph 的数据目录结构，参见（默认）路径`usr/local/nebula-ent/data`。 +- 关于{{nebula.name}}的数据目录结构，参见（默认）路径`usr/local/nebula-ent/data`。 ## 注意事项 @@ -14,12 +14,12 @@ - 数据备份过程中，指定图空间中的 DDL 和 DML 语句将会阻塞，建议在业务低峰期进行操作。 - 执行增量备份的集群和指定的上一次备份的集群需为同一个，并且和指定的上一次备份的（存储桶）路径需相同。 - 确保每次增量备份距离上一次备份的时间小于一个[`wal_ttl`](../../5.configurations-and-logs/1.configurations/4.storage-config.md)的时间。 -- 确保 Agent 有对应 NebulaGraph 安装目录和备份目录的读写权限。 +- 确保 Agent 有对应{{nebula.name}}安装目录和备份目录的读写权限。 ## 准备工作 -- 已启动 NebulaGraph 服务。 +- 已启动{{nebula.name}}服务。 - 已安装 [BR 企业版工具和 Agent 插件](2.install-tools.md)并在集群中的每个机器上运行 Agent。 @@ -197,7 +197,7 @@ ## 下一步 -备份目录生成后，可以将备份目录的数据恢复到 NebulaGraph 中。具体操作，参见[恢复数据](4.restore-data.md)。 +备份目录生成后，可以将备份目录的数据恢复到{{nebula.name}}中。具体操作，参见[恢复数据](4.restore-data.md)。 !!! caution diff --git a/docs-2.0/backup-and-restore/nebula-br-ent/4.restore-data.md b/docs-2.0/backup-and-restore/nebula-br-ent/4.restore-data.md index af9e2c43f50..0b5014f1b41 100644 --- a/docs-2.0/backup-and-restore/nebula-br-ent/4.restore-data.md +++ b/docs-2.0/backup-and-restore/nebula-br-ent/4.restore-data.md @@ -1,6 +1,6 @@ # 使用 BR（企业版）恢复数据 -如果使用[备份工具](2.install-tools.md)备份了 NebulaGraph 的数据，可以通过备份目录进行数据恢复。本文介绍如何通过备份目录恢复数据。 +如果使用[备份工具](2.install-tools.md)备份了{{nebula.name}}的数据，可以通过备份目录进行数据恢复。本文介绍如何通过备份目录恢复数据。 ## 注意事项 @@ -11,7 +11,7 @@ - 已安装 [BR 企业版工具和 Agent 插件](2.install-tools.md)并在集群中的**每个**机器上运行 Agent。 -- 确认没有应用程序连接到待恢复数据的 NebulaGraph 集群。 +- 确认没有应用程序连接到待恢复数据的{{nebula.name}}集群。 - 确认原集群和目标集群的 Storage 主机数量一致。 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 f09f071f1d9..a845233c632 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 @@ -1,6 +1,6 @@ # 什么是 Backup&Restore -Backup&Restore（简称 BR）是一款命令行界面（CLI）工具，可以帮助备份 NebulaGraph 的图空间数据，或者通过备份文件恢复数据。 +Backup&Restore（简称 BR）是一款命令行界面（CLI）工具，可以帮助备份{{nebula.name}}的图空间数据，或者通过备份文件恢复数据。 ## 功能 @@ -8,19 +8,19 @@ Backup&Restore（简称 BR）是一款命令行界面（CLI）工具，可以帮 - 支持基于以下备份文件恢复数据： - 本地磁盘（SSD 或 HDD），建议仅在测试环境使用。 - 兼容亚马逊对象存储（Amazon S3）云存储服务接口，例如：阿里云对象存储（Alibaba Cloud OSS）、MinIO、Ceph RGW 等。 -- 支持备份并恢复整个 NebulaGraph 集群。 +- 支持备份并恢复整个{{nebula.name}}集群。 - （实验性功能）支持备份指定图空间数据。 ## 限制 -- NebulaGraph 版本需要为 v3.x。 +- {{nebula.name}}版本需要为 v3.x。 - 数据备份仅支持全量备份，不支持增量备份。 -- NebulaGraph Listener 暂时不支持备份，且全文索引也不支持备份。 +- Listener 暂时不支持备份，且全文索引也不支持备份。 - 如果备份数据到本地磁盘，备份的文件将会放置在每个服务器的本地路径中。也可以在本地挂载 NFS 文件系统，以便将备份数据还原到不同的主机上。 - 备份图空间只能恢复到原集群，不能跨集群恢复，并且集群的 Storage 主机数量及 IP 需一致。还原指定图空间时将清除集群中其余所有图空间。 - 数据备份过程中，指定图空间中的 DDL 和 DML 语句将会阻塞，我们建议在业务低峰期进行操作，例如凌晨 2 点至 5 点。 - 数据恢复期间有一段时间服务会被停止。 -- 不支持在容器部署的 NebulaGraph 集群中使用 BR。 +- 不支持在容器部署的{{nebula.name}}集群中使用 BR。 - 几种部署方式功能基本相同，在使用 Studio 时可能会受到限制。详细信息，参考[使用限制](st-ug-limitations.md)。 ## 产品功能 -Studio 可以方便管理 NebulaGraph 图数据，具备以下功能： +Studio 可以方便管理{{nebula.name}}数据，具备以下功能： - 使用 **Schema** 管理功能，用户可以使用图形界面完成图空间、Tag（标签）、Edge Type（边类型）、索引的创建，查看图空间的统计数据，快速上手 NebulaGraph。 @@ -30,27 +26,23 @@ Studio 可以方便管理 NebulaGraph 图数据，具备以下功能： 如果有以下任一需求，都可以使用 Studio： -- 已经安装部署了 NebulaGraph 数据库，想使用 GUI 工具创建 Schema、导入数据、执行 nGQL 语句查询。 +- 已经安装部署了{{nebula.name}}，想使用 GUI 工具创建 Schema、导入数据、执行 nGQL 语句查询。 - 刚开始学习 nGQL（NebulaGraph Query Language），但是不习惯用命令行工具，更希望使用 GUI 工具查看语句输出的结果。 ## 身份验证 - - -因为 NebulaGraph 默认不启用身份验证，所以用户可以使用 `root` 账号和任意密码登录 Studio。 +因为{{nebula.name}}默认不启用身份验证，所以用户可以使用 `root` 账号和任意密码登录 Studio。 -当 NebulaGraph 启用了身份验证后，用户只能使用指定的账号和密码登录 Studio。关于 NebulaGraph 的身份验证功能，参考 [身份验证](../../7.data-security/1.authentication/1.authentication.md "点击前往 NebulaGraph 官网")。 +当{{nebula.name}}启用了身份验证后，用户只能使用指定的账号和密码登录 Studio。关于{{nebula.name}}的身份验证功能，参考 [身份验证](../../7.data-security/1.authentication/1.authentication.md "点击前往{{nebula.name}}官网")。 ## 版本兼容性 !!! Note - Studio 版本发布节奏独立于 NebulaGraph 内核，其命名方式也不参照内核命名规则，两者兼容对应关系如下表。 + Studio 版本发布节奏独立于{{nebula.name}}内核，其命名方式也不参照内核命名规则，两者兼容对应关系如下表。 -| NebulaGraph 版本 | Studio 版本 | +|{{nebula.name}}版本 | Studio 版本 | | --- | --- | | 3.4.0 ~ 3.4.1| 3.6.0、3.5.1、3.5.0 | | 3.3.0 | 3.5.1、3.5.0 | @@ -66,14 +58,6 @@ Studio 可以方便管理 NebulaGraph 图数据，具备以下功能： Studio 处于持续开发状态中。用户可以通过 [Studio 版本更新说明](../../20.appendix/release-notes/studio-release-note.md)查看最新发布的功能。 - - 成功连接 Studio 后，用户可以在页面右上角点击用户头像，再点击 **更新日志**，查看 Studio 的版本更新说明。 ![在页面右上角点击头像，并在弹出菜单里点击“新发布”](https://docs-cdn.nebula-graph.com.cn/figures/st-ug-001-cn.png) diff --git a/docs-2.0/nebula-studio/deploy-connect/st-ug-connect.md b/docs-2.0/nebula-studio/deploy-connect/st-ug-connect.md index 8944ba70267..55a5cf43031 100644 --- a/docs-2.0/nebula-studio/deploy-connect/st-ug-connect.md +++ b/docs-2.0/nebula-studio/deploy-connect/st-ug-connect.md @@ -1,23 +1,20 @@ # 连接数据库 - -在成功启动 Studio 后，用户需要配置连接 NebulaGraph。本文主要描述 Studio 如何连接 NebulaGraph 数据库。 +在成功启动 Studio 后，用户需要配置连接 NebulaGraph。本文主要描述 Studio 如何连接{{nebula.name}}。 ## 前提条件 -在连接 NebulaGraph 数据库前，用户需要确认以下信息： +在连接{{nebula.name}}数据库前，用户需要确认以下信息： - Studio 已经启动。详细信息参考[部署 Studio](st-ug-deploy.md)。 -- NebulaGraph 的 Graph 服务本机 IP 地址以及服务所用端口。默认端口为 `9669`。 +- {{nebula.name}}的 Graph 服务本机 IP 地址以及服务所用端口。默认端口为 `9669`。 -- NebulaGraph 数据库登录账号信息，包括用户名和密码。 +- {{nebula.name}}登录账号信息，包括用户名和密码。 ## 操作步骤 -按以下步骤连接 NebulaGraph 数据库： +按以下步骤连接{{nebula.name}}： 1. 在浏览器地址栏输入 `http://:7001`。 @@ -27,16 +24,16 @@ 2. 在 Studio 的 **配置数据库** 页面上，输入以下信息： - - **Graphd IP 地址**：填写 NebulaGraph 的 Graph 服务本机 IP 地址。例如`192.168.10.100`。 + - **Graphd IP 地址**：填写{{nebula.name}}的 Graph 服务本机 IP 地址。例如`192.168.10.100`。 !!! Note - - 即使 NebulaGraph 数据库与 Studio 部署在同一台机器上，用户也必须填写这台机器的本机 IP 地址，而不是 `127.0.0.1` 或者 `localhost`。 - - 在新的标签页连接另一个 NebulaGraph 数据库时，会覆盖旧标签页的会话。如果需要同时登录多个 NebulaGraph 数据库，可以用不同的浏览器或者无痕模式。 + - 即使{{nebula.name}}与 Studio 部署在同一台机器上，用户也必须填写这台机器的本机 IP 地址，而不是 `127.0.0.1` 或者 `localhost`。 + - 在新的标签页连接另一个{{nebula.name}}时，会覆盖旧标签页的会话。如果需要同时登录多个{{nebula.name}}，可以用不同的浏览器或者无痕模式。 - **Port**：Graphd 服务的端口。默认为`9669`。 - - **用户名** 和 **密码**：根据 NebulaGraph 的身份验证设置填写登录账号和密码。 + - **用户名** 和 **密码**：根据{{nebula.name}}的身份验证设置填写登录账号和密码。 - 如果未启用身份验证，可以填写默认用户名 `root` 和任意密码。 - 如果已启用身份验证，但是未创建账号信息，用户只能以 GOD 角色登录，必须填写 `root` 及对应的密码 `nebula`。 - 如果已启用身份验证，同时又创建了不同的用户并分配了角色，不同角色的用户使用自己的账号和密码登录。 @@ -53,7 +50,7 @@ ## 后续操作 -成功连接 NebulaGraph 数据库后，用户可以执行以下操作： +成功连接{{nebula.name}}后，用户可以执行以下操作： - 使用[**控制台**](../quick-start/st-ug-create-schema.md)或者 [**Schema**](../manage-schema/st-ug-crud-space.md) 页面管理 Schema。 - [批量导入数据](../quick-start/st-ug-import-data.md)。 @@ -70,6 +67,6 @@ 使用云服务版 Studio 时，用户不能清除连接。 --> -如果需要重新连接 NebulaGraph 数据库，可以登出后重新配置数据库。 +如果需要重新连接{{nebula.name}}，可以登出后重新配置数据库。 在页面右上角单击用户头像，单击 **登出**。 diff --git a/docs-2.0/nebula-studio/deploy-connect/st-ug-deploy.md b/docs-2.0/nebula-studio/deploy-connect/st-ug-deploy.md index 5263aa841e7..05e2273d50f 100644 --- a/docs-2.0/nebula-studio/deploy-connect/st-ug-deploy.md +++ b/docs-2.0/nebula-studio/deploy-connect/st-ug-deploy.md @@ -1,7 +1,4 @@ # 部署 Studio - 本文介绍如何在本地通过 RPM、DEB、tar 包和 Docker 部署 Studio。 @@ -11,7 +8,7 @@ NebulaGraph Studio（ 以下简称 Studio ）支持云端或本地部署。云 在部署 RPM 版 Studio 之前，用户需要确认以下信息： -- NebulaGraph 服务已经部署并启动。详细信息，参考 [NebulaGraph 安装部署](../../4.deployment-and-installation/1.resource-preparations.md "点击前往 NebulaGraph 安装部署")。 +- {{nebula.name}}服务已经部署并启动。详细信息，参考 [{{nebula.name}}安装部署](../../4.deployment-and-installation/1.resource-preparations.md "点击前往{{nebula.name}}安装部署")。 - 使用的 Linux 发行版为 CentOS ，已安装 lsof。 @@ -25,7 +22,7 @@ NebulaGraph Studio（ 以下简称 Studio ）支持云端或本地部署。云 1. 根据需要选择并下载 RPM 包，建议选择最新版本。常用下载链接如下： - | 安装包 | 检验和 | 适用 NebulaGraph 版本 | + | 安装包 | 检验和 | 适用{{nebula.name}}版本 | | ----- | ----- | ----- | | [nebula-graph-studio-{{studio.release}}.x86_64.rpm](https://oss-cdn.nebula-graph.com.cn/nebula-graph-studio/{{studio.release}}/nebula-graph-studio-{{studio.release}}.x86_64.rpm) | [nebula-graph-studio-{{studio.release}}.x86_64.rpm.sha256](https://oss-cdn.nebula-graph.com.cn/nebula-graph-studio/{{studio.release}}/nebula-graph-studio-{{studio.release}}.x86_64.rpm.sha256) | {{ nebula.release }} | @@ -105,7 +102,7 @@ $ systemctl restart nebula-graph-studio.service 在通过 DEB 部署安装 Studio 之前，用户需要确认以下信息： -- NebulaGraph 服务已经部署并启动。详细信息，参考 [NebulaGraph 安装部署](../../4.deployment-and-installation/1.resource-preparations.md "点击前往 NebulaGraph 安装部署")。 +- {{nebula.name}}服务已经部署并启动。详细信息，参考 [{{nebula.name}}安装部署](../../4.deployment-and-installation/1.resource-preparations.md "点击前往{{nebula.name}}安装部署")。 - 使用的 Linux 发行版为 Ubuntu。 @@ -121,7 +118,7 @@ $ systemctl restart nebula-graph-studio.service 1. 根据需要选择并下载 DEB 包，建议选择最新版本。常用下载链接如下： - | 安装包 | 检验和 | 适用 NebulaGraph 版本 | + | 安装包 | 检验和 | 适用{{nebula.name}}版本 | | ----- | ----- | ----- | | [nebula-graph-studio-{{studio.release}}.x86_64.deb](https://oss-cdn.nebula-graph.com.cn/nebula-graph-studio/{{studio.release}}/nebula-graph-studio-{{studio.release}}.x86_64.deb) | [nebula-graph-studio-{{studio.release}}.x86_64.deb.sha256](https://oss-cdn.nebula-graph.com.cn/nebula-graph-studio/{{studio.release}}/nebula-graph-studio-{{studio.release}}.x86_64.deb.sha256) | {{ nebula.release }} | @@ -153,7 +150,7 @@ $ sudo dpkg -r nebula-graph-studio 在部署 tar 包安装的 Studio 之前，用户需要确认以下信息： -- NebulaGraph 服务已经部署并启动。详细信息，参考 [NebulaGraph 安装部署](../../4.deployment-and-installation/1.resource-preparations.md "点击前往 NebulaGraph 安装部署")。 +- {{nebula.name}}服务已经部署并启动。详细信息，参考 [{{nebula.name}}安装部署](../../4.deployment-and-installation/1.resource-preparations.md "点击前往{{nebula.name}}安装部署")。 - 确保以下端口未被占用。 @@ -165,7 +162,7 @@ $ sudo dpkg -r nebula-graph-studio 1. 根据需要下载 tar 包，建议选择最新版本。 - | 安装包 | Studio 版本 |适用 NebulaGraph 版本 | + | 安装包 | Studio 版本 |适用{{nebula.name}}版本 | | --- | --- |---| | [nebula-graph-studio-{{studio.release}}.x86_64.tar.gz](https://oss-cdn.nebula-graph.com.cn/nebula-graph-studio/{{studio.release}}/nebula-graph-studio-{{studio.release}}.x86_64.tar.gz) | {{studio.release}} | {{ nebula.release }} | @@ -200,7 +197,7 @@ $ kill $(lsof -t -i :7001) # stop nebula-graph-studio 在部署 Docker 版 Studio 之前，用户需要确认以下信息： -- NebulaGraph 服务已经部署并启动。详细信息，参考 [NebulaGraph 安装部署](../../4.deployment-and-installation/1.resource-preparations.md "点击前往 NebulaGraph 安装部署")。 +- {{nebula.name}}服务已经部署并启动。详细信息，参考 [{{nebula.name}}安装部署](../../4.deployment-and-installation/1.resource-preparations.md "点击前往{{nebula.name}}安装部署")。 - 在即将运行 Docker 版 Studio 的机器上安装并启动 Docker Compose。详细信息参考 [Docker Compose 文档](https://docs.docker.com/compose/install/ "点击前往 Docker 文档中心")。 - 确保以下端口未被占用。 @@ -225,11 +222,11 @@ $ kill $(lsof -t -i :7001) # stop nebula-graph-studio ### 操作步骤 -在命令行工具中按以下步骤依次运行命令，部署并启动 Docker 版 Studio，这里我们用 NebulaGraph 版本为 {{nebula.release}} 的进行演示： +在命令行工具中按以下步骤依次运行命令，部署并启动 Docker 版 Studio，这里我们用{{nebula.name}}版本为 {{nebula.release}} 的进行演示： 1. 下载 Studio 的部署配置文件。 - | 安装包 | 适用 NebulaGraph 版本 | + | 安装包 | 适用{{nebula.name}}版本 | | ----- | ----- | | [nebula-graph-studio-{{studio.release}}.tar.gz](https://oss-cdn.nebula-graph.com.cn/nebula-graph-studio/{{studio.release}}/nebula-graph-studio-{{studio.release}}.tar.gz) | {{nebula.release}} | diff --git a/docs-2.0/nebula-studio/manage-schema/st-ug-crud-edge-type.md b/docs-2.0/nebula-studio/manage-schema/st-ug-crud-edge-type.md index cca26113221..1ef8494b5cf 100644 --- a/docs-2.0/nebula-studio/manage-schema/st-ug-crud-edge-type.md +++ b/docs-2.0/nebula-studio/manage-schema/st-ug-crud-edge-type.md @@ -1,12 +1,12 @@ # 操作 Edge type -在 NebulaGraph 数据库中创建图空间后，用户可能需要创建 Edge type（边类型）。用户可以选择使用 **控制台** 或者 **Schema** 操作 Edge type。本文仅说明如何使用 **Schema** 操作 Edge type。 +在{{nebula.name}}中创建图空间后，用户可能需要创建 Edge type（边类型）。用户可以选择使用 **控制台** 或者 **Schema** 操作 Edge type。本文仅说明如何使用 **Schema** 操作 Edge type。 ## 前提条件 在 Studio 上操作 Edge type 之前，用户必须确认以下信息： -- Studio 已经连接到 NebulaGraph 数据库。 +- Studio 已经连接到{{nebula.name}}。 - 图空间已经创建。 @@ -36,7 +36,7 @@ - （可选）输入默认值。 - （可选）输入属性备注。 - 4. **设置TTL（存活时间）**（可选）：Edge type 未设置索引时，用户可以设置 TTL。勾选**设置TTL（存活时间）**，设置`TTL_COL`和`TTL_DURATION`（单位：秒）。详情参考 [TTL 配置](../../3.ngql-guide/8.clauses-and-options/ttl-options.md "点击前往 NebulaGraph 网站")。 + 4. **设置TTL（存活时间）**（可选）：Edge type 未设置索引时，用户可以设置 TTL。勾选**设置TTL（存活时间）**，设置`TTL_COL`和`TTL_DURATION`（单位：秒）。详情参考 [TTL 配置](../../3.ngql-guide/8.clauses-and-options/ttl-options.md "点击前往{{nebula.name}}网站")。 6. 完成设置后，在 **对应的 nGQL 语句** 面板上，用户能看到与上述配置等价的 nGQL 语句。 @@ -64,9 +64,9 @@ - 如果要修改属性：在 **定义属性** 区域，找到需要修改的属性，在右侧点击 **编辑**，修改后点击 **确认**。 - 如果要删除属性：在 **定义属性** 区域，找到需要删除的属性，在右侧点击 **删除**，然后点击 **确认**。 - 如果要添加属性：在 **定义属性** 区域，点击 **+ 添加属性**，设置属性信息，点击 **确认**。详细说明参考[创建边类型](#_2) 。 - - 如果要修改 TTL 信息：在 **设置 TTL** 区域，点击 **编辑**，修改后点击 **确认**。详情参考 [TTL 配置](../../3.ngql-guide/8.clauses-and-options/ttl-options.md "点击前往 NebulaGraph 网站")。 + - 如果要修改 TTL 信息：在 **设置 TTL** 区域，点击 **编辑**，修改后点击 **确认**。详情参考 [TTL 配置](../../3.ngql-guide/8.clauses-and-options/ttl-options.md "点击前往{{nebula.name}}网站")。 - 如果要删除已经配置的 TTL 信息：在 **设置 TTL** 区域，取消勾选 **设置TTL（存活时间）**，然后点击 **确定**。 - - 如果要配置 TTL 信息：在 **设置 TTL** 区域，勾选 **设置TTL（存活时间）**，设置`TTL_COL`和`TTL_DURATION`（单位：秒），点击 **确认**。详情参考 [TTL 配置](../../3.ngql-guide/8.clauses-and-options/ttl-options.md "点击前往 NebulaGraph 网站")。 + - 如果要配置 TTL 信息：在 **设置 TTL** 区域，勾选 **设置TTL（存活时间）**，设置`TTL_COL`和`TTL_DURATION`（单位：秒），点击 **确认**。详情参考 [TTL 配置](../../3.ngql-guide/8.clauses-and-options/ttl-options.md "点击前往{{nebula.name}}网站")。 !!! note diff --git a/docs-2.0/nebula-studio/manage-schema/st-ug-crud-index.md b/docs-2.0/nebula-studio/manage-schema/st-ug-crud-index.md index 602d16fad53..bf0c08f969b 100644 --- a/docs-2.0/nebula-studio/manage-schema/st-ug-crud-index.md +++ b/docs-2.0/nebula-studio/manage-schema/st-ug-crud-index.md @@ -4,13 +4,13 @@ !!! Note - 一般在创建了 Tag 或者 Edge type 之后即可创建索引，但是，索引会影响写性能，所以，建议先导入数据，再批量重建索引。关于索引的详细信息，参考 [索引介绍](../../3.ngql-guide/14.native-index-statements/README.md "点击前往 NebulaGraph 网站")。 + 一般在创建了 Tag 或者 Edge type 之后即可创建索引，但是，索引会影响写性能，所以，建议先导入数据，再批量重建索引。关于索引的详细信息，参考 [索引介绍](../../3.ngql-guide/14.native-index-statements/README.md "点击前往{{nebula.name}}网站")。 ## 前提条件 在 Studio 上操作索引之前，用户必须确认以下信息： -- Studio 已经连接到 NebulaGraph 数据库。 +- Studio 已经连接到{{nebula.name}}。 - 图空间、Tag 和 Edge type 已经创建。 - 当前登录的账号拥有 GOD、ADMIN 或者 DBA 的权限。 @@ -34,7 +34,7 @@ !!! Note - 索引属性的顺序会影响 `LOOKUP` 语句的查询结果。详细信息，参考 [LOOKUP](../../3.ngql-guide/7.general-query-statements/5.lookup.md "点击前往 NebulaGraph 网站")。 + 索引属性的顺序会影响 `LOOKUP` 语句的查询结果。详细信息，参考 [LOOKUP](../../3.ngql-guide/7.general-query-statements/5.lookup.md "点击前往{{nebula.name}}网站")。 6. 完成设置后，在 **对应的 nGQL** 面板，用户能看到与上述配置等价的 nGQL 语句。 diff --git a/docs-2.0/nebula-studio/manage-schema/st-ug-crud-space.md b/docs-2.0/nebula-studio/manage-schema/st-ug-crud-space.md index 9e23278e090..ee7d60ab2e9 100644 --- a/docs-2.0/nebula-studio/manage-schema/st-ug-crud-space.md +++ b/docs-2.0/nebula-studio/manage-schema/st-ug-crud-space.md @@ -1,15 +1,15 @@ # 操作图空间 -Studio 连接到 NebulaGraph 数据库后，用户可以创建或删除图空间。用户可以使用 **控制台** 或者 **Schema** 操作图空间。本文仅说明如何使用 **Schema** 操作图空间。 +Studio 连接到{{nebula.name}}后，用户可以创建或删除图空间。用户可以使用 **控制台** 或者 **Schema** 操作图空间。本文仅说明如何使用 **Schema** 操作图空间。 ## 前提条件 操作图空间之前，用户需要确保以下信息： -- Studio 已经连接到 NebulaGraph 数据库。 +- Studio 已经连接到{{nebula.name}}。 - 当前登录的账号拥有创建或删除图空间的权限，即： - - 如果 NebulaGraph 未开启身份验证，用户以默认用户名 `user` 账号和任意密码登录。 - - 如果 NebulaGraph 已开启身份验证，用户以 `root` 账号及其密码登录。 + - 如果{{nebula.name}}未开启身份验证，用户以默认用户名 `user` 账号和任意密码登录。 + - 如果{{nebula.name}}已开启身份验证，用户以 `root` 账号及其密码登录。 ## 创建图空间 diff --git a/docs-2.0/nebula-studio/manage-schema/st-ug-crud-tag.md b/docs-2.0/nebula-studio/manage-schema/st-ug-crud-tag.md index 1c91777d7f9..df26168fb17 100644 --- a/docs-2.0/nebula-studio/manage-schema/st-ug-crud-tag.md +++ b/docs-2.0/nebula-studio/manage-schema/st-ug-crud-tag.md @@ -1,12 +1,12 @@ # 操作 Tag（点类型） -在 NebulaGraph 数据库中创建图空间后，用户需要创建 Tag（点类型）。用户可以选择使用 **控制台** 或者 **Schema** 管理功能操作 Tag。本文仅说明如何使用 **Schema** 管理功能操作 Tag。 +在{{nebula.name}}中创建图空间后，用户需要创建 Tag（点类型）。用户可以选择使用 **控制台** 或者 **Schema** 管理功能操作 Tag。本文仅说明如何使用 **Schema** 管理功能操作 Tag。 ## 前提条件 在 Studio 上操作 Tag 之前，用户必须确认以下信息： -- Studio 已经连接到 NebulaGraph 数据库。 +- Studio 已经连接到{{nebula.name}}。 - 图空间已经创建。 - 当前登录的账号拥有 GOD、ADMIN 或者 DBA 的权限。 @@ -38,7 +38,7 @@ - （可选）输入属性备注。 - 4. **设置TTL（存活时间）**（可选）：Tag 未设置索引时，用户可以设置 TTL。勾选**设置TTL（存活时间）**，设置`TTL_COL`和`TTL_DURATION`（单位：秒）。详情参考 [TTL 配置](../../3.ngql-guide/8.clauses-and-options/ttl-options.md "点击前往 NebulaGraph 网站")。 + 4. **设置TTL（存活时间）**（可选）：Tag 未设置索引时，用户可以设置 TTL。勾选**设置TTL（存活时间）**，设置`TTL_COL`和`TTL_DURATION`（单位：秒）。详情参考 [TTL 配置](../../3.ngql-guide/8.clauses-and-options/ttl-options.md "点击前往{{nebula.name}}网站")。 6. 完成设置后，在 **对应的nGQL语句** 面板，用户能看到与上述配置等价的 nGQL 语句。 @@ -64,9 +64,9 @@ - 如果要修改属性：在 **定义属性** 区域，找到需要修改的属性，在右侧点击 **编辑**，修改后点击 **确认**。 - 如果要删除属性：在 **定义属性** 区域，找到需要删除的属性，在右侧点击 **删除**，然后点击 **确认**。 - 如果要添加属性：在 **定义属性** 区域，点击 **+ 添加属性**，设置属性信息，点击 **确认**。详细说明参考[创建 Tag](#tag_1) 。 - - 如果要修改 TTL 信息：在 **设置 TTL** 区域，点击 **编辑**，修改后点击 **确认**。详情参考 [TTL 配置](../../3.ngql-guide/8.clauses-and-options/ttl-options.md "点击前往 NebulaGraph 网站")。 + - 如果要修改 TTL 信息：在 **设置 TTL** 区域，点击 **编辑**，修改后点击 **确认**。详情参考 [TTL 配置](../../3.ngql-guide/8.clauses-and-options/ttl-options.md "点击前往{{nebula.name}}网站")。 - 如果要删除已经配置的 TTL 信息：在 **设置 TTL** 区域，取消勾选 **设置TTL（存活时间）**，然后点击 **确定**。 - - 如果要配置 TTL 信息：在 **设置 TTL** 区域，勾选 **设置TTL（存活时间）**，设置`TTL_COL`和`TTL_DURATION`（单位：秒），点击 **确认**。详情参考 [TTL 配置](../../3.ngql-guide/8.clauses-and-options/ttl-options.md "点击前往 NebulaGraph 网站")。 + - 如果要配置 TTL 信息：在 **设置 TTL** 区域，勾选 **设置TTL（存活时间）**，设置`TTL_COL`和`TTL_DURATION`（单位：秒），点击 **确认**。详情参考 [TTL 配置](../../3.ngql-guide/8.clauses-and-options/ttl-options.md "点击前往{{nebula.name}}网站")。 !!! note diff --git a/docs-2.0/nebula-studio/quick-start/st-ug-import-data.md b/docs-2.0/nebula-studio/quick-start/st-ug-import-data.md index 3cf035a9878..f14c4c5bd02 100644 --- a/docs-2.0/nebula-studio/quick-start/st-ug-import-data.md +++ b/docs-2.0/nebula-studio/quick-start/st-ug-import-data.md @@ -6,9 +6,9 @@ 导入数据之前，需要确认以下信息： -- Studio 已经连接到 NebulaGraph 数据库。 +- Studio 已经连接到{{nebula.name}}。 -- NebulaGraph 数据库里已经创建 Schema。 +-{{nebula.name}}里已经创建 Schema。 - CSV 文件符合 Schema 要求。 @@ -58,7 +58,7 @@ 4. 完成设置后，点击 **导入** 按钮。 -5. 用户输入 NebulaGraph 账号的密码后方可导入数据。 +5. 用户输入{{nebula.name}}账号的密码后方可导入数据。 ![输入密码](https://docs-cdn.nebula-graph.com.cn/figures/st-ug-014-cn.png) 6. 导入数据后可以在 **导入数据** 页签内查看日志、下载日志、下载配置文件、删除任务等操作。 From 53873d586a63ebb9b108179cee484bd8b91ac853 Mon Sep 17 00:00:00 2001 From: cooper-lzy <78672629+cooper-lzy@users.noreply.github.com> Date: Wed, 12 Apr 2023 15:39:27 +0800 Subject: [PATCH 129/137] update --- .../graph-computing/algorithm-description.md | 12 +-- docs-2.0/graph-computing/nebula-algorithm.md | 32 +++---- docs-2.0/graph-computing/nebula-analytics.md | 46 +++++----- docs-2.0/nebula-cloud/1.what-is-cloud.md | 10 +-- .../1.create-service-instance.md | 24 +++--- .../2.use-cloud-services.md | 24 +++--- .../3.how-to-set-solution.md | 2 +- .../4.user-role-description.md | 6 +- .../5.solution/5.0.introduce-solution.md | 2 +- .../5.solution/5.1.supporting-application.md | 6 +- .../5.2.connection-configuration-and-use.md | 6 +- .../5.3.role-and-authority-management.md | 6 +- .../1.what-is-dashboard-ent.md | 10 +-- .../2.deploy-connect-dashboard-ent.md | 2 +- .../1.create-cluster.md | 8 +- .../2.import-cluster.md | 14 ++-- .../4.cluster-operator/1.overview.md | 14 ++-- .../4.cluster-operator/6.settings.md | 4 +- .../4.cluster-operator/9.notification.md | 2 +- .../cluster-information/audit-log.md | 4 +- .../cluster-information/job-management.md | 4 +- .../cluster-information/overview-info.md | 8 +- .../operator/backup-and-restore.md | 16 ++-- .../4.cluster-operator/operator/scale.md | 2 +- .../operator/version-upgrade.md | 12 +-- .../7.monitor-parameter.md | 6 +- docs-2.0/nebula-dashboard-ent/8.faq.md | 18 ++-- .../system-settings/manage-package.md | 2 +- .../nebula-dashboard/1.what-is-dashboard.md | 6 +- .../nebula-dashboard/2.deploy-dashboard.md | 14 ++-- .../nebula-dashboard/3.connect-dashboard.md | 6 +- docs-2.0/nebula-dashboard/4.use-dashboard.md | 6 +- .../nebula-dashboard/6.monitor-parameter.md | 6 +- .../about-exchange/ex-ug-limitations.md | 2 +- .../about-exchange/ex-ug-what-is-exchange.md | 32 +++---- docs-2.0/nebula-exchange/ex-ug-FAQ.md | 16 ++-- docs-2.0/nebula-exchange/ex-ug-compile.md | 4 +- .../ex-ug-para-import-command.md | 2 +- .../parameter-reference/ex-ug-parameter.md | 30 +++---- .../use-exchange/ex-ug-export-from-nebula.md | 30 +++---- .../ex-ug-import-from-clickhouse.md | 56 ++++++------- .../use-exchange/ex-ug-import-from-csv.md | 80 +++++++++--------- .../use-exchange/ex-ug-import-from-hbase.md | 60 ++++++------- .../use-exchange/ex-ug-import-from-hive.md | 62 +++++++------- .../use-exchange/ex-ug-import-from-jdbc.md | 56 ++++++------- .../use-exchange/ex-ug-import-from-json.md | 84 +++++++++---------- .../use-exchange/ex-ug-import-from-kafka.md | 60 ++++++------- .../ex-ug-import-from-maxcompute.md | 58 ++++++------- 48 files changed, 486 insertions(+), 486 deletions(-) diff --git a/docs-2.0/graph-computing/algorithm-description.md b/docs-2.0/graph-computing/algorithm-description.md index d80975e221f..5a92eb7149c 100644 --- a/docs-2.0/graph-computing/algorithm-description.md +++ b/docs-2.0/graph-computing/algorithm-description.md @@ -3,7 +3,7 @@ 图计算可以检测图结构，例如图中社区的检测、图的划分等，也可以揭示各个点之间关联关系的内在特征，例如点的中心性、相似性等。本文介绍相关算法和参数。 !!! note @@ -21,7 +21,7 @@ NebulaGraph 支持多种图计算工具，本文介绍这些工具支持的算 - 如果数据源来自 HDFS，需要指定 CSV 文件，包含`src`和`dst`列，部分算法还需要包含`weight`列。 - - 如果数据源来自 NebulaGraph，需要指定边类型，该类型的边提供`src`和`dst`列，部分算法还需要指定边类型的某个属性作为`weight`列。 + - 如果数据源来自{{nebula.name}}，需要指定边类型，该类型的边提供`src`和`dst`列，部分算法还需要指定边类型的某个属性作为`weight`列。 ## 节点重要度算法 @@ -386,7 +386,7 @@ LPA（标签传播）算法是一种基于图的半监督学习方法，其基 |`ITERATIONS`|`10`|最大迭代次数。| |`IS_DIRECTED`|`true`|是否考虑边的方向。如果设置为`false`，系统会自动添加反向边。| |`IS_CALC_MODULARITY`|`false`|是否计算模块度。| - |`IS_OUTPUT_MODULARITY`|`false`|是否计算并输出模块度。设置为`true`时，默认输出到文件的第三列，也可以通过选项`--nebula_output_props`和`--nebula_output_types`输出到 NebulaGraph 中。使用 Explorer 时暂不支持输出到 NebulaGraph 中。| + |`IS_OUTPUT_MODULARITY`|`false`|是否计算并输出模块度。设置为`true`时，默认输出到文件的第三列，也可以通过选项`--nebula_output_props`和`--nebula_output_types`输出到{{nebula.name}}中。使用 Explorer 时暂不支持输出到{{nebula.name}}中。| |`IS_STAT_COMMUNITY`|`false`|是否统计社区的数量。| - 输出参数 @@ -422,7 +422,7 @@ HANP（Hop Attenuation & Node Preference）算法是LPA算法的优化算法， |`IS_DIRECTED`|`true`|是否考虑边的方向。如果设置为`false`，系统会自动添加反向边。| |`PREFERENCE`|`1.0`|对邻居节点度的偏向性。`m>0`表示偏向节点度高的邻居，`m<0`表示偏向节点度低的邻居，`m=0`表示不考虑邻居节点度。| |`HOP_ATT`|`0.1`|衰减因子。取值范围`0`~`1`。值越大衰减的越快，可以传递的次数越少。| - |`IS_OUTPUT_MODULARITY`|`false`|是否计算并输出模块度。设置为`true`时，默认输出到文件的第三列，也可以通过选项`--nebula_output_props`和`--nebula_output_types`输出到 NebulaGraph 中。使用 Explorer 时暂不支持输出到 NebulaGraph 中。| + |`IS_OUTPUT_MODULARITY`|`false`|是否计算并输出模块度。设置为`true`时，默认输出到文件的第三列，也可以通过选项`--nebula_output_props`和`--nebula_output_types`输出到{{nebula.name}}中。使用 Explorer 时暂不支持输出到{{nebula.name}}中。| |`IS_STAT_COMMUNITY`|`false`|是否统计社区的数量。| - 输出参数 @@ -458,7 +458,7 @@ ConnectedComponent（联通分量）算法用于计算出图中的一个子图 |:--|:--|:--| |`IS_DIRECTED`|`true`|是否考虑边的方向。如果设置为`false`，系统会自动添加反向边。| |`IS_CALC_MODULARITY`|`false`|是否计算模块度。| - |`IS_OUTPUT_MODULARITY`|`false`|是否计算并输出模块度。设置为`true`时，默认输出到文件的第三列，也可以通过选项`--nebula_output_props`和`--nebula_output_types`输出到 NebulaGraph 中。使用 Explorer 时暂不支持输出到 NebulaGraph 中。| + |`IS_OUTPUT_MODULARITY`|`false`|是否计算并输出模块度。设置为`true`时，默认输出到文件的第三列，也可以通过选项`--nebula_output_props`和`--nebula_output_types`输出到{{nebula.name}}中。使用 Explorer 时暂不支持输出到{{nebula.name}}中。| |`IS_STAT_COMMUNITY`|`false`|是否统计社区的数量。| - 输出参数 @@ -494,7 +494,7 @@ Louvain 算法是基于模块度的社区发现算法，该算法在效率和效 |`OUTER_ITERATION`|`20`|第一阶段最大迭代次数。| |`INNER_ITERATION`|`10`|第二阶段最大迭代次数。| |`IS_CALC_MODULARITY`|`false`|是否计算模块度。| - |`IS_OUTPUT_MODULARITY`|`false`|是否计算并输出模块度。设置为`true`时，默认输出到文件的第三列，也可以通过选项`--nebula_output_props`和`--nebula_output_types`输出到 NebulaGraph 中。使用 Explorer 时暂不支持输出到 NebulaGraph 中。| + |`IS_OUTPUT_MODULARITY`|`false`|是否计算并输出模块度。设置为`true`时，默认输出到文件的第三列，也可以通过选项`--nebula_output_props`和`--nebula_output_types`输出到{{nebula.name}}中。使用 Explorer 时暂不支持输出到{{nebula.name}}中。| |`IS_STAT_COMMUNITY`|`false`|是否统计社区的数量。| - 输出参数 diff --git a/docs-2.0/graph-computing/nebula-algorithm.md b/docs-2.0/graph-computing/nebula-algorithm.md index 0f3885fef39..ddd2663c242 100644 --- a/docs-2.0/graph-computing/nebula-algorithm.md +++ b/docs-2.0/graph-computing/nebula-algorithm.md @@ -1,12 +1,12 @@ # NebulaGraph Algorithm -[NebulaGraph Algorithm](https://github.com/vesoft-inc/nebula-algorithm) （简称 Algorithm）是一款基于 [GraphX](https://spark.apache.org/graphx/) 的 Spark 应用程序，通过提交 Spark 任务的形式使用完整的算法工具对 NebulaGraph 数据库中的数据执行图计算，也可以通过编程形式调用 lib 库下的算法针对 DataFrame 执行图计算。 +[NebulaGraph Algorithm](https://github.com/vesoft-inc/nebula-algorithm) （简称 Algorithm）是一款基于 [GraphX](https://spark.apache.org/graphx/) 的 Spark 应用程序，通过提交 Spark 任务的形式使用完整的算法工具对{{nebula.name}}数据库中的数据执行图计算，也可以通过编程形式调用 lib 库下的算法针对 DataFrame 执行图计算。 ## 版本兼容性 -NebulaGraph Algorithm 版本和 NebulaGraph 内核的版本对应关系如下。 +NebulaGraph Algorithm 版本和{{nebula.name}}内核的版本对应关系如下。 -|NebulaGraph 版本|NebulaGraph Algorithm 版本| +|{{nebula.name}}版本|NebulaGraph Algorithm 版本| |:---|:---| | nightly | 3.0-SNAPSHOT | | 3.0.0 ~ 3.4.x | 3.x.0 | @@ -19,7 +19,7 @@ NebulaGraph Algorithm 版本和 NebulaGraph 内核的版本对应关系如下。 在使用 Algorithm 之前，用户需要确认以下信息： -- NebulaGraph 服务已经部署并启动。详细信息，参考 [NebulaGraph 安装部署](../4.deployment-and-installation/1.resource-preparations.md "点击前往 NebulaGraph 安装部署")。 +- {{nebula.name}}服务已经部署并启动。详细信息，参考 [{{nebula.name}}安装部署](../4.deployment-and-installation/1.resource-preparations.md "点击前往{{nebula.name}}安装部署")。 - Spark 版本为 2.4.x。 @@ -64,13 +64,13 @@ NebulaGraph Algorithm 支持的图计算算法如下。 !!! note - 如果需要将算法结果写入到 NebulaGraph 中，请确保对应图空间中的 Tag 有和上表对应的属性名称和数据类型。 + 如果需要将算法结果写入到{{nebula.name}}中，请确保对应图空间中的 Tag 有和上表对应的属性名称和数据类型。 ## 实现方法 NebulaGraph Algorithm 实现图计算的流程如下： -1. 利用 NebulaGraph Spark Connector 从 NebulaGraph 数据库中读取图数据为 DataFrame。 +1. 利用 NebulaGraph Spark Connector 从{{nebula.name}}中读取图数据为 DataFrame。 2. 将 DataFrame 转换为 GraphX 的图。 @@ -126,7 +126,7 @@ NebulaGraph Algorithm 实现图计算的流程如下： !!! note - 执行算法的 DataFrame 默认第一列是起始点，第二列是目的点，第三列是边权重（非 NebulaGraph 中的 Rank）。 + 执行算法的 DataFrame 默认第一列是起始点，第二列是目的点，第三列是边权重（非{{nebula.name}}中的 Rank）。 ```bash val prConfig = new PRConfig(5, 1.0) @@ -160,23 +160,23 @@ NebulaGraph Algorithm 实现图计算的流程如下： hasWeight: false } - # NebulaGraph 相关配置 + # {{nebula.name}}相关配置 nebula: { - # 数据源。NebulaGraph 作为图计算的数据源时，nebula.read 的配置才生效。 + # 数据源。{{nebula.name}}作为图计算的数据源时，nebula.read 的配置才生效。 read: { # 所有 Meta 服务的 IP 地址和端口，多个地址用英文逗号（,）分隔。格式："ip1:port1,ip2:port2"。 # 使用 docker-compose 部署，端口需要填写 docker-compose 映射到外部的端口 # 可以用`docker-compose ps`查看 metaAddress: "192.168.*.10:9559" - # NebulaGraph 图空间名称 + # {{nebula.name}}图空间名称 space: basketballplayer - # NebulaGraph Edge type, 多个 labels 时，多个边的数据将合并。 + # {{nebula.name}} Edge type, 多个 labels 时，多个边的数据将合并。 labels: ["serve"] - # NebulaGraph 每个 Edge type 的属性名称，此属性将作为算法的权重列，请确保和 Edge type 对应。 + # {{nebula.name}} 每个 Edge type 的属性名称，此属性将作为算法的权重列，请确保和 Edge type 对应。 weightCols: ["start_year"] } - # 数据落库。图计算结果落库到 NebulaGraph 时，nebula.write 的配置才生效。 + # 数据落库。图计算结果落库到{{nebula.name}}时，nebula.write 的配置才生效。 write:{ # Graph 服务的 IP 地址和端口，多个地址用英文逗号（,）分隔。格式："ip1:port1,ip2:port2"。 # 使用 docker-compose 部署，端口需要填写 docker-compose 映射到外部的端口 @@ -189,9 +189,9 @@ NebulaGraph Algorithm 实现图计算的流程如下： user:root pswd:nebula # 在提交图计算任务之前需要自行创建图空间及 Tag - # NebulaGraph 图空间名称 + # {{nebula.name}}图空间名称 space:nb - # NebulaGraph Tag 名称，图计算结果会写入该 Tag。Tag 中的属性名称固定如下： + # {{nebula.name}} Tag 名称，图计算结果会写入该 Tag。Tag 中的属性名称固定如下： # PageRank：pagerank # Louvain：louvain # ConnectedComponent：cc @@ -256,7 +256,7 @@ NebulaGraph Algorithm 实现图计算的流程如下： !!! note - 当配置为 `sink: nebula` 的时候，意味着算法运算结果将被写回 NebulaGraph 集群，这对写回到的 TAG 中的属性名有隐含的约定。详情参考本文**支持算法**部分。 + 当配置为 `sink: nebula` 的时候，意味着算法运算结果将被写回{{nebula.name}}集群，这对写回到的 TAG 中的属性名有隐含的约定。详情参考本文**支持算法**部分。 2. 提交图计算任务。 diff --git a/docs-2.0/graph-computing/nebula-analytics.md b/docs-2.0/graph-computing/nebula-analytics.md index 49538eccce0..8fe958c8551 100644 --- a/docs-2.0/graph-computing/nebula-analytics.md +++ b/docs-2.0/graph-computing/nebula-analytics.md @@ -1,6 +1,6 @@ # NebulaGraph Analytics -NebulaGraph Analytics 是一款高性能图计算框架工具，支持对 NebulaGraph 数据库中的数据执行图分析。 +NebulaGraph Analytics 是一款高性能图计算框架工具，支持对{{nebula.name}}数据库中的数据执行图分析。 ## 前提条件 @@ -15,17 +15,17 @@ NebulaGraph Analytics 是一款高性能图计算框架工具，支持对 Nebula ## 适用场景 -支持将数据源为 NebulaGraph 集群、HDFS 上的 CSV 文件或本地 CSV 文件中的数据导入 NebulaGraph Analytics，并将图计算结果输出至 NebulaGraph 集群、HDFS 上的 CSV 文件或本地 CSV 文件。 +支持将数据源为{{nebula.name}}集群、HDFS 上的 CSV 文件或本地 CSV 文件中的数据导入 NebulaGraph Analytics，并将图计算结果输出至{{nebula.name}}集群、HDFS 上的 CSV 文件或本地 CSV 文件。 ## 使用限制 -输入和输出均为 NebulaGraph 集群时，图计算结果只能输出到数据源所在的图空间。 +输入和输出均为{{nebula.name}}集群时，图计算结果只能输出到数据源所在的图空间。 ## 版本兼容性 -NebulaGraph Analytics 版本和 NebulaGraph 内核的版本对应关系如下。 +NebulaGraph Analytics 版本和{{nebula.name}}内核的版本对应关系如下。 -|NebulaGraph 版本|NebulaGraph Analytics 版本| +|{{nebula.name}}版本|NebulaGraph Analytics 版本| |:---|:---| |3.4.0 ~ 3.4.1| 3.4.0 | |3.3.0 | 3.3.0 | @@ -93,7 +93,7 @@ NebulaGraph Analytics 支持的图计算算法如下。 -- NebulaGraph：{{nebula.release}}。使用 [Docker Compose 部署](../../4.deployment-and-installation/2.compile-and-install-nebula-graph/3.deploy-nebula-graph-with-docker-compose.md)。 +- {{nebula.name}}：{{nebula.release}}。使用 [Docker Compose 部署](../../4.deployment-and-installation/2.compile-and-install-nebula-graph/3.deploy-nebula-graph-with-docker-compose.md)。 ## 前提条件 开始导入数据之前，用户需要确认以下信息： -- 已经[安装部署 NebulaGraph](../../4.deployment-and-installation/2.compile-and-install-nebula-graph/2.install-nebula-graph-by-rpm-or-deb.md) 并获取如下信息： +- 已经[安装部署{{nebula.name}}](../../4.deployment-and-installation/2.compile-and-install-nebula-graph/2.install-nebula-graph-by-rpm-or-deb.md) 并获取如下信息： - Graph 服务和 Meta 服务的的 IP 地址和端口。 - - 拥有 NebulaGraph 写权限的用户名和密码。 + - 拥有{{nebula.name}}写权限的用户名和密码。 - 已经编译 Exchange。详情请参见[编译 Exchange](../ex-ug-compile.md)。本示例中使用 Exchange {{exchange.release}}。 - 已经安装 Spark。 -- 了解 NebulaGraph 中创建的 Schema 信息，包括 Tag 和 Edge type 的名称、属性等。 +- 了解{{nebula.name}}中创建的 Schema 信息，包括 Tag 和 Edge type 的名称、属性等。 - 已经安装并开启 Hadoop 服务。 ## 操作步骤 -### 步骤 1：在 NebulaGraph 中创建 Schema +### 步骤 1：在{{nebula.name}}中创建 Schema -分析数据，按以下步骤在 NebulaGraph 中创建 Schema： +分析数据，按以下步骤在{{nebula.name}}中创建 Schema： -1. 确认 Schema 要素。NebulaGraph 中的 Schema 要素如下表所示。 +1. 确认 Schema 要素。{{nebula.name}}中的 Schema 要素如下表所示。 | 要素 | 名称 | 属性 | | :--- | :--- | :--- | @@ -97,7 +97,7 @@ oracle> desc serve; | Edge Type | `follow` | `degree int` | | Edge Type | `serve` | `start_year int, end_year int` | -2. 在 NebulaGraph 中创建一个图空间 **basketballplayer**，并创建一个 Schema，如下所示。 +2. 在{{nebula.name}}中创建一个图空间 **basketballplayer**，并创建一个 Schema，如下所示。 ```ngql ## 创建图空间 @@ -144,21 +144,21 @@ oracle> desc serve; } } -# NebulaGraph 相关配置 +# {{nebula.name}} 相关配置 nebula: { address:{ - # 以下为 NebulaGraph 的 Graph 服务和 Meta 服务所在机器的 IP 地址及端口。 + # 以下为 {{nebula.name}} 的 Graph 服务和 Meta 服务所在机器的 IP 地址及端口。 # 如果有多个地址，格式为 "ip1:port","ip2:port","ip3:port"。 # 不同地址之间以英文逗号 (,) 隔开。 graph:["127.0.0.1:9669"] #任意一个 Meta 服务的地址。 - #如果您的 NebulaGraph 在虚拟网络中，如k8s，请配置 Leader Meta的地址。 + #如果您的 {{nebula.name}} 在虚拟网络中，如k8s，请配置 Leader Meta的地址。 meta:["127.0.0.1:9559"] } - # 填写的账号必须拥有 NebulaGraph 相应图空间的写数据权限。 + # 填写的账号必须拥有 {{nebula.name}} 相应图空间的写数据权限。 user: root pswd: nebula - # 填写 NebulaGraph 中需要写入数据的图空间名称。 + # 填写 {{nebula.name}} 中需要写入数据的图空间名称。 space: basketballplayer connection: { timeout: 3000 @@ -179,12 +179,12 @@ oracle> desc serve; # 处理点 tags: [ { - # NebulaGraph 中对应的 Tag 名称。 + # {{nebula.name}} 中对应的 Tag 名称。 name: player type: { # 指定数据源文件格式，设置为 Oracle。 source: oracle - # 指定如何将点数据导入 NebulaGraph：Client 或 SST。 + # 指定如何将点数据导入{{nebula.name}}：Client 或 SST。 sink: client } @@ -196,18 +196,18 @@ oracle> desc serve; table: "basketball.player" sentence: "select playerid, name, age from player" - # 在 fields 里指定 player 表中的列名称，其对应的 value 会作为 NebulaGraph 中指定属性。 + # 在 fields 里指定 player 表中的列名称，其对应的 value 会作为{{nebula.name}}中指定属性。 # fields 和 nebula.fields 里的配置必须一一对应。 # 如果需要指定多个列名称，用英文逗号（,）隔开。 fields: [age,name] nebula.fields: [age,name] - # 指定表中某一列数据为 NebulaGraph 中点 VID 的来源。 + # 指定表中某一列数据为{{nebula.name}}中点 VID 的来源。 vertex: { field:playerid } - # 单批次写入 NebulaGraph 的数据条数。 + # 单批次写入{{nebula.name}}的数据条数。 batch: 256 # Spark 分区数量 @@ -243,15 +243,15 @@ oracle> desc serve; edges: [ # 设置 Edge type follow 相关信息 { - # NebulaGraph 中对应的 Edge type 名称。 + # {{nebula.name}}中对应的 Edge type 名称。 name: follow type: { # 指定数据源文件格式，设置为 Oracle。 source: oracle - # 指定边数据导入 NebulaGraph 的方式， - # 指定如何将点数据导入 NebulaGraph：Client 或 SST。 + # 指定边数据导入 {{nebula.name}} 的方式， + # 指定如何将点数据导入{{nebula.name}}：Client 或 SST。 sink: client } @@ -262,7 +262,7 @@ oracle> desc serve; table: "basketball.follow" sentence: "select src_player, dst_player, degree from follow" - # 在 fields 里指定 follow 表中的列名称，其对应的 value 会作为 NebulaGraph 中指定属性。 + # 在 fields 里指定 follow 表中的列名称，其对应的 value 会作为{{nebula.name}}中指定属性。 # fields 和 nebula.fields 里的配置必须一一对应。 # 如果需要指定多个列名称，用英文逗号（,）隔开。 fields: [degree] @@ -281,7 +281,7 @@ oracle> desc serve; # 指定一个列作为 rank 的源（可选）。 #ranking: rank - # 单批次写入 NebulaGraph 的数据条数。 + # 单批次写入{{nebula.name}}的数据条数。 batch: 256 # Spark 分区数量 @@ -322,9 +322,9 @@ oracle> desc serve; } ``` -### 步骤 3：向 NebulaGraph 导入数据 +### 步骤 3：向{{nebula.name}}导入数据 -运行如下命令将 Oracle 数据导入到 NebulaGraph 中。关于参数的说明，请参见[导入命令参数](../parameter-reference/ex-ug-para-import-command.md)。 +运行如下命令将 Oracle 数据导入到{{nebula.name}}中。关于参数的说明，请参见[导入命令参数](../parameter-reference/ex-ug-para-import-command.md)。 ```bash ${SPARK_HOME}/bin/spark-submit --master "local" --class com.vesoft.nebula.exchange.Exchange -c @@ -344,7 +344,7 @@ ${SPARK_HOME}/bin/spark-submit --master "local" --class com.vesoft.nebula.excha ### 步骤 4：（可选）验证数据 -用户可以在 NebulaGraph 客户端（例如 NebulaGraph Studio）中执行查询语句，确认数据是否已导入。例如： +用户可以在{{nebula.name}}客户端（例如 NebulaGraph Studio）中执行查询语句，确认数据是否已导入。例如： ```ngql LOOKUP ON player YIELD id(vertex); @@ -352,6 +352,6 @@ LOOKUP ON player YIELD id(vertex); 用户也可以使用命令 [`SHOW STATS`](../../3.ngql-guide/7.general-query-statements/6.show/14.show-stats.md) 查看统计数据。 -### 步骤 5：（如有）在 NebulaGraph 中重建索引 +### 步骤 5：（如有）在{{nebula.name}}中重建索引 -导入数据后，用户可以在 NebulaGraph 中重新创建并重建索引。详情请参见[索引介绍](../../3.ngql-guide/14.native-index-statements/README.md)。 +导入数据后，用户可以在{{nebula.name}}中重新创建并重建索引。详情请参见[索引介绍](../../3.ngql-guide/14.native-index-statements/README.md)。 From 7953e6e701fd3eaaf7971782de8968003b2d5bee Mon Sep 17 00:00:00 2001 From: randomJoe211 <69501902+randomJoe211@users.noreply.github.com> Date: Thu, 13 Apr 2023 11:57:55 +0800 Subject: [PATCH 131/137] update --- .../4.storage-service.md | 6 +- docs-2.0/20.appendix/0.FAQ.md | 2 +- docs-2.0/20.appendix/8.about-license.md | 2 +- docs-2.0/20.appendix/learning-path.md | 2 +- ...deploy-nebula-graph-with-docker-compose.md | 2 +- docs-2.0/8.service-tuning/3.system-design.md | 4 +- docs-2.0/8.service-tuning/load-balance.md | 2 +- .../1.create-service-instance.md | 2 +- .../3.how-to-set-solution.md | 2 +- .../nebula-cloud-on-azure/8.privacy-policy.md | 2 +- docs-2.0/nebula-console.md | 2 +- .../analysis-diagnosis/slow-query-analyst.md | 2 +- .../use-exchange/ex-ug-import-from-orc.md | 60 ++++++++--------- .../use-exchange/ex-ug-import-from-parquet.md | 60 ++++++++--------- .../use-exchange/ex-ug-import-from-pulsar.md | 48 +++++++------- .../use-exchange/ex-ug-import-from-sst.md | 64 +++++++++---------- .../about-explorer/ex-ug-what-is-explorer.md | 12 ++-- .../db-management/11.import-data.md | 6 +- .../db-management/dbuser_management.md | 2 +- .../db-management/ngql-template.md | 2 +- .../deploy-connect/ex-ug-connect.md | 18 +++--- .../deploy-connect/ex-ug-deploy.md | 4 +- .../nebula-explorer/ex-ug-page-overview.md | 6 +- docs-2.0/nebula-explorer/faq.md | 2 +- .../workflow/1.prepare-resources.md | 2 +- .../workflow/2.create-workflow.md | 4 +- .../workflow-api/workflow-api-overview.md | 2 +- .../nebula-explorer/workflow/workflows.md | 4 +- .../nebula-importer/config-with-header.md | 10 +-- .../nebula-importer/config-without-header.md | 12 ++-- docs-2.0/nebula-importer/use-importer.md | 24 +++---- .../1.introduction-to-nebula-operator.md | 24 +++---- .../10.backup-restore-using-operator.md | 16 ++--- .../11.rolling-update-strategy.md | 12 ++-- .../2.deploy-nebula-operator.md | 6 +- .../3.1create-cluster-with-kubectl.md | 36 +++++------ .../3.2create-cluster-with-helm.md | 50 +++++++-------- .../4.connect-to-nebula-graph-service.md | 32 +++++----- .../nebula-operator/5.operator-failover.md | 6 +- .../6.get-started-with-operator.md | 8 +-- docs-2.0/nebula-operator/7.operator-faq.md | 8 +-- .../8.1.custom-conf-parameter.md | 8 +-- .../8.2.pv-reclaim.md | 4 +- .../8.3.balance-data-when-scaling-storage.md | 6 +- .../8.4.manage-running-logs.md | 6 +- .../9.upgrade-nebula-cluster.md | 26 ++++---- .../st-ug-what-is-graph-studio.md | 2 +- .../deploy-connect/st-ug-connect.md | 5 +- .../deploy-connect/st-ug-deploy.md | 2 +- .../st-ug-config-server-errors.md | 6 +- .../reuse/source_connect-to-nebula-graph.md | 2 +- .../reuse/source_create_instance_aliyun.md | 12 ++-- docs-2.0/reuse/source_manage-service.md | 2 +- docs-2.0/reuse/source_ngql_for_quick_start.md | 2 +- .../replication-between-clusters.md | 2 +- 55 files changed, 326 insertions(+), 329 deletions(-) diff --git a/docs-2.0/1.introduction/3.nebula-graph-architecture/4.storage-service.md b/docs-2.0/1.introduction/3.nebula-graph-architecture/4.storage-service.md index 1b7e9f9bcae..3b5ce1ca53a 100644 --- a/docs-2.0/1.introduction/3.nebula-graph-architecture/4.storage-service.md +++ b/docs-2.0/1.introduction/3.nebula-graph-architecture/4.storage-service.md @@ -202,7 +202,7 @@ pId = vid % numParts + 1; Raft 多副本的方式与 HDFS 多副本的方式是不同的，Raft 基于“多数派”投票，因此副本数量不能是偶数。 ### Multi Group Raft @@ -252,7 +252,7 @@ leader 切换对于负载均衡至关重要，当把某个分片从一台机器 ## 缓存 -由于 RocksDB 本身的缓存管理存在限制，无法按需缓存点或边，所以 NebulaGraph 自行实现了 Storage 缓存管理，可以更自由地设置缓存大小、内容等。详情参见 [storage cache 配置](../../5.configurations-and-logs/1.configurations/4.storage-config.md)。 +由于 RocksDB 本身的缓存管理存在限制，无法按需缓存点或边，所以{{nebula.name}}自行实现了 Storage 缓存管理，可以更自由地设置缓存大小、内容等。详情参见 [storage cache 配置](../../5.configurations-and-logs/1.configurations/4.storage-config.md)。 用户可以通过 cURL 命令`curl "http://[storaged IP]:[http port]/cache?stats"`查询缓存数据信息。 @@ -275,7 +275,7 @@ Storage 服务基于 Raft 协议实现的分布式架构，与 HDFS 的分布式 ## 关于执行报错 diff --git a/docs-2.0/20.appendix/8.about-license.md b/docs-2.0/20.appendix/8.about-license.md index 8cd9d104221..cb2000fd0a7 100644 --- a/docs-2.0/20.appendix/8.about-license.md +++ b/docs-2.0/20.appendix/8.about-license.md @@ -19,7 +19,7 @@ NebulaGraph Dashboard 企业版是一款开箱即用的多集群可视化运维 ## NebulaGraph Explorer 企业版 -NebulaGraph Explorer 企业版是一款通过 Web 访问的图探索可视化工具，搭配 NebulaGraph 内核使用，无需掌握图查询语言即可对大规模业务数据进行查找分析，分析结果直接可视化展示，可轻松快速挖掘数据的业务价值。 +NebulaGraph Explorer 企业版是一款通过 Web 访问的图探索可视化工具，搭配{{nebula.name}}内核使用，无需掌握图查询语言即可对大规模业务数据进行查找分析，分析结果直接可视化展示，可轻松快速挖掘数据的业务价值。 部署 NebulaGraph Explorer 企业版时，用户需设置 NebulaGraph Explorer 企业版 License。更多信息，参见 [NebulaGraph Explorer 企业版 License](../nebula-explorer/deploy-connect/3.explorer-license.md)。 diff --git a/docs-2.0/20.appendix/learning-path.md b/docs-2.0/20.appendix/learning-path.md index b77613fcf07..fd5530099e5 100644 --- a/docs-2.0/20.appendix/learning-path.md +++ b/docs-2.0/20.appendix/learning-path.md @@ -1,6 +1,6 @@ # {{nebula.name}}学习路径 -本文介绍{{nebula.name}}学习路径，用户可以通过路径中的文档及视频由浅入深地学习图数据库 NebulaGraph。 +本文介绍{{nebula.name}}学习路径，用户可以通过路径中的文档及视频由浅入深地学习 NebulaGraph。 ![learning path](https://docs-cdn.nebula-graph.com.cn/figures/learning-path.png) 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 03673f4fb05..4965cd3c4cf 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 @@ -124,7 +124,7 @@ 执行命令`docker-compose ps`可以列出{{nebula.name}}服务的状态和端口。 !!! note - {{nebula.name}}默认使用`9669`端口为客户端提供服务，如果需要修改端口，请修改目录`nebula-docker-compose`内的文件`docker-compose.yaml`，然后重启 NebulaGraph 服务。 + {{nebula.name}}默认使用`9669`端口为客户端提供服务，如果需要修改端口，请修改目录`nebula-docker-compose`内的文件`docker-compose.yaml`，然后重启{{nebula.name}}服务。 ```bash $ docker-compose ps diff --git a/docs-2.0/8.service-tuning/3.system-design.md b/docs-2.0/8.service-tuning/3.system-design.md index a39ba924867..fb4b6332517 100644 --- a/docs-2.0/8.service-tuning/3.system-design.md +++ b/docs-2.0/8.service-tuning/3.system-design.md @@ -12,7 +12,7 @@ NebulaGraph {{ nebula.release }} 支持水平扩展： + Storaged 的水平扩展： - - NebulaGraph {{ nebula.release }} 不支持水平扩展。 + - {{nebula.name}} {{ nebula.release }} 不支持水平扩展。 - 增加 storaged 的机器数量，可以大体线性增加集群的整体能力，包括增加整体 QPS 和降低时延。 @@ -27,7 +27,7 @@ NebulaGraph {{ nebula.release }} 支持水平扩展： + Metad 不支持水平扩展。 -垂直扩展通常硬件成本更高，但运维操作相对简单。 ## 数据传输与优化 diff --git a/docs-2.0/8.service-tuning/load-balance.md b/docs-2.0/8.service-tuning/load-balance.md index da7c868fe2f..6ec040aab21 100644 --- a/docs-2.0/8.service-tuning/load-balance.md +++ b/docs-2.0/8.service-tuning/load-balance.md @@ -131,7 +131,7 @@ nebula> SHOW HOSTS; ### 示例 -以横向扩容 NebulaGraph 为例，Zone 中增加新的 Storage 服务器后，新服务器上没有分片。 +以横向扩容{{nebula.name}}为例，Zone 中增加新的 Storage 服务器后，新服务器上没有分片。 1. 将新增的 3 台 Storage 服务器加入集群，分别加入图空间`basketballplayer`所属的 Zone。关于 Zone 的介绍请参见[管理逻辑机架（Zone）](../4.deployment-and-installation/5.zone.md)。 diff --git a/docs-2.0/nebula-cloud/nebula-cloud-on-alibabacloud/1.create-service-instance.md b/docs-2.0/nebula-cloud/nebula-cloud-on-alibabacloud/1.create-service-instance.md index 3512616f19d..2d2698cbe17 100644 --- a/docs-2.0/nebula-cloud/nebula-cloud-on-alibabacloud/1.create-service-instance.md +++ b/docs-2.0/nebula-cloud/nebula-cloud-on-alibabacloud/1.create-service-instance.md @@ -121,7 +121,7 @@ NebulaGraph Cloud 阿里云版支持如下套餐版本。 2. 在 **{{nebula.name}}集群版**卡片上，单击**免费试用**。 -3. 系统会为首次创建 NebulaGraph 服务实例的用户弹出申请对话框。在**申请权限**对话框中填写申请人信息。带有红色星号（*）的为必填项。 +3. 系统会为首次创建{{nebula.name}}服务实例的用户弹出申请对话框。在**申请权限**对话框中填写申请人信息。带有红色星号（*）的为必填项。 !!! note diff --git a/docs-2.0/nebula-cloud/nebula-cloud-on-azure/3.how-to-set-solution.md b/docs-2.0/nebula-cloud/nebula-cloud-on-azure/3.how-to-set-solution.md index 1aa54543b04..754d0c975a3 100644 --- a/docs-2.0/nebula-cloud/nebula-cloud-on-azure/3.how-to-set-solution.md +++ b/docs-2.0/nebula-cloud/nebula-cloud-on-azure/3.how-to-set-solution.md @@ -1,6 +1,6 @@ # 配置 Solution -Solution 指运行在 NebulaGraph Cloud 上的 NebulaGraph 数据库。在 Azure 完成订阅后需要于 Cloud 平台上配置 Solution 完成购买，本文介绍如何配置 Solution。 +Solution 指运行在 NebulaGraph Cloud 上的{{nebula.name}}。在 Azure 完成订阅后需要于 Cloud 平台上配置 Solution 完成购买，本文介绍如何配置 Solution。 ## 配置流程 diff --git a/docs-2.0/nebula-cloud/nebula-cloud-on-azure/8.privacy-policy.md b/docs-2.0/nebula-cloud/nebula-cloud-on-azure/8.privacy-policy.md index 17363d1f0a2..94c8e826792 100644 --- a/docs-2.0/nebula-cloud/nebula-cloud-on-azure/8.privacy-policy.md +++ b/docs-2.0/nebula-cloud/nebula-cloud-on-azure/8.privacy-policy.md @@ -50,7 +50,7 @@ ### (一) 提供服务 -1、在注册使用 NebulaGraph 官方论坛时，您必须提供账号名称和电子邮箱，设置并确认您的登录密码。您提交的电子邮箱用于您注册、登录、绑定账号、密码找回时接收验证码，并作为您与 NebulaGraph 官方论坛唯一的联系方式，用来接收通知。如果您使用 GitHub 账号注册 NebulaGraph 官方论坛，我们将依据 GitHub 相关的规定，在符合相应法律法规规定的前提下，使用您的这些用户信息。 +1、在注册使用{{nebula.name}}官方论坛时，您必须提供账号名称和电子邮箱，设置并确认您的登录密码。您提交的电子邮箱用于您注册、登录、绑定账号、密码找回时接收验证码，并作为您与{{nebula.name}}官方论坛唯一的联系方式，用来接收通知。如果您使用 GitHub 账号注册{{nebula.name}}官方论坛，我们将依据 GitHub 相关的规定，在符合相应法律法规规定的前提下，使用您的这些用户信息。 2、在注册使用 NebulaGraph Cloud Service 时，您必须提供账号名称、姓名、电子邮箱、公司信息，设置并确认您的登录密码。您提交的电子邮箱用于您注册、登录、绑定账号、密码找回时接收验证码，并作为您与 NebulaGraph Cloud Service 唯一的联系方式，用来接收通知。 diff --git a/docs-2.0/nebula-console.md b/docs-2.0/nebula-console.md index c833fdec5ea..6f480e3d4ad 100644 --- a/docs-2.0/nebula-console.md +++ b/docs-2.0/nebula-console.md @@ -6,7 +6,7 @@ NebulaGraph Console 是{{nebula.name}}的原生命令行客户端，用于连接 NebulaGraph Console 的获取方式如下： - + - 从 [GitHub 发布页](https://github.com/vesoft-inc/nebula-console/releases "the nebula-console Releases page")下载二进制文件。 diff --git a/docs-2.0/nebula-dashboard-ent/4.cluster-operator/analysis-diagnosis/slow-query-analyst.md b/docs-2.0/nebula-dashboard-ent/4.cluster-operator/analysis-diagnosis/slow-query-analyst.md index ac68e144dca..10d1f4e8a66 100644 --- a/docs-2.0/nebula-dashboard-ent/4.cluster-operator/analysis-diagnosis/slow-query-analyst.md +++ b/docs-2.0/nebula-dashboard-ent/4.cluster-operator/analysis-diagnosis/slow-query-analyst.md @@ -9,7 +9,7 @@ ## 前提条件 -NebulaGraph 的 Graph 配置文件中，已设置`enable_record_slow_query`=`true`。详情参见 [Graph 服务配置](../../../5.configurations-and-logs/1.configurations/3.graph-config.md)。 +{{nebula.name}}的 Graph 配置文件中，已设置`enable_record_slow_query`=`true`。详情参见 [Graph 服务配置](../../../5.configurations-and-logs/1.configurations/3.graph-config.md)。 ## 入口 diff --git a/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-orc.md b/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-orc.md index 0ea775d3184..d3a232289cf 100644 --- a/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-orc.md +++ b/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-orc.md @@ -2,7 +2,7 @@ 本文以一个示例说明如何使用 Exchange 将存储在 HDFS 或本地的 ORC 文件数据导入 NebulaGraph。 -如果要向 NebulaGraph 导入本地 ORC 文件，请参见 [NebulaGraph Importer](https://github.com/vesoft-inc/nebula-importer "Click to go to GitHub")。 +如果要向{{nebula.name}}导入本地 ORC 文件，请参见 [NebulaGraph Importer](https://github.com/vesoft-inc/nebula-importer "Click to go to GitHub")。 ## 数据集 @@ -30,23 +30,23 @@ - Graph 服务和 Meta 服务的的 IP 地址和端口。 - - 拥有 NebulaGraph 写权限的用户名和密码。 + - 拥有{{nebula.name}}写权限的用户名和密码。 - 已经编译 Exchange。详情请参见[编译 Exchange](../ex-ug-compile.md)。本示例中使用 Exchange {{exchange.release}}。 - 已经安装 Spark。 -- 了解 NebulaGraph 中创建 Schema 的信息，包括 Tag 和 Edge type 的名称、属性等。 +- 了解{{nebula.name}}中创建 Schema 的信息，包括 Tag 和 Edge type 的名称、属性等。 - 如果文件存储在 HDFS 上，需要确认 Hadoop 服务运行正常。 -- 如果文件存储在本地且 NebulaGraph 是集群架构，需要在集群每台机器本地相同目录下放置文件。 +- 如果文件存储在本地且{{nebula.name}}是集群架构，需要在集群每台机器本地相同目录下放置文件。 ## 操作步骤 -### 步骤 1：在 NebulaGraph 中创建 Schema +### 步骤 1：在{{nebula.name}}中创建 Schema -分析 ORC 文件中的数据，按以下步骤在 NebulaGraph 中创建 Schema： +分析 ORC 文件中的数据，按以下步骤在{{nebula.name}}中创建 Schema： 1. 确认 Schema 要素。NebulaGraph 中的 Schema 要素如下表所示。 @@ -116,7 +116,7 @@ } } - # NebulaGraph 相关配置 + # {{nebula.name}}相关配置 nebula: { address:{ # 指定 Graph 服务和所有 Meta 服务的 IP 地址和端口。 @@ -124,11 +124,11 @@ # 格式："ip1:port","ip2:port","ip3:port" graph:["127.0.0.1:9669"] #任意一个 Meta 服务的地址。 - #如果您的 NebulaGraph 在虚拟网络中，如k8s，请配置 Leader Meta的地址。 + #如果您的{{nebula.name}}在虚拟网络中，如k8s，请配置 Leader Meta的地址。 meta:["127.0.0.1:9559"] } - # 指定拥有 NebulaGraph 写权限的用户名和密码。 + # 指定拥有{{nebula.name}}写权限的用户名和密码。 user: root pswd: nebula @@ -155,7 +155,7 @@ tags: [ # 设置 Tag player 相关信息。 { - # 指定 NebulaGraph 中定义的 Tag 名称。 + # 指定{{nebula.name}}中定义的 Tag 名称。 name: player type: { # 指定数据源，使用 ORC。 @@ -170,11 +170,11 @@ # 如果文件存储在本地，用双引号括起路径，以 file://开头，例如"file:///tmp/xx.orc"。 path: "hdfs://192.168.*.*:9000/data/vertex_player.orc" - # 在 fields 里指定 ORC 文件中 key 名称，其对应的 value 会作为 NebulaGraph 中指定属性的数据源。 + # 在 fields 里指定 ORC 文件中 key 名称，其对应的 value 会作为{{nebula.name}}中指定属性的数据源。 # 如果需要指定多个值，用英文逗号（,）隔开。 fields: [age,name] - # 指定 NebulaGraph 中定义的属性名称。 + # 指定{{nebula.name}}中定义的属性名称。 # fields 与 nebula.fields 的顺序必须一一对应。 nebula.fields: [age, name] @@ -185,7 +185,7 @@ field:id } - # 指定单批次写入 NebulaGraph 的最大点数量。 + # 指定单批次写入{{nebula.name}}的最大点数量。 batch: 256 # 指定 Spark 分片数量。 @@ -194,7 +194,7 @@ # 设置 Tag team 相关信息。 { - # 指定 NebulaGraph 中定义的 Tag 名称。 + # 指定{{nebula.name}}中定义的 Tag 名称。 name: team type: { # 指定数据源，使用 ORC。 @@ -209,11 +209,11 @@ # 如果文件存储在本地，用双引号括起路径，以 file://开头，例如"file:///tmp/xx.orc"。 path: "hdfs://192.168.*.*:9000/data/vertex_team.orc" - # 在 fields 里指定 ORC 文件中 key 名称，其对应的 value 会作为 NebulaGraph 中指定属性的数据源。 + # 在 fields 里指定 ORC 文件中 key 名称，其对应的 value 会作为{{nebula.name}}中指定属性的数据源。 # 如果需要指定多个值，用英文逗号（,）隔开。 fields: [name] - # 指定 NebulaGraph 中定义的属性名称。 + # 指定{{nebula.name}}中定义的属性名称。 # fields 与 nebula.fields 的顺序必须一一对应。 nebula.fields: [name] @@ -224,7 +224,7 @@ field:id } - # 指定单批次写入 NebulaGraph 的最大点数量。 + # 指定单批次写入{{nebula.name}}的最大点数量。 batch: 256 # 指定 Spark 分片数量。 @@ -237,7 +237,7 @@ edges: [ # 设置 Edge type follow 相关信息。 { - # 指定 NebulaGraph 中定义的 Edge type 名称。 + # 指定{{nebula.name}}中定义的 Edge type 名称。 name: follow type: { # 指定数据源，使用 ORC。 @@ -252,11 +252,11 @@ # 如果文件存储在本地，用双引号括起路径，以 file://开头，例如"file:///tmp/xx.orc"。 path: "hdfs://192.168.*.*:9000/data/edge_follow.orc" - # 在 fields 里指定 ORC 文件中 key 名称，其对应的 value 会作为 NebulaGraph 中指定属性的数据源。 + # 在 fields 里指定 ORC 文件中 key 名称，其对应的 value 会作为{{nebula.name}}中指定属性的数据源。 # 如果需要指定多个值，用英文逗号（,）隔开。 fields: [degree] - # 指定 NebulaGraph 中定义的属性名称。 + # 指定{{nebula.name}}中定义的属性名称。 # fields 与 nebula.fields 的顺序必须一一对应。 nebula.fields: [degree] @@ -273,7 +273,7 @@ # 指定一个列作为 rank 的源（可选）。 #ranking: rank - # 指定单批次写入 NebulaGraph 的最大边数量。 + # 指定单批次写入{{nebula.name}}的最大边数量。 batch: 256 # 指定 Spark 分片数量。 @@ -282,7 +282,7 @@ # 设置 Edge type serve 相关信息。 { - # 指定 NebulaGraph 中定义的 Edge type 名称。 + # 指定{{nebula.name}}中定义的 Edge type 名称。 name: serve type: { # 指定数据源，使用 ORC。 @@ -297,11 +297,11 @@ # 如果文件存储在本地，用双引号括起路径，以 file://开头，例如"file:///tmp/xx.orc"。 path: "hdfs://192.168.*.*:9000/data/edge_serve.orc" - # 在 fields 里指定 ORC 文件中 key 名称，其对应的 value 会作为 NebulaGraph 中指定属性的数据源。 + # 在 fields 里指定 ORC 文件中 key 名称，其对应的 value 会作为{{nebula.name}}中指定属性的数据源。 # 如果需要指定多个值，用英文逗号（,）隔开。 fields: [start_year,end_year] - # 指定 NebulaGraph 中定义的属性名称。 + # 指定{{nebula.name}}中定义的属性名称。 # fields 与 nebula.fields 的顺序必须一一对应。 nebula.fields: [start_year, end_year] @@ -318,7 +318,7 @@ # 指定一个列作为 rank 的源（可选）。 #ranking: _c5 - # 指定单批次写入 NebulaGraph 的最大边数量。 + # 指定单批次写入{{nebula.name}}的最大边数量。 batch: 256 # 指定 Spark 分片数量。 @@ -330,9 +330,9 @@ } ``` -### 步骤 4：向 NebulaGraph 导入数据 +### 步骤 4：向{{nebula.name}}导入数据 -运行如下命令将 ORC 文件数据导入到 NebulaGraph 中。关于参数的说明，请参见[导入命令参数](../parameter-reference/ex-ug-para-import-command.md)。 +运行如下命令将 ORC 文件数据导入到{{nebula.name}}中。关于参数的说明，请参见[导入命令参数](../parameter-reference/ex-ug-para-import-command.md)。 ```bash ${SPARK_HOME}/bin/spark-submit --master "local" --class com.vesoft.nebula.exchange.Exchange -c @@ -352,7 +352,7 @@ ${SPARK_HOME}/bin/spark-submit --master "local" --class com.vesoft.nebula.excha ### 步骤 5：（可选）验证数据 -用户可以在 NebulaGraph 客户端（例如 NebulaGraph Studio）中执行查询语句，确认数据是否已导入。例如： +用户可以在{{nebula.name}}客户端（例如 NebulaGraph Studio）中执行查询语句，确认数据是否已导入。例如： ```ngql LOOKUP ON player YIELD id(vertex); @@ -360,6 +360,6 @@ LOOKUP ON player YIELD id(vertex); 用户也可以使用命令 [`SHOW STATS`](../../3.ngql-guide/7.general-query-statements/6.show/14.show-stats.md) 查看统计数据。 -### 步骤 6：（如有）在 NebulaGraph 中重建索引 +### 步骤 6：（如有）在{{nebula.name}}中重建索引 -导入数据后，用户可以在 NebulaGraph 中重新创建并重建索引。详情请参见[索引介绍](../../3.ngql-guide/14.native-index-statements/README.md)。 +导入数据后，用户可以在{{nebula.name}}中重新创建并重建索引。详情请参见[索引介绍](../../3.ngql-guide/14.native-index-statements/README.md)。 diff --git a/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-parquet.md b/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-parquet.md index 79294c01400..57316873987 100644 --- a/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-parquet.md +++ b/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-parquet.md @@ -2,7 +2,7 @@ 本文以一个示例说明如何使用 Exchange 将存储在 HDFS 或本地的 Parquet 文件数据导入 NebulaGraph。 -如果要向 NebulaGraph 导入本地 Parquet 文件，请参见 [NebulaGraph Importer](https://github.com/vesoft-inc/nebula-importer "Click to go to GitHub")。 +如果要向{{nebula.name}}导入本地 Parquet 文件，请参见 [NebulaGraph Importer](https://github.com/vesoft-inc/nebula-importer "Click to go to GitHub")。 ## 数据集 @@ -30,23 +30,23 @@ - Graph 服务和 Meta 服务的的 IP 地址和端口。 - - 拥有 NebulaGraph 写权限的用户名和密码。 + - 拥有{{nebula.name}}写权限的用户名和密码。 - 已经编译 Exchange。详情请参见[编译 Exchange](../ex-ug-compile.md)。本示例中使用 Exchange {{exchange.release}}。 - 已经安装 Spark。 -- 了解 NebulaGraph 中创建 Schema 的信息，包括 Tag 和 Edge type 的名称、属性等。 +- 了解{{nebula.name}}中创建 Schema 的信息，包括 Tag 和 Edge type 的名称、属性等。 - 如果文件存储在 HDFS 上，需要确认 Hadoop 服务运行正常。 -- 如果文件存储在本地且 NebulaGraph 是集群架构，需要在集群每台机器本地相同目录下放置文件。 +- 如果文件存储在本地且{{nebula.name}}是集群架构，需要在集群每台机器本地相同目录下放置文件。 ## 操作步骤 -### 步骤 1：在 NebulaGraph 中创建 Schema +### 步骤 1：在{{nebula.name}}中创建 Schema -分析 Parquet 文件中的数据，按以下步骤在 NebulaGraph 中创建 Schema： +分析 Parquet 文件中的数据，按以下步骤在{{nebula.name}}中创建 Schema： 1. 确认 Schema 要素。NebulaGraph 中的 Schema 要素如下表所示。 @@ -116,7 +116,7 @@ } } - # NebulaGraph 相关配置 + #{{nebula.name}}相关配置 nebula: { address:{ # 指定 Graph 服务和所有 Meta 服务的 IP 地址和端口。 @@ -124,11 +124,11 @@ # 格式："ip1:port","ip2:port","ip3:port" graph:["127.0.0.1:9669"] #任意一个 Meta 服务的地址。 - #如果您的 NebulaGraph 在虚拟网络中，如k8s，请配置 Leader Meta的地址。 + #如果您的{{nebula.name}}在虚拟网络中，如k8s，请配置 Leader Meta的地址。 meta:["127.0.0.1:9559"] } - # 指定拥有 NebulaGraph 写权限的用户名和密码。 + # 指定拥有{{nebula.name}}写权限的用户名和密码。 user: root pswd: nebula @@ -155,7 +155,7 @@ tags: [ # 设置 Tag player 相关信息。 { - # 指定 NebulaGraph 中定义的 Tag 名称。 + # 指定{{nebula.name}}中定义的 Tag 名称。 name: player type: { # 指定数据源，使用 Parquet。 @@ -170,11 +170,11 @@ # 如果文件存储在本地，用双引号括起路径，以 file://开头，例如"file:///tmp/xx.csv"。 path: "hdfs://192.168.11.139000/data/vertex_player.parquet" - # 在 fields 里指定 Parquet 文件中 key 名称，其对应的 value 会作为 NebulaGraph 中指定属性的数据源。 + # 在 fields 里指定 Parquet 文件中 key 名称，其对应的 value 会作为{{nebula.name}}中指定属性的数据源。 # 如果需要指定多个值，用英文逗号（,）隔开。 fields: [age,name] - # 指定 NebulaGraph 中定义的属性名称。 + # 指定{{nebula.name}}中定义的属性名称。 # fields 与 nebula.fields 的顺序必须一一对应。 nebula.fields: [age, name] @@ -185,7 +185,7 @@ field:id } - # 指定单批次写入 NebulaGraph 的最大点数量。 + # 指定单批次写入{{nebula.name}}的最大点数量。 batch: 256 # 指定 Spark 分片数量。 @@ -194,7 +194,7 @@ # 设置 Tag team 相关信息。 { - # 指定 NebulaGraph 中定义的 Tag 名称。 + # 指定{{nebula.name}}中定义的 Tag 名称。 name: team type: { # 指定数据源，使用 Parquet。 @@ -209,11 +209,11 @@ # 如果文件存储在本地，用双引号括起路径，以 file://开头，例如"file:///tmp/xx.csv"。 path: "hdfs://192.168.11.13:9000/data/vertex_team.parquet" - # 在 fields 里指定 Parquet 文件中 key 名称，其对应的 value 会作为 NebulaGraph 中指定属性的数据源。 + # 在 fields 里指定 Parquet 文件中 key 名称，其对应的 value 会作为{{nebula.name}}中指定属性的数据源。 # 如果需要指定多个值，用英文逗号（,）隔开。 fields: [name] - # 指定 NebulaGraph 中定义的属性名称。 + # 指定{{nebula.name}}中定义的属性名称。 # fields 与 nebula.fields 的顺序必须一一对应。 nebula.fields: [name] @@ -224,7 +224,7 @@ field:id } - # 指定单批次写入 NebulaGraph 的最大点数量。 + # 指定单批次写入{{nebula.name}}的最大点数量。 batch: 256 # 指定 Spark 分片数量。 @@ -237,7 +237,7 @@ edges: [ # 设置 Edge type follow 相关信息。 { - # 指定 NebulaGraph 中定义的 Edge type 名称。 + # 指定{{nebula.name}}中定义的 Edge type 名称。 name: follow type: { # 指定数据源，使用 Parquet。 @@ -252,11 +252,11 @@ # 如果文件存储在本地，用双引号括起路径，以 file://开头，例如"file:///tmp/xx.csv"。 path: "hdfs://192.168.11.13:9000/data/edge_follow.parquet" - # 在 fields 里指定 Parquet 文件中 key 名称，其对应的 value 会作为 NebulaGraph 中指定属性的数据源。 + # 在 fields 里指定 Parquet 文件中 key 名称，其对应的 value 会作为{{nebula.name}}中指定属性的数据源。 # 如果需要指定多个值，用英文逗号（,）隔开。 fields: [degree] - # 指定 NebulaGraph 中定义的属性名称。 + # 指定{{nebula.name}}中定义的属性名称。 # fields 与 nebula.fields 的顺序必须一一对应。 nebula.fields: [degree] @@ -273,7 +273,7 @@ # 指定一个列作为 rank 的源（可选）。 #ranking: rank - # 指定单批次写入 NebulaGraph 的最大边数量。 + # 指定单批次写入{{nebula.name}}的最大边数量。 batch: 256 # 指定 Spark 分片数量。 @@ -282,7 +282,7 @@ # 设置 Edge type serve 相关信息。 { - # 指定 NebulaGraph 中定义的 Edge type 名称。 + # 指定{{nebula.name}}中定义的 Edge type 名称。 name: serve type: { # 指定数据源，使用 Parquet。 @@ -297,11 +297,11 @@ # 如果文件存储在本地，用双引号括起路径，以 file://开头，例如"file:///tmp/xx.csv"。 path: "hdfs://192.168.11.13:9000/data/edge_serve.parquet" - # 在 fields 里指定 Parquet 文件中 key 名称，其对应的 value 会作为 NebulaGraph 中指定属性的数据源。 + # 在 fields 里指定 Parquet 文件中 key 名称，其对应的 value 会作为{{nebula.name}}中指定属性的数据源。 # 如果需要指定多个值，用英文逗号（,）隔开。 fields: [start_year,end_year] - # 指定 NebulaGraph 中定义的属性名称。 + # 指定{{nebula.name}}中定义的属性名称。 # fields 与 nebula.fields 的顺序必须一一对应。 nebula.fields: [start_year, end_year] @@ -318,7 +318,7 @@ # 指定一个列作为 rank 的源（可选）。 #ranking: _c5 - # 指定单批次写入 NebulaGraph 的最大边数量。 + # 指定单批次写入{{nebula.name}}的最大边数量。 batch: 256 # 指定 Spark 分片数量。 @@ -330,9 +330,9 @@ } ``` -### 步骤 4：向 NebulaGraph 导入数据 +### 步骤 4：向{{nebula.name}}导入数据 -运行如下命令将 Parquet 文件数据导入到 NebulaGraph 中。关于参数的说明，请参见[导入命令参数](../parameter-reference/ex-ug-para-import-command.md)。 +运行如下命令将 Parquet 文件数据导入到{{nebula.name}}中。关于参数的说明，请参见[导入命令参数](../parameter-reference/ex-ug-para-import-command.md)。 ```bash ${SPARK_HOME}/bin/spark-submit --master "local" --class com.vesoft.nebula.exchange.Exchange -c @@ -352,7 +352,7 @@ ${SPARK_HOME}/bin/spark-submit --master "local" --class com.vesoft.nebula.excha ### 步骤 5：（可选）验证数据 -用户可以在 NebulaGraph 客户端（例如 NebulaGraph Studio）中执行查询语句，确认数据是否已导入。例如： +用户可以在{{nebula.name}}客户端（例如 NebulaGraph Studio）中执行查询语句，确认数据是否已导入。例如： ```ngql LOOKUP ON player YIELD id(vertex); @@ -360,6 +360,6 @@ LOOKUP ON player YIELD id(vertex); 用户也可以使用命令 [`SHOW STATS`](../../3.ngql-guide/7.general-query-statements/6.show/14.show-stats.md) 查看统计数据。 -### 步骤 6：（如有）在 NebulaGraph 中重建索引 +### 步骤 6：（如有）在{{nebula.name}}中重建索引 -导入数据后，用户可以在 NebulaGraph 中重新创建并重建索引。详情请参见[索引介绍](../../3.ngql-guide/14.native-index-statements/README.md)。 +导入数据后，用户可以在{{nebula.name}}中重新创建并重建索引。详情请参见[索引介绍](../../3.ngql-guide/14.native-index-statements/README.md)。 diff --git a/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-pulsar.md b/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-pulsar.md index e8e8ecfd6d6..f1c5b53fbb9 100644 --- a/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-pulsar.md +++ b/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-pulsar.md @@ -12,7 +12,7 @@ - Spark：2.4.7，单机版 -- NebulaGraph：{{nebula.release}}。使用 [Docker Compose 部署](../../4.deployment-and-installation/2.compile-and-install-nebula-graph/3.deploy-nebula-graph-with-docker-compose.md)。 +- {{nebula.name}}：{{nebula.release}}。使用 [Docker Compose 部署](../../4.deployment-and-installation/2.compile-and-install-nebula-graph/3.deploy-nebula-graph-with-docker-compose.md)。 ## 前提条件 @@ -22,21 +22,21 @@ - Graph 服务和 Meta 服务的的 IP 地址和端口。 - - 拥有 NebulaGraph 写权限的用户名和密码。 + - 拥有{{nebula.name}}写权限的用户名和密码。 - 已经编译 Exchange。详情请参见[编译 Exchange](../ex-ug-compile.md)。本示例中使用 Exchange {{exchange.release}}。 - 已经安装 Spark。 -- 了解 NebulaGraph 中创建 Schema 的信息，包括 Tag 和 Edge type 的名称、属性等。 +- 了解{{nebula.name}}中创建 Schema 的信息，包括 Tag 和 Edge type 的名称、属性等。 - 已经安装并开启 Pulsar 服务。 ## 操作步骤 -### 步骤 1：在 NebulaGraph 中创建 Schema +### 步骤 1：在{{nebula.name}}中创建 Schema -分析数据，按以下步骤在 NebulaGraph 中创建 Schema： +分析数据，按以下步骤在{{nebula.name}}中创建 Schema： 1. 确认 Schema 要素。NebulaGraph 中的 Schema 要素如下表所示。 @@ -47,7 +47,7 @@ | Edge Type | `follow` | `degree int` | | Edge Type | `serve` | `start_year int, end_year int` | -2. 在 NebulaGraph 中创建一个图空间** basketballplayer**，并创建一个 Schema，如下所示。 +2. 在{{nebula.name}}中创建一个图空间** basketballplayer**，并创建一个 Schema，如下所示。 ```ngql ## 创建图空间 @@ -94,21 +94,21 @@ } } - # NebulaGraph 相关配置 + #{{nebula.name}}相关配置 nebula: { address:{ - # 以下为 NebulaGraph 的 Graph 服务和 Meta 服务所在机器的 IP 地址及端口。 + # 以下为{{nebula.name}}的 Graph 服务和 Meta 服务所在机器的 IP 地址及端口。 # 如果有多个地址，格式为 "ip1:port","ip2:port","ip3:port"。 # 不同地址之间以英文逗号 (,) 隔开。 graph:["127.0.0.1:9669"] #任意一个 Meta 服务的地址。 - #如果您的 NebulaGraph 在虚拟网络中，如k8s，请配置 Leader Meta的地址。 + #如果您的{{nebula.name}}在虚拟网络中，如k8s，请配置 Leader Meta的地址。 meta:["127.0.0.1:9559"] } - # 填写的账号必须拥有 NebulaGraph 相应图空间的写数据权限。 + # 填写的账号必须拥有{{nebula.name}}相应图空间的写数据权限。 user: root pswd: nebula - # 填写 NebulaGraph 中需要写入数据的图空间名称。 + # 填写{{nebula.name}}中需要写入数据的图空间名称。 space: basketballplayer connection: { timeout: 3000 @@ -130,7 +130,7 @@ tags: [ # 设置 Tag player 相关信息。 { - # NebulaGraph 中对应的 Tag 名称。 + #{{nebula.name}}中对应的 Tag 名称。 name: player type: { # 指定数据源文件格式，设置为 Pulsar。 @@ -147,18 +147,18 @@ topics: "topic1,topic2" } - # 在 fields 里指定 player 表中的列名称，其对应的 value 会作为 NebulaGraph 中指定属性。 + # 在 fields 里指定 player 表中的列名称，其对应的 value 会作为{{nebula.name}}中指定属性。 # fields 和 nebula.fields 里的配置必须一一对应。 # 如果需要指定多个列名称，用英文逗号（,）隔开。 fields: [age,name] nebula.fields: [age,name] - # 指定表中某一列数据为 NebulaGraph 中点 VID 的来源。 + # 指定表中某一列数据为{{nebula.name}}中点 VID 的来源。 vertex:{ field:playerid } - # 单批次写入 NebulaGraph 的数据条数。 + # 单批次写入{{nebula.name}}的数据条数。 batch: 10 # Spark 分区数量 @@ -194,14 +194,14 @@ edges: [ # 设置 Edge type follow 相关信息 { - # NebulaGraph 中对应的 Edge type 名称。 + #{{nebula.name}}中对应的 Edge type 名称。 name: follow type: { # 指定数据源文件格式，设置为 Pulsar。 source: pulsar - # 指定边数据导入 NebulaGraph 的方式， + # 指定边数据导入{{nebula.name}}的方式， # 指定如何将点数据导入 NebulaGraph：Client 或 SST。 sink: client } @@ -215,7 +215,7 @@ topics: "topic1,topic2" } - # 在 fields 里指定 follow 表中的列名称，其对应的 value 会作为 NebulaGraph 中指定属性。 + # 在 fields 里指定 follow 表中的列名称，其对应的 value 会作为{{nebula.name}}中指定属性。 # fields 和 nebula.fields 里的配置必须一一对应。 # 如果需要指定多个列名称，用英文逗号（,）隔开。 fields: [degree] @@ -234,7 +234,7 @@ # 指定一个列作为 rank 的源（可选）。 #ranking: rank - # 单批次写入 NebulaGraph 的数据条数。 + # 单批次写入{{nebula.name}}的数据条数。 batch: 10 # Spark 分区数量 @@ -278,9 +278,9 @@ } ``` -### 步骤 3：向 NebulaGraph 导入数据 +### 步骤 3：向{{nebula.name}}导入数据 -运行如下命令将 Pulsar 数据导入到 NebulaGraph 中。关于参数的说明，请参见[导入命令参数](../parameter-reference/ex-ug-para-import-command.md)。 +运行如下命令将 Pulsar 数据导入到{{nebula.name}}中。关于参数的说明，请参见[导入命令参数](../parameter-reference/ex-ug-para-import-command.md)。 ```bash ${SPARK_HOME}/bin/spark-submit --master "local" --class com.vesoft.nebula.exchange.Exchange -c @@ -300,7 +300,7 @@ ${SPARK_HOME}/bin/spark-submit --master "local" --class com.vesoft.nebula.excha ### 步骤 4：（可选）验证数据 -用户可以在 NebulaGraph 客户端（例如 NebulaGraph Studio）中执行查询语句，确认数据是否已导入。例如： +用户可以在{{nebula.name}}客户端（例如 NebulaGraph Studio）中执行查询语句，确认数据是否已导入。例如： ```ngql LOOKUP ON player YIELD id(vertex); @@ -308,6 +308,6 @@ LOOKUP ON player YIELD id(vertex); 用户也可以使用命令 [`SHOW STATS`](../../3.ngql-guide/7.general-query-statements/6.show/14.show-stats.md) 查看统计数据。 -### 步骤 5：（如有）在 NebulaGraph 中重建索引 +### 步骤 5：（如有）在{{nebula.name}}中重建索引 -导入数据后，用户可以在 NebulaGraph 中重新创建并重建索引。详情请参见[索引介绍](../../3.ngql-guide/14.native-index-statements/README.md)。 \ No newline at end of file +导入数据后，用户可以在{{nebula.name}}中重新创建并重建索引。详情请参见[索引介绍](../../3.ngql-guide/14.native-index-statements/README.md)。 \ No newline at end of file diff --git a/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-sst.md b/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-sst.md index 29ecc381238..f5d7faf2ffd 100644 --- a/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-sst.md +++ b/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-sst.md @@ -32,17 +32,17 @@ Exchange 支持两种数据导入模式： ## 实现方法 -NebulaGraph 底层使用 RocksDB 作为键值型存储引擎。RocksDB 是基于硬盘的存储引擎，提供了一系列 API 用于创建及导入 SST 格式的文件，有助于快速导入海量数据。 +{{nebula.name}}底层使用 RocksDB 作为键值型存储引擎。RocksDB 是基于硬盘的存储引擎，提供了一系列 API 用于创建及导入 SST 格式的文件，有助于快速导入海量数据。 SST 文件是一个内部包含了任意长度的有序键值对集合的文件，用于高效地存储大量键值型数据。生成 SST 文件的整个过程主要由 Exchange 的 Reader、sstProcessor 和 sstWriter 完成。整个数据处理过程如下： 1. Reader 从数据源中读取数据。 -2. sstProcessor 根据 NebulaGraph 的 Schema 信息生成 SST 文件，然后上传至 HDFS。SST 文件的格式请参见[数据存储格式](../../1.introduction/3.nebula-graph-architecture/4.storage-service.md)。 +2. sstProcessor 根据{{nebula.name}}的 Schema 信息生成 SST 文件，然后上传至 HDFS。SST 文件的格式请参见[数据存储格式](../../1.introduction/3.nebula-graph-architecture/4.storage-service.md)。 3. sstWriter 打开一个文件并插入数据。生成 SST 文件时，Key 必须按照顺序写入。 -4. 生成 SST 文件之后，RocksDB 通过`IngestExternalFile()`方法将 SST 文件导入到 NebulaGraph 中。例如： +4. 生成 SST 文件之后，RocksDB 通过`IngestExternalFile()`方法将 SST 文件导入到{{nebula.name}}中。例如： ``` IngestExternalFileOptions ifo; @@ -73,7 +73,7 @@ SST 文件是一个内部包含了任意长度的有序键值对集合的文件 - Hadoop：2.9.2 伪分布式部署 -- NebulaGraph：{{nebula.release}}。 +- {{nebula.name}}：{{nebula.release}}。 ## 前提条件 @@ -83,7 +83,7 @@ SST 文件是一个内部包含了任意长度的有序键值对集合的文件 - Graph 服务和 Meta 服务的的 IP 地址和端口。 - - 拥有 NebulaGraph 写权限的用户名和密码。 + - 拥有{{nebula.name}}写权限的用户名和密码。 - Meta 服务配置文件中的`--ws_storage_http_port`和 Storage 服务配置文件中的`--ws_http_port`一致。例如都为`19779`。 @@ -105,13 +105,13 @@ SST 文件是一个内部包含了任意长度的有序键值对集合的文件 - 如果只需要生成 SST 文件，不需要在部署 Storage 服务的机器上安装 Hadoop 服务。 - - 如需在 INGEST（数据导入）结束后自动移除 SST 文件，在 Storage 服务配置文件中增加`--move_files=true`，该配置会让 NebulaGraph 在 INGEST 后将 SST 文件移动（`mv`）到`data`目录下。`--move_files`的默认值为`false`，此时 NebulaGraph 会复制（`cp`）SST 文件而不是移动。 + - 如需在 INGEST（数据导入）结束后自动移除 SST 文件，在 Storage 服务配置文件中增加`--move_files=true`，该配置会让{{nebula.name}}在 INGEST 后将 SST 文件移动（`mv`）到`data`目录下。`--move_files`的默认值为`false`，此时{{nebula.name}}会复制（`cp`）SST 文件而不是移动。 ## 操作步骤 -### 步骤 1：在 NebulaGraph 中创建 Schema +### 步骤 1：在{{nebula.name}}中创建 Schema -分析 CSV 文件中的数据，按以下步骤在 NebulaGraph 中创建 Schema： +分析 CSV 文件中的数据，按以下步骤在{{nebula.name}}中创建 Schema： 1. 确认 Schema 要素。NebulaGraph 中的 Schema 要素如下表所示。 @@ -189,12 +189,12 @@ SST 文件是一个内部包含了任意长度的有序键值对集合的文件 } } - # NebulaGraph 相关配置 + #{{nebula.name}}相关配置 nebula: { address:{ graph:["127.0.0.1:9669"] #任意一个 Meta 服务的地址。 - #如果您的 NebulaGraph 在虚拟网络中，如k8s，请配置 Leader Meta的地址。 + #如果您的{{nebula.name}}在虚拟网络中，如k8s，请配置 Leader Meta的地址。 meta:["127.0.0.1:9559"] } user: root @@ -226,7 +226,7 @@ SST 文件是一个内部包含了任意长度的有序键值对集合的文件 output: /tmp/errors } - # 使用Google Guava RateLimiter 来限制发送到 NebulaGraph 的请求。 + # 使用Google Guava RateLimiter 来限制发送到{{nebula.name}}的请求。 rate: { # RateLimiter 的稳定吞吐量。 limit: 1024 @@ -240,7 +240,7 @@ SST 文件是一个内部包含了任意长度的有序键值对集合的文件 tags: [ # 设置 Tag player 相关信息。 { - # 指定 NebulaGraph 中定义的 Tag 名称。 + # 指定{{nebula.name}}中定义的 Tag 名称。 name: player type: { # 指定数据源，使用 CSV。 @@ -258,7 +258,7 @@ SST 文件是一个内部包含了任意长度的有序键值对集合的文件 # 如果 CSV 文件有表头，则使用实际的列名。 fields: [_c1, _c2] - # 指定 NebulaGraph 中定义的属性名称。 + # 指定{{nebula.name}}中定义的属性名称。 # fields 与 nebula.fields 的顺序必须一一对应。 nebula.fields: [age, name] @@ -276,19 +276,19 @@ SST 文件是一个内部包含了任意长度的有序键值对集合的文件 # 如果 CSV 文件没有表头，请将 header 设置为 false。默认值为 false。 header: false - # 指定单批次写入 NebulaGraph 的最大点数量。 + # 指定单批次写入{{nebula.name}}的最大点数量。 batch: 256 # 指定 Spark 分片数量。 partition: 32 - # 生成 SST 文件时是否要基于 NebulaGraph 中图空间的 partition 进行数据重分区。 + # 生成 SST 文件时是否要基于{{nebula.name}}中图空间的 partition 进行数据重分区。 repartitionWithNebula: false } # 设置 Tag team 相关信息。 { - # 指定 NebulaGraph 中定义的 Tag 名称。 + # 指定{{nebula.name}}中定义的 Tag 名称。 name: team type: { # 指定数据源，使用 CSV。 @@ -306,7 +306,7 @@ SST 文件是一个内部包含了任意长度的有序键值对集合的文件 # 如果 CSV 文件有表头，则使用实际的列名。 fields: [_c1] - # 指定 NebulaGraph 中定义的属性名称。 + # 指定{{nebula.name}}中定义的属性名称。 # fields 与 nebula.fields 的顺序必须一一对应。 nebula.fields: [name] @@ -324,13 +324,13 @@ SST 文件是一个内部包含了任意长度的有序键值对集合的文件 # 如果 CSV 文件没有表头，请将 header 设置为 false。默认值为 false。 header: false - # 指定单批次写入 NebulaGraph 的最大点数量。 + # 指定单批次写入{{nebula.name}}的最大点数量。 batch: 256 # 指定 Spark 分片数量。 partition: 32 - # 生成 SST 文件时是否要基于 NebulaGraph 中图空间的 partition 进行数据重分区。 + # 生成 SST 文件时是否要基于{{nebula.name}}中图空间的 partition 进行数据重分区。 repartitionWithNebula: false } @@ -340,7 +340,7 @@ SST 文件是一个内部包含了任意长度的有序键值对集合的文件 edges: [ # 设置 Edge type follow 相关信息。 { - # 指定 NebulaGraph 中定义的 Edge type 名称。 + # 指定{{nebula.name}}中定义的 Edge type 名称。 name: follow type: { # 指定数据源，使用 CSV。 @@ -358,7 +358,7 @@ SST 文件是一个内部包含了任意长度的有序键值对集合的文件 # 如果 CSV 文件有表头，则使用实际的列名。 fields: [_c2] - # 指定 NebulaGraph 中定义的属性名称。 + # 指定{{nebula.name}}中定义的属性名称。 # fields 与 nebula.fields 的顺序必须一一对应。 nebula.fields: [degree] @@ -383,19 +383,19 @@ SST 文件是一个内部包含了任意长度的有序键值对集合的文件 # 如果 CSV 文件没有表头，请将 header 设置为 false。默认值为 false。 header: false - # 指定单批次写入 NebulaGraph 的最大边数量。 + # 指定单批次写入{{nebula.name}}的最大边数量。 batch: 256 # 指定 Spark 分片数量。 partition: 32 - # 生成 SST 文件时是否要基于 NebulaGraph 中图空间的 partition 进行数据重分区。 + # 生成 SST 文件时是否要基于{{nebula.name}}中图空间的 partition 进行数据重分区。 repartitionWithNebula: false } # 设置 Edge type serve 相关信息。 { - # 指定 NebulaGraph 中定义的 Edge type 名称。 + # 指定{{nebula.name}}中定义的 Edge type 名称。 name: serve type: { # 指定数据源，使用 CSV。 @@ -413,7 +413,7 @@ SST 文件是一个内部包含了任意长度的有序键值对集合的文件 # 如果 CSV 文件有表头，则使用实际的列名。 fields: [_c2,_c3] - # 指定 NebulaGraph 中定义的属性名称。 + # 指定{{nebula.name}}中定义的属性名称。 # fields 与 nebula.fields 的顺序必须一一对应。 nebula.fields: [start_year, end_year] @@ -437,13 +437,13 @@ SST 文件是一个内部包含了任意长度的有序键值对集合的文件 # 如果 CSV 文件没有表头，请将 header 设置为 false。默认值为 false。 header: false - # 指定单批次写入 NebulaGraph 的最大边数量。 + # 指定单批次写入{{nebula.name}}的最大边数量。 batch: 256 # 指定 Spark 分片数量。 partition: 32 - # 生成 SST 文件时是否要基于 NebulaGraph 中图空间的 partition 进行数据重分区。 + # 生成 SST 文件时是否要基于{{nebula.name}}中图空间的 partition 进行数据重分区。 repartitionWithNebula: false } @@ -492,7 +492,7 @@ ${SPARK_HOME}/bin/spark-submit --master "local" --conf spark.sql.shuffle.partit - Graph 服务配置文件中的`--ws_meta_http_port`（如果没有，请手动添加）和 Meta 服务配置文件中的`--ws_http_port`一致。例如都为`19559`。 -使用客户端工具连接 NebulaGraph 数据库，按如下操作导入 SST 文件： +使用客户端工具连接{{nebula.name}}，按如下操作导入 SST 文件： 1. 执行命令选择之前创建的图空间。 @@ -520,13 +520,13 @@ ${SPARK_HOME}/bin/spark-submit --master "local" --conf spark.sql.shuffle.partit !!! note - - 如果需要重新下载，请在 NebulaGraph 安装路径内的`data/storage/nebula`目录内，将对应 Space ID 目录内的`download`文件夹删除，然后重新下载 SST 文件。如果图空间是多副本，保存副本的所有机器都需要删除`download`文件夹。 + - 如果需要重新下载，请在{{nebula.name}}安装路径内的`data/storage/nebula`目录内，将对应 Space ID 目录内的`download`文件夹删除，然后重新下载 SST 文件。如果图空间是多副本，保存副本的所有机器都需要删除`download`文件夹。 - 如果导入时出现问题需要重新导入，重新执行`SUBMIT JOB INGEST;`即可。 ### 步骤 6：（可选）验证数据 -用户可以在 NebulaGraph 客户端（例如 NebulaGraph Studio）中执行查询语句，确认数据是否已导入。例如： +用户可以在{{nebula.name}}客户端（例如 NebulaGraph Studio）中执行查询语句，确认数据是否已导入。例如： ```ngql LOOKUP ON player YIELD id(vertex); @@ -534,6 +534,6 @@ LOOKUP ON player YIELD id(vertex); 用户也可以使用命令 [`SHOW STATS`](../../3.ngql-guide/7.general-query-statements/6.show/14.show-stats.md) 查看统计数据。 -### 步骤 7：（如有）在 NebulaGraph 中重建索引 +### 步骤 7：（如有）在{{nebula.name}}中重建索引 -导入数据后，用户可以在 NebulaGraph 中重新创建并重建索引。详情请参见[索引介绍](../../3.ngql-guide/14.native-index-statements/README.md)。 +导入数据后，用户可以在{{nebula.name}}中重新创建并重建索引。详情请参见[索引介绍](../../3.ngql-guide/14.native-index-statements/README.md)。 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 327c847e632..a443104b481 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 @@ -1,6 +1,6 @@ # 什么是 NebulaGraph Explorer -NebulaGraph Explorer （简称 Explorer）是一款可以通过 Web 访问的可视化图探索工具，搭配 NebulaGraph 内核使用，用于与图数据进行可视化交互。即使没有图数据操作经验，用户也可以快速成为图专家。 +NebulaGraph Explorer （简称 Explorer）是一款可以通过 Web 访问的可视化图探索工具，搭配{{nebula.name}}内核使用，用于与图数据进行可视化交互。即使没有图数据操作经验，用户也可以快速成为图专家。 !!! enterpriseonly @@ -35,17 +35,17 @@ NebulaGraph Explorer （简称 Explorer）是一款可以通过 Web 访问的可 ## 身份验证 -NebulaGraph 默认不启用身份验证，一般情况下用户可以使用`root`账号和任意密码登录 Explorer。 +{{nebula.name}}默认不启用身份验证，一般情况下用户可以使用`root`账号和任意密码登录 Explorer。 -NebulaGraph 启用了身份验证后，用户只能使用指定的账号和密码登录 Explorer。 +{{nebula.name}}启用了身份验证后，用户只能使用指定的账号和密码登录 Explorer。 -关于 NebulaGraph 的身份验证功能，参考 [NebulaGraph 用户手册](../../7.data-security/1.authentication/1.authentication.md "点击前往 NebulaGraph 官网")。 +关于{{nebula.name}}的身份验证功能，参考 [NebulaGraph 用户手册](../../7.data-security/1.authentication/1.authentication.md "点击前往{{nebula.name}}官网")。 ## 版本兼容性 -NebulaGraph 的版本和 Explorer 版本对应关系如下。 +{{nebula.name}}的版本和 Explorer 版本对应关系如下。 -| NebulaGraph 版本 | Explorer 版本 | +|{{nebula.name}}版本 | Explorer 版本 | | --- | --- | | 3.4.0 ~ 3.4.1 | 3.4.0、3.2.1、3.2.0 | | 3.3.0 | 3.2.1、3.2.0| 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 a6b51a6dd62..2decde9ca73 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,10 +1,10 @@ # 数据导入 -Explorer 支持界面化地将 CSV 格式数据导入至 NebulaGraph 中。 +Explorer 支持界面化地将 CSV 格式数据导入至{{nebula.name}}中。 ## 前提条件 -- NebulaGraph 数据库里已经创建 Schema。 +-{{nebula.name}}里已经创建 Schema。 - CSV 文件符合 Schema 要求。 @@ -46,6 +46,6 @@ Explorer 支持界面化地将 CSV 格式数据导入至 NebulaGraph 中。 ![导入任务](https://docs-cdn.nebula-graph.com.cn/figures/import_task_221111_cn.png) -2. 完成设置后，单击**导入**,输入 NebulaGraph 账号的密码并确认。 +2. 完成设置后，单击**导入**,输入{{nebula.name}}账号的密码并确认。 可以在**导入数据**页签内查看日志、下载日志、下载配置文件、删除任务等操作。 diff --git a/docs-2.0/nebula-explorer/db-management/dbuser_management.md b/docs-2.0/nebula-explorer/db-management/dbuser_management.md index 9aafacb4040..9f609a5137e 100644 --- a/docs-2.0/nebula-explorer/db-management/dbuser_management.md +++ b/docs-2.0/nebula-explorer/db-management/dbuser_management.md @@ -24,7 +24,7 @@ NebulaGraph Explorer 支持管理数据库用户，包括创建用户、删除 |:--|:--| |账号|用户名。| |密码|用户名对应密码。| - |IP 白名单|用户只有通过列表内的 IP 才能连接 NebulaGraph。多个 IP 之间用英文逗号（,）分隔。仅 NebulaGraph 企业版支持该参数。| + |IP 白名单|用户只有通过列表内的 IP 才能连接 NebulaGraph。多个 IP 之间用英文逗号（,）分隔。仅{{nebula.name}}企业版支持该参数。| !!! note 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 2c25ef8108a..7d3a7300fbe 100644 --- a/docs-2.0/nebula-explorer/db-management/ngql-template.md +++ b/docs-2.0/nebula-explorer/db-management/ngql-template.md @@ -4,7 +4,7 @@ NebulaGraph Explorer 支持将常用 nGQL 语句保存为模板，方便自己 ## 前提条件 -NebulaGraph 数据库里已经创建 Schema。 +{{nebula.name}}里已经创建 Schema。 ## 入口 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 92590cbc12e..ea05c138571 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 @@ -4,13 +4,13 @@ ## 前提条件 -在连接 NebulaGraph 数据库前，用户需要确认以下信息： +在连接{{nebula.name}}前，用户需要确认以下信息： - 已经安装部署了 Explorer。详细信息，参见[部署 Explorer](../deploy-connect/ex-ug-deploy.md)。 -- NebulaGraph 的 Graph 服务本机 IP 地址以及服务所用端口。默认端口为 `9669`。 +- {{nebula.name}} 的 Graph 服务本机 IP 地址以及服务所用端口。默认端口为 `9669`。 -- NebulaGraph 数据库登录账号信息，包括用户名和密码。 +-{{nebula.name}}登录账号信息，包括用户名和密码。 - 建议使用 Chrome 89 及以上的版本的 Chrome 浏览器，否则可能有兼容问题。 @@ -47,7 +47,7 @@ OAuth 部分的配置说明如下。 ## 连接数据库 -按以下步骤连接 NebulaGraph 数据库： +按以下步骤连接{{nebula.name}}： 1. 在浏览器地址栏输入 `http://:7002`。 @@ -61,16 +61,16 @@ OAuth 部分的配置说明如下。 2. 在 Explorer 的**配置数据库**页面上，输入以下信息： - - **Graphd IP 地址**：填写 NebulaGraph 的 Graph 服务本机 IP 地址。例如`192.168.10.100`。 + - **Graphd IP 地址**：填写{{nebula.name}}的 Graph 服务本机 IP 地址。例如`192.168.10.100`。 !!! Note - - 即使 NebulaGraph 数据库与 Explorer 部署在同一台机器上，用户也必须填写这台机器的本机 IP 地址，而不是 `127.0.0.1` 或者 `localhost`。 - - 在新的标签页连接另一个 NebulaGraph 数据库时，会覆盖旧标签页的会话。如果需要同时登录多个 NebulaGraph 数据库，可以用不同的浏览器或者无痕模式。 + - 即使{{nebula.name}}与 Explorer 部署在同一台机器上，用户也必须填写这台机器的本机 IP 地址，而不是 `127.0.0.1` 或者 `localhost`。 + - 在新的标签页连接另一个{{nebula.name}}时，会覆盖旧标签页的会话。如果需要同时登录多个{{nebula.name}}，可以用不同的浏览器或者无痕模式。 - **Port**：Graphd 服务的端口。默认为`9669`。 - - **用户名**和**密码**：根据 NebulaGraph 的[身份验证](../../7.data-security/1.authentication/1.authentication.md)设置填写登录账号和密码。 + - **用户名**和**密码**：根据{{nebula.name}}的[身份验证](../../7.data-security/1.authentication/1.authentication.md)设置填写登录账号和密码。 - 如果未启用身份验证，可以填写默认用户名 `root` 和任意密码。 - 如果已启用身份验证，但是未创建账号信息，用户只能以 GOD 角色登录，必须填写用户名 `root` 和密码 `nebula`。 - 如果已启用身份验证，同时又创建了不同的用户并分配了角色，不同角色的用户使用自己的账号和密码登录。 @@ -89,4 +89,4 @@ OAuth 部分的配置说明如下。 在页面右上角，选择![icon](https://docs-cdn.nebula-graph.com.cn/figures/image-icon10.png)图标 > 清空连接。 -如果浏览器上显示**配置数据库**页面，表示 Explorer 已经成功断开了与 NebulaGraph 数据库的连接。 +如果浏览器上显示**配置数据库**页面，表示 Explorer 已经成功断开了与{{nebula.name}}的连接。 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 4428acd49dc..da4df76b011 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 @@ -6,7 +6,7 @@ 在部署 Explorer 之前，用户需要确认以下信息： -- NebulaGraph 服务已经部署并启动。详细信息参考 [NebulaGraph 安装部署](../../4.deployment-and-installation/1.resource-preparations.md "点击前往 NebulaGraph 安装部署")。 +- {{nebula.name}} 服务已经部署并启动。详细信息参考 [NebulaGraph 安装部署](../../4.deployment-and-installation/1.resource-preparations.md "点击前往{{nebula.name}}安装部署")。 - 以下端口未被使用。 @@ -231,7 +231,7 @@ kill $(lsof -t -i :7002) Dag Controller 是一款任务编排调度工具，可以编排调度有向无环图（DAG）类型的作业，该作业由多个任务组成，且任务之间存在先后关系，组成一个有向无环图（DAG）。 -Dag Controller 可以结合 NebulaGraph Analytics 进行复杂的图计算。例如 Dag Controller 将算法调用请求发送给 NebulaGraph Analytics ，NebulaGraph Analytics 保存结果至 NebulaGraph 或 HDFS，Dag Controller 再将上次的计算结果作为下一个算法任务的输入创建新的任务。 +Dag Controller 可以结合 NebulaGraph Analytics 进行复杂的图计算。例如 Dag Controller 将算法调用请求发送给 NebulaGraph Analytics ，NebulaGraph Analytics 保存结果至{{nebula.name}}或 HDFS，Dag Controller 再将上次的计算结果作为下一个算法任务的输入创建新的任务。 ### 配置步骤 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 73b47468bb7..48fd3de9769 100644 --- a/docs-2.0/nebula-explorer/ex-ug-page-overview.md +++ b/docs-2.0/nebula-explorer/ex-ug-page-overview.md @@ -14,14 +14,14 @@ NebulaGraph Explorer 由顶部导航栏、左侧导航栏、和画布三大模 | **Visual Query** | 可视化构造场景进行数据查询。详情参见[可视化查询](12.query-visually.md)。 | | **Workflow** | 可视化构造自定义工作流进行复杂图计算。需要在 ![setting](https://docs-cdn.nebula-graph.com.cn/figures/navbar-setting-0105.png) 里开启工作流才能显示 Workflow 页面。详情参见[工作流简介](workflow/workflows.md)。| | ![Schema_drafting](https://docs-cdn.nebula-graph.com.cn/figures/schema_drafting_221110.png) | 在画板上自行设计 Schema，可以直观展示点边关系。详情参见[Schema 草图](db-management/draft.md)。| -| ![create_schema](https://docs-cdn.nebula-graph.com.cn/figures/studio-nav-schema.png) | 对 NebulaGraph 图空间进行管理。详情参见[创建 Schema](db-management/10.create-schema.md)。 | +| ![create_schema](https://docs-cdn.nebula-graph.com.cn/figures/studio-nav-schema.png) | 对{{nebula.name}}图空间进行管理。详情参见[创建 Schema](db-management/10.create-schema.md)。 | | ![import_data](https://docs-cdn.nebula-graph.com.cn/figures/studio-btn-download.png) | 将数据批量导入 NebulaGraph。详情参见[导入数据](db-management/11.import-data.md)。 | -| ![Console](https://docs-cdn.nebula-graph.com.cn/figures/nav-console2.png) | 对 NebulaGraph 内的数据使用 nGQL 进行查询操作。详情参见[控制台](db-management/explorer-console.md)。 | +| ![Console](https://docs-cdn.nebula-graph.com.cn/figures/nav-console2.png) | 对{{nebula.name}}内的数据使用 nGQL 进行查询操作。详情参见[控制台](db-management/explorer-console.md)。 | | ![Template](https://docs-cdn.nebula-graph.com.cn/figures/icon-navbar-queryTemplate.png)| nGQL 语句的模板列表。详情参见[查询语句模板](db-management/ngql-template.md)。| | ![db_user_management](https://docs-cdn.nebula-graph.com.cn/figures/db_user_management_221024.png) | 数据库用户管理。详情参见[数据库用户管理](db-management/dbuser_management.md)。 | | ![setting](https://docs-cdn.nebula-graph.com.cn/figures/navbar-setting-0105.png) | 全局设置。可以设置 Explorer 页面的语言、开启 Beta 功能、画布查询结果最大数量等。 | | ![help](https://docs-cdn.nebula-graph.com.cn/figures/navbar-help.png) | 帮助页面，指导和帮忙用户使用 NebulaGraph。 | -| ![feedback](https://docs-cdn.nebula-graph.com.cn/figures/navbar-feedback-230105.png) | 反馈页面。可以反馈故障、提交建议、参与调研或联系 NebulaGraph 团队。 | +| ![feedback](https://docs-cdn.nebula-graph.com.cn/figures/navbar-feedback-230105.png) | 反馈页面。可以反馈故障、提交建议、参与调研或联系{{nebula.name}}团队。 | | ![clear_connection](https://docs-cdn.nebula-graph.com.cn/figures/session_221024.png) | 显示连接信息和版本信息。支持修改密码和退出登录。 | ## 左侧导航栏 diff --git a/docs-2.0/nebula-explorer/faq.md b/docs-2.0/nebula-explorer/faq.md index b68302e2fc0..efb9c06ce04 100644 --- a/docs-2.0/nebula-explorer/faq.md +++ b/docs-2.0/nebula-explorer/faq.md @@ -4,7 +4,7 @@ ## 如果 Graph 服务返回的查询结果数据量过大，会导致 Dag Controller 服务崩溃吗？ -Dag Controller 服务仅仅提供调度功能，不会崩溃，但是数据量过大可能会导致 NebulaGraph Analytics 服务读写 HDFS 或者 NebulaGraph 时内存不足而崩溃。 +Dag Controller 服务仅仅提供调度功能，不会崩溃，但是数据量过大可能会导致 NebulaGraph Analytics 服务读写 HDFS 或者{{nebula.name}}时内存不足而崩溃。 ## 如果一个作业中的某个任务失败，能否从失败的任务开始重新执行？ 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 88db8488c24..03e057cf52c 100644 --- a/docs-2.0/nebula-explorer/workflow/1.prepare-resources.md +++ b/docs-2.0/nebula-explorer/workflow/1.prepare-resources.md @@ -1,6 +1,6 @@ # 资源配置 -使用工作流之前，需要进行资源配置，包括 NebulaGraph 配置、HDFS 配置和 NebulaGraph Analytics 配置。 +使用工作流之前，需要进行资源配置，包括{{nebula.name}}配置、HDFS 配置和 NebulaGraph Analytics 配置。 ## 前提条件 diff --git a/docs-2.0/nebula-explorer/workflow/2.create-workflow.md b/docs-2.0/nebula-explorer/workflow/2.create-workflow.md index 6754677d65a..af0d4b2ca85 100644 --- a/docs-2.0/nebula-explorer/workflow/2.create-workflow.md +++ b/docs-2.0/nebula-explorer/workflow/2.create-workflow.md @@ -4,7 +4,7 @@ ## 前提条件 -- 已有数据源。数据源可以是 NebulaGraph 中的数据或者 HDFS 上的 CSV 文件。 +- 已有数据源。数据源可以是{{nebula.name}}中的数据或者 HDFS 上的 CSV 文件。 - 已完成[资源配置](1.prepare-resources.md)。 @@ -51,7 +51,7 @@ |参数配置|设置图算法特有的参数。不同算法的参数不同，部分参数可以从任意上游组件获取，此时锚点显示为黄色。| |输出|显示图计算结果的列名，无法修改。| |执行配置|**机器数量**表示将要执行算法的机器数量。
**进程数量**表示将要执行算法的总进程数，会根据机器数量平均分配到各个机器。
**线程数量**表示每个进程会启动多少个线程。| - |结果|设置结果的保存位置。可以保存在 HDFS 或 NebulaGraph 中。
保存为 HDFS 时只需要选择 HDFS ，保存路径无需修改，会根据作业和任务 ID 自动生成。
保存为 NebulaGraph 时，需要预先在相应图空间中创建 Tag 用于保存结果。Tag 的属性说明请参见[算法简介](../../graph-computing/algorithm-description.md)。
部分算法只支持保存在 HDFS 上。| + |结果|设置结果的保存位置。可以保存在 HDFS 或{{nebula.name}}中。
保存为 HDFS 时只需要选择 HDFS ，保存路径无需修改，会根据作业和任务 ID 自动生成。
保存为{{nebula.name}}时，需要预先在相应图空间中创建 Tag 用于保存结果。Tag 的属性说明请参见[算法简介](../../graph-computing/algorithm-description.md)。
部分算法只支持保存在 HDFS 上。| 6. 在画布左上角自动生成的工作流名称旁单击![pencil](https://docs-cdn.nebula-graph.com.cn/figures/workflow-edit.png)修改工作流名称，然后在画布右上角单击**运行**，会自动跳转至作业页面显示作业进度，耐心等待作业完成即可查看结果。详情参见[作业管理](4.jobs-management.md)。 diff --git a/docs-2.0/nebula-explorer/workflow/workflow-api/workflow-api-overview.md b/docs-2.0/nebula-explorer/workflow/workflow-api/workflow-api-overview.md index 901e05f7600..d61db2092c5 100644 --- a/docs-2.0/nebula-explorer/workflow/workflow-api/workflow-api-overview.md +++ b/docs-2.0/nebula-explorer/workflow/workflow-api/workflow-api-overview.md @@ -39,7 +39,7 @@ curl http://:/?{} curl -i -X POST -H "Content-Type: application/json" -H "Authorization: Bearer " -d '{"address":"","port":}' http://:/api-open/v1/connect ``` -- ``：Base64 编码后的 NebulaGraph 账号和密码字符串。以用户名`root`、密码`123`为例，序列化后的字符串为`["root","123"]`，Base64 编码后为`WyJyb290IiwiMTIzIl0=`。 +- ``：Base64 编码后的{{nebula.name}}账号和密码字符串。以用户名`root`、密码`123`为例，序列化后的字符串为`["root","123"]`，Base64 编码后为`WyJyb290IiwiMTIzIl0=`。 - ``：NebulaGraph 访问地址。 - ``：NebulaGraph 访问端口。 - ``：NebulaGraph Explorer 访问地址。 diff --git a/docs-2.0/nebula-explorer/workflow/workflows.md b/docs-2.0/nebula-explorer/workflow/workflows.md index e78dc655cfc..8df008134ed 100644 --- a/docs-2.0/nebula-explorer/workflow/workflows.md +++ b/docs-2.0/nebula-explorer/workflow/workflows.md @@ -27,12 +27,12 @@ Nebula Explorer 提供多种**组件**（Component），包括图查询组件和 - 图查询组件的结果仅支持保存在 HDFS，方便被多个算法调用。 -- 图计算组件的输入可以是 NebulaGraph 或 HDFS 的指定数据，也可以依赖于图查询组件的结果。 +- 图计算组件的输入可以是{{nebula.name}}或 HDFS 的指定数据，也可以依赖于图查询组件的结果。 如果依赖于前一个图查询组件的结果，必须和该图查询组件全连接，即该图计算组件的白色输入锚点全都和上一个图查询组件的白色输出锚点连接。 - 部分算法的参数配置也可以依赖于上游节点。 -- 图计算组件结果允许保存在 HDFS、NebulaGraph 中，但是并非所有算法的结果都适合存入到 NebulaGraph 里，在设置**结果保存**页面时，部分算法只能选择 HDFS。 +- 图计算组件结果允许保存在 HDFS、NebulaGraph 中，但是并非所有算法的结果都适合存入到{{nebula.name}}里，在设置**结果保存**页面时，部分算法只能选择 HDFS。 ## 算法参数配置说明 diff --git a/docs-2.0/nebula-importer/config-with-header.md b/docs-2.0/nebula-importer/config-with-header.md index 8c4a7a1d103..ada2a1dec1d 100644 --- a/docs-2.0/nebula-importer/config-with-header.md +++ b/docs-2.0/nebula-importer/config-with-header.md @@ -87,13 +87,13 @@ clientSettings: # nGQL 语句执行失败的重试次数。 retry: 3 - # NebulaGraph 客户端并发数。 + #{{nebula.name}}客户端并发数。 concurrency: 10 - # 每个 NebulaGraph 客户端的缓存队列大小。 + # 每个{{nebula.name}}客户端的缓存队列大小。 channelBufferSize: 128 - # 指定数据要导入的 NebulaGraph 图空间。 + # 指定数据要导入的{{nebula.name}}图空间。 space: student # 连接信息。 @@ -103,7 +103,7 @@ clientSettings: address: 192.168.11.13:9669 postStart: - # 配置连接 NebulaGraph 服务器之后，在插入数据之前执行的一些操作。 + # 配置连接{{nebula.name}}服务器之后，在插入数据之前执行的一些操作。 commands: | DROP SPACE IF EXISTS student; CREATE SPACE IF NOT EXISTS student(partition_num=5, replica_factor=1, vid_type=FIXED_STRING(20)); @@ -115,7 +115,7 @@ clientSettings: afterPeriod: 15s preStop: - # 配置断开 NebulaGraph 服务器连接之前执行的一些操作。 + # 配置断开{{nebula.name}}服务器连接之前执行的一些操作。 commands: | # 错误等日志信息输出的文件路径。 diff --git a/docs-2.0/nebula-importer/config-without-header.md b/docs-2.0/nebula-importer/config-without-header.md index b82f4459956..545da8c4999 100644 --- a/docs-2.0/nebula-importer/config-without-header.md +++ b/docs-2.0/nebula-importer/config-without-header.md @@ -46,13 +46,13 @@ clientSettings: # nGQL 语句执行失败的重试次数。 retry: 3 - # NebulaGraph 客户端并发数。 + #{{nebula.name}}客户端并发数。 concurrency: 10 - # 每个 NebulaGraph 客户端的缓存队列大小。 + # 每个{{nebula.name}}客户端的缓存队列大小。 channelBufferSize: 128 - # 指定数据要导入的 NebulaGraph 图空间。 + # 指定数据要导入的{{nebula.name}}图空间。 space: student # 连接信息。 @@ -62,7 +62,7 @@ clientSettings: address: 192.168.11.13:9669 postStart: - # 配置连接 NebulaGraph 服务器之后，在插入数据之前执行的一些操作。 + # 配置连接{{nebula.name}}服务器之后，在插入数据之前执行的一些操作。 commands: | DROP SPACE IF EXISTS student; CREATE SPACE IF NOT EXISTS student(partition_num=5, replica_factor=1, vid_type=FIXED_STRING(20)); @@ -74,7 +74,7 @@ clientSettings: afterPeriod: 15s preStop: - # 配置断开 NebulaGraph 服务器连接之前执行的一些操作。 + # 配置断开{{nebula.name}}服务器连接之前执行的一些操作。 commands: | # 错误等日志信息输出的文件路径。 @@ -122,7 +122,7 @@ files: # 点 ID 对应 CSV 文件中列的序号。CSV 文件中列的序号从 0 开始。 index: 0 - # 点 ID 的数据类型，可选值为 int 和 string，分别对应 NebulaGraph 中的 INT64 和 FIXED_STRING。 + # 点 ID 的数据类型，可选值为 int 和 string，分别对应{{nebula.name}}中的 INT64 和 FIXED_STRING。 type: string # Tag 设置。 diff --git a/docs-2.0/nebula-importer/use-importer.md b/docs-2.0/nebula-importer/use-importer.md index 1bf5e04f5f0..93dfc6ee9fb 100644 --- a/docs-2.0/nebula-importer/use-importer.md +++ b/docs-2.0/nebula-importer/use-importer.md @@ -1,10 +1,10 @@ # NebulaGraph Importer -NebulaGraph Importer（简称 Importer）是一款 [NebulaGraph](https://github.com/vesoft-inc/nebula) 的 CSV 文件单机导入工具。Importer 可以读取本地的 CSV 文件，然后导入数据至 NebulaGraph 图数据库中。 +NebulaGraph Importer（简称 Importer）是一款 [NebulaGraph](https://github.com/vesoft-inc/nebula) 的 CSV 文件单机导入工具。Importer 可以读取本地的 CSV 文件，然后导入数据至{{nebula.name}}图数据库中。 ## 适用场景 -Importer 适用于将本地 CSV 文件的内容导入至 NebulaGraph 中。 +Importer 适用于将本地 CSV 文件的内容导入至{{nebula.name}}中。 ## 优势 @@ -20,7 +20,7 @@ Importer 适用于将本地 CSV 文件的内容导入至 NebulaGraph 中。 在使用 NebulaGraph Importer 之前，请确保： -- 已部署 NebulaGraph 服务。目前有三种部署方式： +- 已部署{{nebula.name}}服务。目前有三种部署方式： - [Docker Compose 部署](../4.deployment-and-installation/2.compile-and-install-nebula-graph/3.deploy-nebula-graph-with-docker-compose.md) @@ -28,13 +28,13 @@ Importer 适用于将本地 CSV 文件的内容导入至 NebulaGraph 中。 - [源码编译安装](../4.deployment-and-installation/2.compile-and-install-nebula-graph/1.install-nebula-graph-by-compiling-the-source-code.md) -- NebulaGraph 中已创建 Schema，包括图空间、Tag 和 Edge type，或者通过参数`clientSettings.postStart.commands`设置。 +- {{nebula.name}} 中已创建 Schema，包括图空间、Tag 和 Edge type，或者通过参数`clientSettings.postStart.commands`设置。 - 运行 Importer 的机器已部署 Golang 环境。详情请参见 [Golang 环境搭建](https://github.com/vesoft-inc/nebula-importer/blob/{{importer.branch}}/docs/golang-install.md)。 ## 操作步骤 -配置 yaml 文件并准备好待导入的 CSV 文件，即可使用本工具向 NebulaGraph 批量写入数据。 +配置 yaml 文件并准备好待导入的 CSV 文件，即可使用本工具向{{nebula.name}}批量写入数据。 ### 下载二进制包运行 @@ -155,7 +155,7 @@ removeTempFiles: false ### 客户端配置 -客户端配置存储客户端连接 NebulaGraph 相关的配置。 +客户端配置存储客户端连接{{nebula.name}}相关的配置。 示例配置如下： @@ -185,14 +185,14 @@ clientSettings: |:---|:---|:---|:---| |`clientSettings.retry`|3|否|nGQL 语句执行失败的重试次数。| |`clientSettings.concurrency`|10|否|NebulaGraph 客户端并发数。| -|`clientSettings.channelBufferSize`|128|否|每个 NebulaGraph 客户端的缓存队列大小。| -|`clientSettings.space`|-|是|指定数据要导入的 NebulaGraph 图空间。不要同时导入多个空间，以免影响性能。| +|`clientSettings.channelBufferSize`|128|否|每个{{nebula.name}}客户端的缓存队列大小。| +|`clientSettings.space`|-|是|指定数据要导入的{{nebula.name}}图空间。不要同时导入多个空间，以免影响性能。| |`clientSettings.connection.user`|-|是|NebulaGraph 的用户名。| |`clientSettings.connection.password`|-|是|NebulaGraph 用户名对应的密码。| |`clientSettings.connection.address`|-|是|所有 Graph 服务的地址和端口。| -|`clientSettings.postStart.commands`|-|否|配置连接 NebulaGraph 服务器之后，在插入数据之前执行的一些操作。| +|`clientSettings.postStart.commands`|-|否|配置连接{{nebula.name}}服务器之后，在插入数据之前执行的一些操作。| |`clientSettings.postStart.afterPeriod`|-|否|执行上述`commands`命令后到执行插入数据命令之间的间隔，例如`8s`。| -|`clientSettings.preStop.commands`|-|否|配置断开 NebulaGraph 服务器连接之前执行的一些操作。| +|`clientSettings.preStop.commands`|-|否|配置断开{{nebula.name}}服务器连接之前执行的一些操作。| ### 文件配置 @@ -292,7 +292,7 @@ schema: |`files.schema.vertex.vid.type`|-|否|点 ID 的数据类型，可选值为`int`和`string`。| |`files.schema.vertex.vid.prefix`|-|否|给 原始vid 添加的前缀，当同时指定了 `function` 时, 生成 VID 的方法是先添加 `prefix` 前缀, 再用 `function`生成 VID。| |`files.schema.vertex.tags.name`|-|是|Tag 名称。| -|`files.schema.vertex.tags.props.name`|-|是|Tag 属性名称，必须和 NebulaGraph 中的 Tag 属性一致。| +|`files.schema.vertex.tags.props.name`|-|是|Tag 属性名称，必须和{{nebula.name}}中的 Tag 属性一致。| |`files.schema.vertex.tags.props.type`|-|是|属性数据类型，支持`bool`、 `int`、 `float`、 `double`、 `string`、 `time`、 `timestamp`、 `date`、 `datetime`、 `geography`、 `geography(point)`、 `geography(linestring)` 和 `geography(polygon)`。| |`files.schema.vertex.tags.props.index`|-|否|属性对应 CSV 文件中列的序号。| |`files.schema.vertex.tags.props.nullable`|`false`|否|属性是否可以为`NULL`，可选`true`或者`false`。| @@ -335,7 +335,7 @@ schema: |`files.schema.edge.dstVID.index`|-|否|边的目的点 ID 对应 CSV 文件中列的序号。| |`files.schema.edge.dstVID.function`|-|否|生成 VID 的函数。目前，我们只支持 `hash` 函数。| |`files.schema.edge.rank.index`|-|否|边的 rank 值对应 CSV 文件中列的序号。| -|`files.schema.edge.props.name`|-|是|Edge type 属性名称，必须和 NebulaGraph 中的 Edge type 属性一致。| +|`files.schema.edge.props.name`|-|是|Edge type 属性名称，必须和{{nebula.name}}中的 Edge type 属性一致。| |`files.schema.edge.props.type`|-|是|属性类型，支持`bool`、`int`、`float`、`double`、`timestamp`、`string`和`geo`。| |`files.schema.edge.props.index`|-|否|属性对应 CSV 文件中列的序号。| diff --git a/docs-2.0/nebula-operator/1.introduction-to-nebula-operator.md b/docs-2.0/nebula-operator/1.introduction-to-nebula-operator.md index 2bdaa2c180b..56af25232db 100644 --- a/docs-2.0/nebula-operator/1.introduction-to-nebula-operator.md +++ b/docs-2.0/nebula-operator/1.introduction-to-nebula-operator.md @@ -2,7 +2,7 @@ ## 基本概念 -NebulaGraph Operator 是用于在 [Kubernetes](https://kubernetes.io) 系统上自动化部署和运维 [NebulaGraph](https://github.com/vesoft-inc/nebula) 集群的工具。依托于 Kubernetes 扩展机制，NebulaGraph 将其运维领域的知识全面注入至 Kubernetes 系统中，让 NebulaGraph 成为真正的[云原生图数据库](https://www.nebula-cloud.io/)。 +NebulaGraph Operator 是用于在 [Kubernetes](https://kubernetes.io) 系统上自动化部署和运维 [NebulaGraph](https://github.com/vesoft-inc/nebula) 集群的工具。依托于 Kubernetes 扩展机制，NebulaGraph 将其运维领域的知识全面注入至 Kubernetes 系统中，让{{nebula.name}}成为真正的[云原生图数据库](https://www.nebula-cloud.io/)。 ![operator_map](https://docs-cdn.nebula-graph.com.cn/figures/operator_map_2022-09-08_18-55-18.png) @@ -10,31 +10,31 @@ NebulaGraph Operator 是用于在 [Kubernetes](https://kubernetes.io) 系统上 对于 Kubernetes 系统内不存在的资源类型，用户可以通过添加自定义 API 对象的方式注册，常见的方法是使用 [CustomResourceDefinition（CRD）](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/#customresourcedefinitions) 。 -NebulaGraph Operator 将 NebulaGraph 集群的部署管理抽象为 CRD。通过结合多个内置的 API 对象，包括 StatefulSet、Service 和 ConfigMap，NebulaGraph 集群的日常管理和维护被编码为一个控制循环。在 Kubernetes 系统内，每一种内置资源对象，都运行着一个特定的控制循环，将它的实际状态通过事先规定好的编排动作，逐步调整为最终的期望状态。当一个 CR 实例被提交时，NebulaGraph Operator 会根据控制流程驱动数据库集群进入最终状态。 +NebulaGraph Operator 将{{nebula.name}}集群的部署管理抽象为 CRD。通过结合多个内置的 API 对象，包括 StatefulSet、Service 和 ConfigMap，NebulaGraph 集群的日常管理和维护被编码为一个控制循环。在 Kubernetes 系统内，每一种内置资源对象，都运行着一个特定的控制循环，将它的实际状态通过事先规定好的编排动作，逐步调整为最终的期望状态。当一个 CR 实例被提交时，NebulaGraph Operator 会根据控制流程驱动数据库集群进入最终状态。 ## 功能介绍 NebulaGraph Operator 已具备的功能如下： -- **集群创建和卸载**：NebulaGraph Operator 简化了用户部署和卸载集群的过程。用户只需提供对应的 CR 文件，NebulaGraph Operator 即可快速创建或者删除一个对应的 NebulaGraph 集群。更多信息参考[使用 Kubectl 部署 NebulaGraph 集群](3.deploy-nebula-graph-cluster/3.1create-cluster-with-kubectl.md)或者[使用 Helm 部署 NebulaGraph 集群](3.deploy-nebula-graph-cluster/3.2create-cluster-with-helm.md)。 +- **集群创建和卸载**：NebulaGraph Operator 简化了用户部署和卸载集群的过程。用户只需提供对应的 CR 文件，NebulaGraph Operator 即可快速创建或者删除一个对应的{{nebula.name}}集群。更多信息参考[使用 Kubectl 部署{{nebula.name}}集群](3.deploy-nebula-graph-cluster/3.1create-cluster-with-kubectl.md)或者[使用 Helm 部署{{nebula.name}}集群](3.deploy-nebula-graph-cluster/3.2create-cluster-with-helm.md)。 -- **集群扩容和缩容**：通过在控制循环中调用 NebulaGraph 原生提供的扩缩容接口，NebulaGraph 封装 NebulaGraph Operator 实现了扩缩容的逻辑，用户可以通过 YAML 配置进行简单的扩缩容，且保证数据的稳定性。更多信息参考[使用 Kubeclt 扩缩容集群](3.deploy-nebula-graph-cluster/3.1create-cluster-with-kubectl.md#_3) 或[使用 Helm 扩缩容集群](3.deploy-nebula-graph-cluster/3.2create-cluster-with-helm.md#_2)。 +- **集群扩容和缩容**：通过在控制循环中调用{{nebula.name}}原生提供的扩缩容接口，NebulaGraph 封装 NebulaGraph Operator 实现了扩缩容的逻辑，用户可以通过 YAML 配置进行简单的扩缩容，且保证数据的稳定性。更多信息参考[使用 Kubeclt 扩缩容集群](3.deploy-nebula-graph-cluster/3.1create-cluster-with-kubectl.md#_3) 或[使用 Helm 扩缩容集群](3.deploy-nebula-graph-cluster/3.2create-cluster-with-helm.md#_2)。 -- **集群升级**：支持升级 {{operator.upgrade_from}} 版的 NebulaGraph 集群至 {{operator.upgrade_to}} 版。 +- **集群升级**：支持升级 {{operator.upgrade_from}} 版的{{nebula.name}}集群至 {{operator.upgrade_to}} 版。 -- **备份和恢复**：支持备份 NebulaGraph 集群的数据至兼容 S3 协议的存储服务中并支持恢复数据至集群中。更多信息参考[使用 NebulaGraph Operator 备份和恢复数据](10.backup-restore-using-operator.md)。 +- **备份和恢复**：支持备份{{nebula.name}}集群的数据至兼容 S3 协议的存储服务中并支持恢复数据至集群中。更多信息参考[使用 NebulaGraph Operator 备份和恢复数据](10.backup-restore-using-operator.md)。 -- **故障自愈**：NebulaGraph Operator 调用 NebulaGraph 集群提供的接口，动态地感知服务状态。一旦发现异常，NebulaGraph Operator 自动进行容错处理。更多信息参考[故障自愈](5.operator-failover.md)。 +- **故障自愈**：NebulaGraph Operator 调用{{nebula.name}}集群提供的接口，动态地感知服务状态。一旦发现异常，NebulaGraph Operator 自动进行容错处理。更多信息参考[故障自愈](5.operator-failover.md)。 -- **均衡调度**：基于调度器扩展接口，NebulaGraph Operator 提供的调度器可以将应用 Pods 均匀地分布在 NebulaGraph 集群中。 +- **均衡调度**：基于调度器扩展接口，NebulaGraph Operator 提供的调度器可以将应用 Pods 均匀地分布在{{nebula.name}}集群中。 ## 使用限制 ### 版本限制 -NebulaGraph Operator 不支持 v1.x 版本的 NebulaGraph，其与 NebulaGraph 版本的对应关系如下： +NebulaGraph Operator 不支持 v1.x 版本的 NebulaGraph，其与{{nebula.name}}版本的对应关系如下： -| NebulaGraph 版本 |NebulaGraph Operator 版本 | +|{{nebula.name}}版本 |NebulaGraph Operator 版本 | | ------------------- | ---------------- | | 3.0.0 ~ 3.4.1 |1.3.0、1.4.0| | 3.0.0 ~ 3.3.x |1.0.0、1.1.0、1.2.0| @@ -45,11 +45,11 @@ NebulaGraph Operator 不支持 v1.x 版本的 NebulaGraph，其与 NebulaGraph !!! Compatibility "历史版本兼容性" - 1.x 版本的 NebulaGraph Operator 不兼容 3.x 以下版本的 NebulaGraph. - - 由于 0.9.0 版本的 NebulaGraph Operator 的日志盘和数据盘分开存储，因此用 0.9.0 版的 NebulaGraph Operator 管理通过 0.8.0 版本创建的 2.5.x 版本的 NebulaGraph 集群会导致兼容性问题。用户可以备份 2.5.x 版本的 NebulaGraph 集群，然后使用 0.9.0 版本的 Operator 创建 2.6.x 版本集群。 + - 由于 0.9.0 版本的 NebulaGraph Operator 的日志盘和数据盘分开存储，因此用 0.9.0 版的 NebulaGraph Operator 管理通过 0.8.0 版本创建的 2.5.x 版本的{{nebula.name}}集群会导致兼容性问题。用户可以备份 2.5.x 版本的{{nebula.name}}集群，然后使用 0.9.0 版本的 Operator 创建 2.6.x 版本集群。 ### 功能限制 -NebulaGraph Operator 的扩缩容功能仅对企业版的 NebulaGraph 集群开放，不支持使用 NebulaGraph Operator 扩缩容社区版的 NebulaGraph 集群。 +NebulaGraph Operator 的扩缩容功能仅对企业版的{{nebula.name}}集群开放，不支持使用 NebulaGraph Operator 扩缩容社区版的{{nebula.name}}集群。 ## 更新说明 diff --git a/docs-2.0/nebula-operator/10.backup-restore-using-operator.md b/docs-2.0/nebula-operator/10.backup-restore-using-operator.md index e434f27b17f..c02d952dcb6 100644 --- a/docs-2.0/nebula-operator/10.backup-restore-using-operator.md +++ b/docs-2.0/nebula-operator/10.backup-restore-using-operator.md @@ -1,18 +1,18 @@ # 使用 NebulaGraph Operator 备份和恢复数据 -本文介绍如何对 Kubernetes 上的 NebulaGraph 集群进行数据备份和数据恢复。 +本文介绍如何对 Kubernetes 上的{{nebula.name}}集群进行数据备份和数据恢复。 !!! enterpriseonly - 仅支持备份和恢复 Kubernetes 上的企业版 NebulaGraph 集群。 + 仅支持备份和恢复 Kubernetes 上的企业版{{nebula.name}}集群。 ## 原理介绍 -[NebulaGraph BR（企业版）](../backup-and-restore/nebula-br-ent/1.br-ent-overview.md)工具是 NebulaGraph 企业版数据备份和恢复的命令行工具。NebulaGraph Operator 基于 BR 工具来实现 Kubernetes 上的 NebulaGraph 集群数据的备份和恢复。 +[NebulaGraph BR（企业版）](../backup-and-restore/nebula-br-ent/1.br-ent-overview.md)工具是{{nebula.name}}企业版数据备份和恢复的命令行工具。NebulaGraph Operator 基于 BR 工具来实现 Kubernetes 上的{{nebula.name}}集群数据的备份和恢复。 -备份数据时，NebulaGraph Operator 会创建一个 Job，然后将 NebulaGraph 集群中的数据备份到指定的存储服务上。 +备份数据时，NebulaGraph Operator 会创建一个 Job，然后将{{nebula.name}}集群中的数据备份到指定的存储服务上。 -恢复数据时，NebulaGraph Operator 会根据 NebulaRestore 资源对象定义的信息检查指定的备份 NebulaGraph 集群是否存在、远端存储的访问是否正常，并且会创建一个新的集群，然后将备份数据恢复到新创建的 NebulaGraph 集群中。更多信息参见[恢复流程图](https://github.com/vesoft-inc/nebula-operator/blob/v{{operator.release}}/doc/user/br_guide.md#restore-nebulagraph-cluster)。 +恢复数据时，NebulaGraph Operator 会根据 NebulaRestore 资源对象定义的信息检查指定的备份{{nebula.name}}集群是否存在、远端存储的访问是否正常，并且会创建一个新的集群，然后将备份数据恢复到新创建的{{nebula.name}}集群中。更多信息参见[恢复流程图](https://github.com/vesoft-inc/nebula-operator/blob/v{{operator.release}}/doc/user/br_guide.md#restore-nebulagraph-cluster)。 ## 前提条件 @@ -20,7 +20,7 @@ 使用 NebulaGraph Operator 备份和恢复数据，需要满足以下条件： - Nebula Operator 版本 >= 1.4.0。 -- Kubernetes 上部署的企业版 NebulaGraph 集群正在运行。 +- Kubernetes 上部署的企业版{{nebula.name}}集群正在运行。 - 在创建集群的 YAML 中，设置了`spec.enableBR`为`true`。 ``` @@ -49,7 +49,7 @@ ### 全量备份 -当备份数据至兼容 S3 协议的存储服务上时，需要创建一个备份任务（Job），它会将全量 NebulaGraph 数据备份到指定的存储位置。 +当备份数据至兼容 S3 协议的存储服务上时，需要创建一个备份任务（Job），它会将全量{{nebula.name}}数据备份到指定的存储位置。 全量备份任务（Job）的 YAML 示例如下： @@ -158,7 +158,7 @@ Storaged Pod的init容器下载备份数据，下载成功由agent容器进行 ### 恢复过程 -当恢复备份在兼容 S3 协议服务上的数据时，需要创建一个 Secret，用于存储访问兼容 S3 协议的服务的凭证。然后创建一个恢复数据的资源对象（NebulaRestore），它会告诉 Operator 基于此资源对象定义的信息创建一个新的 NebulaGraph 集群，将备份数据恢复到新创建的集群中。 +当恢复备份在兼容 S3 协议服务上的数据时，需要创建一个 Secret，用于存储访问兼容 S3 协议的服务的凭证。然后创建一个恢复数据的资源对象（NebulaRestore），它会告诉 Operator 基于此资源对象定义的信息创建一个新的{{nebula.name}}集群，将备份数据恢复到新创建的集群中。 基于备份文件`BACKUP_2023_02_12_10_04_16`恢复数据的 YAML 示例： diff --git a/docs-2.0/nebula-operator/11.rolling-update-strategy.md b/docs-2.0/nebula-operator/11.rolling-update-strategy.md index cc7d5ea0a07..1029395e884 100644 --- a/docs-2.0/nebula-operator/11.rolling-update-strategy.md +++ b/docs-2.0/nebula-operator/11.rolling-update-strategy.md @@ -1,17 +1,17 @@ -# NebulaGraph 集群的滚动更新策略 +# {{nebula.name}}集群的滚动更新策略 -NebulaGraph 集群使用分布式架构将数据分成多个逻辑分片，这些分片通常均分在不同的节点上。分布式系统中，同一份数据通常会有多个副本。为了保证多个副本数据的一致性，NebulaGraph 集群使用 Raft 协议实现了多分片副本同步。Raft 协议中，每个分片都会选举出一个 Leader 副本，Leader 副本负责处理写请求，Follower 副本负责处理读请求。 +{{nebula.name}}集群使用分布式架构将数据分成多个逻辑分片，这些分片通常均分在不同的节点上。分布式系统中，同一份数据通常会有多个副本。为了保证多个副本数据的一致性，NebulaGraph 集群使用 Raft 协议实现了多分片副本同步。Raft 协议中，每个分片都会选举出一个 Leader 副本，Leader 副本负责处理写请求，Follower 副本负责处理读请求。 -通过 Operator 创建的 NebulaGraph 集群在滚动更新过程中，一个存储节点会暂时停止提供服务以进行更新。关于滚动更新的概述，参见[执行滚动更新](https://kubernetes.io/zh-cn/docs/tutorials/kubernetes-basics/update/update-intro/)。如果 Leader 副本所在的节点停止提供服务，会导致该分片的读写不可用。为了避免这种情况，Operator 会在 NebulaGraph 集群滚动更新过程中，默认将 Leader 副本迁移到其他未受影响节点上。这样，当一个存储节点处于更新状态时，其他节点上的 Leader 副本能够继续处理客户端请求，以保证集群的读写可用性。 +通过 Operator 创建的{{nebula.name}}集群在滚动更新过程中，一个存储节点会暂时停止提供服务以进行更新。关于滚动更新的概述，参见[执行滚动更新](https://kubernetes.io/zh-cn/docs/tutorials/kubernetes-basics/update/update-intro/)。如果 Leader 副本所在的节点停止提供服务，会导致该分片的读写不可用。为了避免这种情况，Operator 会在{{nebula.name}}集群滚动更新过程中，默认将 Leader 副本迁移到其他未受影响节点上。这样，当一个存储节点处于更新状态时，其他节点上的 Leader 副本能够继续处理客户端请求，以保证集群的读写可用性。 一个存储节点上的所有 Leader 副本全部迁移到其他节点的这个过程可能会持续较长时间。为了更好地控制滚动更新的时间，Operator 提供了一个名为`enableForceUpdate`参数。当确定没有外部访问流量时，可将该参数设置为`true`，这样，Leader 副本将不会被迁移到其他节点上，从而加快滚动更新的速度。 ## 滚动更新触发条件 -Operator 会在以下情况下触发 NebulaGraph 集群的滚动更新： +Operator 会在以下情况下触发{{nebula.name}}集群的滚动更新： -- NebulaGraph 集群的版本发生变化。 -- NebulaGraph 集群的配置发生变化。 +- {{nebula.name}} 集群的版本发生变化。 +- {{nebula.name}} 集群的配置发生变化。 ## 配置滚动更新策略 diff --git a/docs-2.0/nebula-operator/2.deploy-nebula-operator.md b/docs-2.0/nebula-operator/2.deploy-nebula-operator.md index 13c8d855ecf..067680d4151 100644 --- a/docs-2.0/nebula-operator/2.deploy-nebula-operator.md +++ b/docs-2.0/nebula-operator/2.deploy-nebula-operator.md @@ -4,7 +4,7 @@ ## 背景信息 -[NebulaGraph Operator](1.introduction-to-nebula-operator.md) 为用户管理 NebulaGraph 集群，使用户无需在生产环境中手动安装、扩展、升级和卸载 NebulaGraph，减轻用户管理不同应用版本的负担。 +[NebulaGraph Operator](1.introduction-to-nebula-operator.md) 为用户管理{{nebula.name}}集群，使用户无需在生产环境中手动安装、扩展、升级和卸载 NebulaGraph，减轻用户管理不同应用版本的负担。 ## 前提条件 @@ -204,7 +204,7 @@ helm install nebula-operator nebula-operator/nebula-operator --namespace=-graphd-svc`、类型为`ClusterIP`的 Service。通过该 Service 的 IP 和数据库的端口号，用户可连接 NebulaGraph 数据库。 +当使用 NebulaGraph Operator 创建{{nebula.name}}集群后，NebulaGraph Operator 会自动在同一命名空间下，创建名为`-graphd-svc`、类型为`ClusterIP`的 Service。通过该 Service 的 IP 和数据库的端口号，用户可连接{{nebula.name}}。 1. 查看 Service，命令如下： @@ -22,7 +22,7 @@ `ClusterIP`类型的 Service 只允许在集群内部访问容器应用。更多信息，请参考 [ClusterIP](https://kubernetes.io/docs/concepts/services-networking/service/)。 -2. 使用上述`-graphd-svc` Service 的 IP 连接 NebulaGraph 数据库： +2. 使用上述`-graphd-svc` Service 的 IP 连接{{nebula.name}}： ```bash kubectl run -ti --image vesoft/nebula-console:{{console.tag}} --restart=Never -- -addr -port -u -p @@ -34,7 +34,7 @@ kubectl run -ti --image vesoft/nebula-console:{{console.tag}} --restart=Never -- nebula-console -addr 10.98.213.34 -port 9669 -u root -p vesoft ``` - - `--image`：为连接 NebulaGraph 的工具 NebulaGraph Console 的镜像。 + - `--image`：为连接{{nebula.name}}的工具 NebulaGraph Console 的镜像。 - ``：自定义的 Pod 名称。 - `-addr`：连接 Graphd 服务的 IP 地址，即`ClusterIP`类型的 Service IP 地址。 - `-port`：连接 Graphd 服务的端口。默认端口为 9669。 @@ -56,7 +56,7 @@ kubectl run -ti --image vesoft/nebula-console:{{console.tag}} --restart=Never -- ``` `CLUSTER_DOMAIN`的默认值为`cluster.local`。 -## 通过`NodePort`在 NebulaGraph 集群外部连接 NebulaGraph 数据库 +## 通过`NodePort`在{{nebula.name}}集群外部连接{{nebula.name}} 用户可创建`NodePort`类型的 Service，通过节点 IP 和暴露的节点端口，从集群外部访问集群内部的服务。用户也可以使用云厂商（例如 Azure、AWS 等）提供的负载均衡服务，设置 Service 的类型为`LoadBalancer`。 @@ -96,7 +96,7 @@ kubectl run -ti --image vesoft/nebula-console:{{console.tag}} --restart=Never -- type: NodePort ``` - - NebulaGraph 默认使用`9669`端口为客户端提供服务。`19669`为 Graph 服务端口号。 + - {{nebula.name}} 默认使用`9669`端口为客户端提供服务。`19669`为 Graph 服务端口号。 - `targetPort`的值为映射至 Pod 的端口，可自定义。 2. 执行以下命令使 Service 服务在集群中生效。 @@ -105,7 +105,7 @@ kubectl run -ti --image vesoft/nebula-console:{{console.tag}} --restart=Never -- kubectl create -f graphd-nodeport-service.yaml ``` -3. 查看 Service 中 NebulaGraph 映射至集群节点的端口。 +3. 查看 Service 中{{nebula.name}}映射至集群节点的端口。 ```bash kubectl get services @@ -138,18 +138,18 @@ kubectl run -ti --image vesoft/nebula-console:{{console.tag}} --restart=Never -- (root@nebula) [(none)]> ``` - - `--image`：为连接 NebulaGraph 的工具 NebulaGraph Console 的镜像。 + - `--image`：为连接{{nebula.name}}的工具 NebulaGraph Console 的镜像。 - ``：自定义的 Pod 名称。本示例为`nebula-console2`。 - `-addr`：NebulaGraph 集群中任一节点 IP 地址。本示例为`192.168.8.24`。 - `-port`：NebulaGraph 映射至节点的端口。本示例为`32236`。 - `-u`：NebulaGraph 账号的用户名。未启用身份认证时，可以使用任意已存在的用户名（默认为 root）。 - `-p`：用户名对应的密码。未启用身份认证时，密码可以填写任意字符。 -## 通过`Ingress`在 NebulaGraph 集群外部连接 NebulaGraph 数据库 +## 通过`Ingress`在{{nebula.name}}集群外部连接{{nebula.name}} Nginx Ingress 是 Kubernetes Ingress 的一个实现。Nginx Ingress 通过 Watch 机制感知 Kubernetes 集群的 Ingress 资源，将 Ingress 规则生成 Nginx 配置，使 Nginx 能够转发 7 层流量。 -用户可以通过 HostNetwork 和 DaemonSet 组合的模式使用 Nginx Ingress 从集群外部连接 NebulaGraph 集群。 +用户可以通过 HostNetwork 和 DaemonSet 组合的模式使用 Nginx Ingress 从集群外部连接{{nebula.name}}集群。 由于使用 HostNetwork，Nginx Ingress 的 Pod 就不能被调度在同一个节点上。为了避免监听端口冲突，可以事先选择一些节点并将其标记为边缘节点，专门用于部署 Nginx Ingress。然后 Nginx Ingress 以 DaemonSet 模式部署在这些节点上。 @@ -207,9 +207,9 @@ data: daemonset.apps/nginx-ingress-controller created ``` - 成功部署 Nginx Ingress 后，由于 Nginx Ingress 中配置的网络类型为`hostNetwork`，因此用户可通过部署了 Nginx Ingress 的节点的 IP（`192.168.8.160`）和外部端口（`9769`）访问 NebulaGraph 服务。 + 成功部署 Nginx Ingress 后，由于 Nginx Ingress 中配置的网络类型为`hostNetwork`，因此用户可通过部署了 Nginx Ingress 的节点的 IP（`192.168.8.160`）和外部端口（`9769`）访问{{nebula.name}}服务。 -4. 执行以下命令部署连接 NebulaGraph 服务的 Console 并通过宿主机 IP（本示例为`192.168.8.160`）和上述配置的外部端口访问 NebulaGraph 服务。 +4. 执行以下命令部署连接{{nebula.name}}服务的 Console 并通过宿主机 IP（本示例为`192.168.8.160`）和上述配置的外部端口访问{{nebula.name}}服务。 ```bash kubectl run -ti --image vesoft/nebula-console:{{console.tag}} --restart=Never -- -addr -port -u -p @@ -221,7 +221,7 @@ data: kubectl run -ti --image vesoft/nebula-console:{{console.tag}} --restart=Never -- nebula-console -addr 192.168.8.160 -port 9769 -u root -p vesoft ``` - - `--image`：为连接 NebulaGraph 的工具 NebulaGraph Console 的镜像。 + - `--image`：为连接{{nebula.name}}的工具 NebulaGraph Console 的镜像。 - ``：自定义的 Pod 名称。本示例为`nebula-console`。 - `-addr`：部署 Nginx Ingress 的节点 IP，本示例为`192.168.8.160`。 - `-port`：外网访问使用的的端口。本示例设置为`9769`。 diff --git a/docs-2.0/nebula-operator/5.operator-failover.md b/docs-2.0/nebula-operator/5.operator-failover.md index fc6abb58e9b..4c6c77222c1 100644 --- a/docs-2.0/nebula-operator/5.operator-failover.md +++ b/docs-2.0/nebula-operator/5.operator-failover.md @@ -1,6 +1,6 @@ # 故障自愈 -NebulaGraph Operator 调用 NebulaGraph 集群提供的接口，动态地感知服务是否正常运行。当 NebulaGraph 集群中某一组件停止运行时，NebulaGraph Operator 会自动地进行容错处理。本文通过删除 NebulaGraph 集群中 1 个 Storage 服务 Pod，模拟集群故障为例，说明 Nebular Operator 如何进行故障自愈。 +NebulaGraph Operator 调用{{nebula.name}}集群提供的接口，动态地感知服务是否正常运行。当{{nebula.name}}集群中某一组件停止运行时，NebulaGraph Operator 会自动地进行容错处理。本文通过删除{{nebula.name}}集群中 1 个 Storage 服务 Pod，模拟集群故障为例，说明 Nebular Operator 如何进行故障自愈。 ## 前提条件 @@ -8,14 +8,14 @@ NebulaGraph Operator 调用 NebulaGraph 集群提供的接口，动态地感知 ## 操作步骤 -1. 创建 NebulaGraph 集群。具体步骤参考[使用 Kubectl 部署 NebulaGraph 集群](3.deploy-nebula-graph-cluster/3.1create-cluster-with-kubectl.md)或者[使用 Helm 部署 NebulaGraph 集群](3.deploy-nebula-graph-cluster/3.2create-cluster-with-helm.md)。 +1. 创建{{nebula.name}}集群。具体步骤参考[使用 Kubectl 部署{{nebula.name}}集群](3.deploy-nebula-graph-cluster/3.1create-cluster-with-kubectl.md)或者[使用 Helm 部署{{nebula.name}}集群](3.deploy-nebula-graph-cluster/3.2create-cluster-with-helm.md)。 2. 待所有 Pods 都处于`Running`状态时，模拟故障，删除名为`-storaged-2` Pod。 ```bash kubectl delete pod -storaged-2 --now ``` -``为 NebulaGraph 集群的名称。 +``为{{nebula.name}}集群的名称。 3. NebulaGraph Operator 自动创建名为`-storaged-2`的 Pod，以修复故障。 diff --git a/docs-2.0/nebula-operator/6.get-started-with-operator.md b/docs-2.0/nebula-operator/6.get-started-with-operator.md index a19b95776a9..1a2695c519a 100644 --- a/docs-2.0/nebula-operator/6.get-started-with-operator.md +++ b/docs-2.0/nebula-operator/6.get-started-with-operator.md @@ -1,10 +1,10 @@ # 使用流程 -使用 NebulaGraph Operator 访问 NebulaGraph 集群服务的流程如下： +使用 NebulaGraph Operator 访问{{nebula.name}}集群服务的流程如下： 1. [安装 NebulaGraph Operator](2.deploy-nebula-operator.md)。 -2. 创建 NebulaGraph 集群。 +2. 创建{{nebula.name}}集群。 - 具体步骤参考[使用 Kubectl 部署 NebulaGraph 集群](3.deploy-nebula-graph-cluster/3.1create-cluster-with-kubectl.md)或者[使用 Helm 部署 NebulaGraph 集群](3.deploy-nebula-graph-cluster/3.2create-cluster-with-helm.md)。 + 具体步骤参考[使用 Kubectl 部署{{nebula.name}}集群](3.deploy-nebula-graph-cluster/3.1create-cluster-with-kubectl.md)或者[使用 Helm 部署{{nebula.name}}集群](3.deploy-nebula-graph-cluster/3.2create-cluster-with-helm.md)。 -3. [连接 NebulaGraph 服务](4.connect-to-nebula-graph-service.md)。 +3. [连接{{nebula.name}}服务](4.connect-to-nebula-graph-service.md)。 diff --git a/docs-2.0/nebula-operator/7.operator-faq.md b/docs-2.0/nebula-operator/7.operator-faq.md index 88020660d8d..2b06b22f265 100644 --- a/docs-2.0/nebula-operator/7.operator-faq.md +++ b/docs-2.0/nebula-operator/7.operator-faq.md @@ -1,8 +1,8 @@ # 常见问题 -## NebulaGraph Operator 支持 v1.x 版本的 NebulaGraph 吗？ +## NebulaGraph Operator 支持 v1.x 版本的{{nebula.name}}吗？ -不支持，因为 v1.x 版本的 NebulaGraph 不支持 DNS，而 NebulaGraph Operator 需要使用 DNS。 +不支持，因为 v1.x 版本的{{nebula.name}}不支持 DNS，而 NebulaGraph Operator 需要使用 DNS。 ## 使用本地存储是否可以保证集群稳定性？ @@ -12,6 +12,6 @@ 建议提前备份数据，以便故障发生时回滚数据。 -## Operator 文档中的 replica 和 NebulaGraph 内核文档中的 replica 是一样的吗？ +## Operator 文档中的 replica 和{{nebula.name}}内核文档中的 replica 是一样的吗？ -二者是不同的概念。Operator 文档中的 replica 是 K8s 中的 Pod 副本，而内核文档中的 replica 是 NebulaGraph 中的分片副本。 +二者是不同的概念。Operator 文档中的 replica 是 K8s 中的 Pod 副本，而内核文档中的 replica 是{{nebula.name}}中的分片副本。 diff --git a/docs-2.0/nebula-operator/8.custom-cluster-configurations/8.1.custom-conf-parameter.md b/docs-2.0/nebula-operator/8.custom-cluster-configurations/8.1.custom-conf-parameter.md index 174ae62216c..2253a9ceac6 100644 --- a/docs-2.0/nebula-operator/8.custom-cluster-configurations/8.1.custom-conf-parameter.md +++ b/docs-2.0/nebula-operator/8.custom-cluster-configurations/8.1.custom-conf-parameter.md @@ -1,10 +1,10 @@ -# 自定义 NebulaGraph 集群的配置参数 +# 自定义{{nebula.name}}集群的配置参数 -NebulaGraph 集群中 Meta、Storage、Graph 服务都有各自的配置，其在用户创建的 CR 实例（NebulaGraph 集群）的 YAML 文件中被定义为`config`。`config`中的设置会被映射并加载到对应服务的 ConfigMap 中。 +{{nebula.name}}集群中 Meta、Storage、Graph 服务都有各自的配置，其在用户创建的 CR 实例（NebulaGraph 集群）的 YAML 文件中被定义为`config`。`config`中的设置会被映射并加载到对应服务的 ConfigMap 中。 !!! note - 暂不支持通过 Helm 自定义 NebulaGraph 集群的配置参数。 + 暂不支持通过 Helm 自定义{{nebula.name}}集群的配置参数。 `config`结构如下： @@ -14,7 +14,7 @@ Config map[string]string `json:"config,omitempty"` ## 前提条件 -已使用 K8s 创建一个集群。具体步骤，参见[使用 Kubectl 创建 NebulaGraph 集群](../3.deploy-nebula-graph-cluster/3.1create-cluster-with-kubectl.md)。 +已使用 K8s 创建一个集群。具体步骤，参见[使用 Kubectl 创建{{nebula.name}}集群](../3.deploy-nebula-graph-cluster/3.1create-cluster-with-kubectl.md)。 ## 操作步骤 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 ffcb6cdb3de..b3ce90c9105 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 @@ -1,13 +1,13 @@ # 回收 PV -NebulaGraph Operator 使用持久化卷 PV（Persistent Volume）和持久化卷声明 PVC（Persistent Volume Claim）来存储持久化数据。如果用户不小心删除了一个 NebulaGraph 集群，默认 PV 和 PVC 对象及其数据仍可保留，以确保数据安全。 +NebulaGraph Operator 使用持久化卷 PV（Persistent Volume）和持久化卷声明 PVC（Persistent Volume Claim）来存储持久化数据。如果用户不小心删除了一个{{nebula.name}}集群，默认 PV 和 PVC 对象及其数据仍可保留，以确保数据安全。 用户也可以在集群实例的配置文件中通过设置参数`spec.enablePVReclaim`为`true`来定义在删除集群后自动删除 PVC 以释放数据。至于在删除 PVC 后是否删除 PV，用户需要自定义 PV 的回收策略。参见 [StorageClass 中设置 reclaimPolicy](https://kubernetes.io/docs/concepts/storage/storage-classes/#reclaim-policy) 和 [PV Reclaiming](https://kubernetes.io/docs/concepts/storage/persistent-volumes/#reclaiming) 了解 PV 回收策略。 ## 前提条件 -已使用 K8s 创建一个集群。具体步骤，参见[使用 Kubectl 创建 NebulaGraph 集群](../3.deploy-nebula-graph-cluster/3.1create-cluster-with-kubectl.md)。 +已使用 K8s 创建一个集群。具体步骤，参见[使用 Kubectl 创建{{nebula.name}}集群](../3.deploy-nebula-graph-cluster/3.1create-cluster-with-kubectl.md)。 ## 操作步骤 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 c418c5c54c1..b32b30c9d2f 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 @@ -2,17 +2,17 @@ !!! enterpriseonly - 仅企业版 NebulaGraph 集群支持均衡扩容后的 Storage 数据。 + 仅企业版{{nebula.name}}集群支持均衡扩容后的 Storage 数据。 用户在扩容 Storage 服务后，可以自主决定是否均衡 Storage 服务中的数据。本文介绍如何设置均衡 Storage 数据。 -NebulaGraph 的 Storage 服务的扩容分为两个阶段，第一个阶段等待所有扩容的 Pods 为`Ready`的状态；第二个阶段执行`BALANCE DATA`和`BALANCE LEADER`命令均衡数据。这两个阶段将控制器副本的扩容过程与均衡数据过程解耦，使用户可以选择在低流量时进行均衡数据操作，有效降低数据迁移对在线服务的影响。 +{{nebula.name}}的 Storage 服务的扩容分为两个阶段，第一个阶段等待所有扩容的 Pods 为`Ready`的状态；第二个阶段执行`BALANCE DATA`和`BALANCE LEADER`命令均衡数据。这两个阶段将控制器副本的扩容过程与均衡数据过程解耦，使用户可以选择在低流量时进行均衡数据操作，有效降低数据迁移对在线服务的影响。 用户可以在集群的 CR 实例的配置文件中通过参数`enableAutoBalance`来控制是否自动均衡数据。 ## 前提条件 -已使用 K8s 创建一个集群。具体步骤，参见[使用 Kubectl 创建 NebulaGraph 集群](../3.deploy-nebula-graph-cluster/3.1create-cluster-with-kubectl.md)。 +已使用 K8s 创建一个集群。具体步骤，参见[使用 Kubectl 创建{{nebula.name}}集群](../3.deploy-nebula-graph-cluster/3.1create-cluster-with-kubectl.md)。 ## 操作步骤 diff --git a/docs-2.0/nebula-operator/8.custom-cluster-configurations/8.4.manage-running-logs.md b/docs-2.0/nebula-operator/8.custom-cluster-configurations/8.4.manage-running-logs.md index c3d58d2f67d..e63322dc7f1 100644 --- a/docs-2.0/nebula-operator/8.custom-cluster-configurations/8.4.manage-running-logs.md +++ b/docs-2.0/nebula-operator/8.custom-cluster-configurations/8.4.manage-running-logs.md @@ -1,10 +1,10 @@ # 管理集群日志 -NebulaGraph 集群各服务（graphd、metad、storaged）在运行期间会生成运行日志，日志默认存放在各个服务容器的`/usr/local/nebula/logs`目录下。 +{{nebula.name}}集群各服务（graphd、metad、storaged）在运行期间会生成运行日志，日志默认存放在各个服务容器的`/usr/local/nebula/logs`目录下。 ## 查看运行日志 -如果您需要查看 NebulaGraph 集群的运行日志，可以通过`kubectl logs`命令查看。 +如果您需要查看{{nebula.name}}集群的运行日志，可以通过`kubectl logs`命令查看。 例如，查看 Storage 服务的运行日志： @@ -29,7 +29,7 @@ $ cd /usr/local/nebula/logs 集群服务在运行期间生成的运行日志会占用磁盘空间，为避免占用过多磁盘空间，Operator 使用 sidecar 容器定期清理和归档日志。 -为了方便日志的采集和管理，每个 NebulaGraph 服务都会部署一个 sidecar 容器，负责收集该服务容器产生的日志，并将其发送到指定的日志磁盘中。sidecar 容器使用 [logrotate](https://linux.die.net/man/8/logrotate) 工具自动清理和归档日志。 +为了方便日志的采集和管理，每个{{nebula.name}}服务都会部署一个 sidecar 容器，负责收集该服务容器产生的日志，并将其发送到指定的日志磁盘中。sidecar 容器使用 [logrotate](https://linux.die.net/man/8/logrotate) 工具自动清理和归档日志。 在集群实例的 YAML 配置文件中，可以通过`spec.logRotate`字段配置日志轮转以自动对日志进行清理和归档。默认情况下，日志轮转功能是关闭的。开启日志轮转功能示例如下： 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 1d9c1ca41bc..8264f43d740 100644 --- a/docs-2.0/nebula-operator/9.upgrade-nebula-cluster.md +++ b/docs-2.0/nebula-operator/9.upgrade-nebula-cluster.md @@ -1,6 +1,6 @@ -# 升级 NebulaGraph 集群 +# 升级{{nebula.name}}集群 -本文介绍如何升级通过 NebulaGraph Operator 创建的 NebulaGraph 集群。 +本文介绍如何升级通过 NebulaGraph Operator 创建的{{nebula.name}}集群。 !!! Compatibility "历史版本兼容性" @@ -9,22 +9,22 @@ ## 使用限制 -- 只支持升级使用 NebulaGraph Operator 创建的 NebulaGraph 集群。 +- 只支持升级使用 NebulaGraph Operator 创建的{{nebula.name}}集群。 - 只支持升级 NebulaGraph {{operator.upgrade_from}} 至 {{operator.upgrade_to}} 版本。 {{ ent.ent_begin }} -- 如需升级 NebulaGraph 企业版，[联系我们](https://www.nebula-graph.com.cn/contact)。 +- 如需升级{{nebula.name}}企业版，[联系我们](https://www.nebula-graph.com.cn/contact)。 {{ ent.ent_end }} -## 使用 Kubectl 升级 NebulaGraph 集群 +## 使用 Kubectl 升级{{nebula.name}}集群 ### 前提条件 -已创建 NebulaGraph 集群。具体步骤，参见[使用 Kubectl 创建 NebulaGraph 集群](3.deploy-nebula-graph-cluster/3.1create-cluster-with-kubectl.md)。 +已创建{{nebula.name}}集群。具体步骤，参见[使用 Kubectl 创建{{nebula.name}}集群](3.deploy-nebula-graph-cluster/3.1create-cluster-with-kubectl.md)。 -本文示例中待升级的 NebulaGraph 版本为 {{operator.upgrade_from}}，其 YAML 文件名为`apps_v1alpha1_nebulacluster.yaml`。 +本文示例中待升级的{{nebula.name}}版本为 {{operator.upgrade_from}}，其 YAML 文件名为`apps_v1alpha1_nebulacluster.yaml`。 ### 操作步骤 @@ -144,11 +144,11 @@ 3 vesoft/nebula-storaged:{{nebula.tag}} ``` -## 使用 Helm 升级 NebulaGraph 集群 +## 使用 Helm 升级{{nebula.name}}集群 ### 前提条件 -已创建 NebulaGraph 集群。具体步骤，参见[使用 Helm 创建 NebulaGraph 集群](3.deploy-nebula-graph-cluster/3.2create-cluster-with-helm.md)。 +已创建{{nebula.name}}集群。具体步骤，参见[使用 Helm 创建{{nebula.name}}集群](3.deploy-nebula-graph-cluster/3.2create-cluster-with-helm.md)。 ### 操作步骤 @@ -161,13 +161,13 @@ 2. 配置 Helm 的环境变量。 ```bash - export NEBULA_CLUSTER_NAME=nebula # NebulaGraph 集群的名字。 - export NEBULA_CLUSTER_NAMESPACE=nebula # NebulaGraph 集群所处的命名空间的名字。 + export NEBULA_CLUSTER_NAME=nebula #{{nebula.name}}集群的名字。 + export NEBULA_CLUSTER_NAMESPACE=nebula #{{nebula.name}}集群所处的命名空间的名字。 ``` -3. 升级 NebulaGraph 集群。 +3. 升级{{nebula.name}}集群。 - 例如升级至 {{nebula.tag}} NebulaGraph 集群的命令如下。 + 例如升级至 {{nebula.tag}}{{nebula.name}}集群的命令如下。 ```bash helm upgrade "${NEBULA_CLUSTER_NAME}" nebula-operator/nebula-cluster \ 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 e4d0b8d826b..4e1e4d08349 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 @@ -16,7 +16,7 @@ NebulaGraph Studio（简称 Studio）是一款可以通过 Web 访问的开源 Studio 可以方便管理{{nebula.name}}数据，具备以下功能： -- 使用 **Schema** 管理功能，用户可以使用图形界面完成图空间、Tag（标签）、Edge Type（边类型）、索引的创建，查看图空间的统计数据，快速上手 NebulaGraph。 +- 使用 **Schema** 管理功能，用户可以使用图形界面完成图空间、Tag（标签）、Edge Type（边类型）、索引的创建，查看图空间的统计数据，快速上手{{nebula.name}}。 - 使用**导入**功能，通过简单的配置，用户即能批量导入点和边数据，并能实时查看数据导入日志。 diff --git a/docs-2.0/nebula-studio/deploy-connect/st-ug-connect.md b/docs-2.0/nebula-studio/deploy-connect/st-ug-connect.md index 55a5cf43031..9915a7b4fb0 100644 --- a/docs-2.0/nebula-studio/deploy-connect/st-ug-connect.md +++ b/docs-2.0/nebula-studio/deploy-connect/st-ug-connect.md @@ -1,6 +1,6 @@ # 连接数据库 -在成功启动 Studio 后，用户需要配置连接 NebulaGraph。本文主要描述 Studio 如何连接{{nebula.name}}。 +在成功启动 Studio 后，用户需要配置连接{{nebula.name}}。本文主要描述 Studio 如何连接{{nebula.name}}。 ## 前提条件 @@ -63,9 +63,6 @@ 账号的权限决定了能执行哪些操作。详情参见[内置角色权限](../../7.data-security/1.authentication/3.role-list.md)。 ### 登出 - 如果需要重新连接{{nebula.name}}，可以登出后重新配置数据库。 diff --git a/docs-2.0/nebula-studio/deploy-connect/st-ug-deploy.md b/docs-2.0/nebula-studio/deploy-connect/st-ug-deploy.md index 05e2273d50f..f388b4e3153 100644 --- a/docs-2.0/nebula-studio/deploy-connect/st-ug-deploy.md +++ b/docs-2.0/nebula-studio/deploy-connect/st-ug-deploy.md @@ -330,4 +330,4 @@ $ helm uninstall my-studio ## 后续操作 -进入 Studio 登录界面后，用户需要连接 NebulaGraph。详细信息，参考[连接数据库](st-ug-connect.md)。 +进入 Studio 登录界面后，用户需要连接{{nebula.name}}。详细信息，参考[连接数据库](st-ug-connect.md)。 diff --git a/docs-2.0/nebula-studio/troubleshooting/st-ug-config-server-errors.md b/docs-2.0/nebula-studio/troubleshooting/st-ug-config-server-errors.md index 592b405c615..28f57e9b001 100644 --- a/docs-2.0/nebula-studio/troubleshooting/st-ug-config-server-errors.md +++ b/docs-2.0/nebula-studio/troubleshooting/st-ug-config-server-errors.md @@ -22,14 +22,14 @@ 检查{{nebula.name}}服务状态。关于查看服务的操作： -- 如果在 Linux 服务器上通过编译部署的 NebulaGraph，参考[查看{{nebula.name}}服务](../../4.deployment-and-installation/2.compile-and-install-nebula-graph/deploy-nebula-graph-cluster.md "点击查看{{nebula.name}}内核文档")。 -- 如果使用 Docker Compose 部署和 RPM 部署的 NebulaGraph，参考[查看{{nebula.name}}服务状态和端口](../deploy-connect/st-ug-deploy.md "点击前往 GitHub 网站")。 +- 如果在 Linux 服务器上通过编译部署的{{nebula.name}}，参考[查看{{nebula.name}}服务](../../4.deployment-and-installation/2.compile-and-install-nebula-graph/deploy-nebula-graph-cluster.md "点击查看{{nebula.name}}内核文档")。 +- 如果使用 Docker Compose 部署和 RPM 部署的{{nebula.name}}，参考[查看{{nebula.name}}服务状态和端口](../deploy-connect/st-ug-deploy.md "点击前往 GitHub 网站")。 如果{{nebula.name}}服务正常，进入第 4 步继续排查问题。否则，请重启{{nebula.name}}服务。 !!! Note - 如果之前使用 `docker-compose up -d` 启动 NebulaGraph，必须运行 `docker-compose down` 命令停止 NebulaGraph。 + 如果之前使用 `docker-compose up -d` 启动{{nebula.name}}，必须运行 `docker-compose down` 命令停止{{nebula.name}}。 ### 第 4 步。确认 Graph 服务的网络连接是否正常 diff --git a/docs-2.0/reuse/source_connect-to-nebula-graph.md b/docs-2.0/reuse/source_connect-to-nebula-graph.md index effcf2f58fd..8c0334b3779 100644 --- a/docs-2.0/reuse/source_connect-to-nebula-graph.md +++ b/docs-2.0/reuse/source_connect-to-nebula-graph.md @@ -49,7 +49,7 @@ 5. 在命令行界面中，切换工作目录至 nebula-console 文件所在目录。 -6. 执行如下命令连接 NebulaGraph。 +6. 执行如下命令连接{{nebula.name}}。 - Linux 或 macOS diff --git a/docs-2.0/reuse/source_create_instance_aliyun.md b/docs-2.0/reuse/source_create_instance_aliyun.md index 7af8ddfe77c..fca6255ace8 100644 --- a/docs-2.0/reuse/source_create_instance_aliyun.md +++ b/docs-2.0/reuse/source_create_instance_aliyun.md @@ -18,15 +18,15 @@ NebulaGraph Cloud 阿里云版支持免费试用和付费使用，二者的详 | 云资源归属 | 阿里云官方账号 | 用户账号 | | 云资源费用 | **阿里云承担** | 用户承担 | | 云资源使用时长 | 30 天（不可续期） | 用户创建实例时选择 | -| NebulaGraph 许可证费用 | **试用期内免费** | 用户承担 | -| NebulaGraph 服务许可证有效期 | 30 天 | 用户创建实例时选择 | +|{{nebula.name}}许可证费用 | **试用期内免费** | 用户承担 | +|{{nebula.name}}服务许可证有效期 | 30 天 | 用户创建实例时选择 | | 许可证过期后数据是否保留 | 否（因云资源会同时到期） | 是 | | 云资源到期后数据是否保留 | 否 | 否 | | 数据盘快照费用 | **阿里云承担** | 用户承担（可关闭功能） | ## 数据备份 -在创建服务实例时，系统会默认开启数据盘自动快照备份，用于周期性备份 NebulaGraph 数据。 +在创建服务实例时，系统会默认开启数据盘自动快照备份，用于周期性备份{{nebula.name}}数据。 创建付费版服务实例前需[开通快照](https://help.aliyun.com/document_detail/108381.html)。免费试用实例使用的是阿里云官方账号下的资源，已开通快照，无需用户手动开通。 @@ -42,7 +42,7 @@ NebulaGraph Cloud 阿里云版支持如下套餐版本。 | 套餐版本 | 说明 | | - | - | -| 基础版 | 将所有 NebulaGraph 服务节点部署在 1 台 ECS 服务器上。 | +| 基础版 | 将所有{{nebula.name}}服务节点部署在 1 台 ECS 服务器上。 | | 标准版 | 将 Graph 服务和 Storage 服务分别部署在不同的 ECS 服务器上，每个服务都是单节点（1 台 ECS）。将 Explorer 等生态工具混合部署在 1 台 ECS 服务器上。 | | 高可用版 | 将 Graph 服务和 Storage 服务分别部署在不同的 ECS 服务器上，每个服务都包含 3 节点（3 台 ECS）。将 Explorer 等生态工具混合部署在 1 台 ECS 服务器上。 | @@ -54,7 +54,7 @@ NebulaGraph Cloud 阿里云版支持如下套餐版本。 2. 打开云市场的 [NebulaGraph 产品页](https://market.aliyun.com/products/56024006/cmgj00059955.html?#sku=yuncode5395500004)。 -3. 选择**套餐版本**和**购买时长**（即 NebulaGraph 服务的许可证有效期），并单击**立即购买**。 +3. 选择**套餐版本**和**购买时长**（即{{nebula.name}}服务的许可证有效期），并单击**立即购买**。 !!! caution @@ -121,7 +121,7 @@ NebulaGraph Cloud 阿里云版支持如下套餐版本。 2. 在 **NebulaGraph 集群版**卡片上，单击**免费试用**。 -3. 系统会为首次创建 NebulaGraph 服务实例的用户弹出申请对话框。在**申请权限**对话框中填写申请人信息。带有红色星号（*）的为必填项。 +3. 系统会为首次创建{{nebula.name}}服务实例的用户弹出申请对话框。在**申请权限**对话框中填写申请人信息。带有红色星号（*）的为必填项。 !!! note diff --git a/docs-2.0/reuse/source_manage-service.md b/docs-2.0/reuse/source_manage-service.md index 678a8a75d95..efafa2c08ec 100644 --- a/docs-2.0/reuse/source_manage-service.md +++ b/docs-2.0/reuse/source_manage-service.md @@ -45,7 +45,7 @@ $ sudo /usr/local/nebula/scripts/nebula.service {{ ent.ent_begin }} ## 使用 systemd 管理服务 -为方便使用，NebulaGraph 企业版支持用 systemd 管理服务，通过`systemctl`启动、停止、重启和查看服务。 +为方便使用，{{nebula.name}}企业版支持用 systemd 管理服务，通过`systemctl`启动、停止、重启和查看服务。 !!! note diff --git a/docs-2.0/reuse/source_ngql_for_quick_start.md b/docs-2.0/reuse/source_ngql_for_quick_start.md index c4cba6dc7a9..3bf4c953131 100644 --- a/docs-2.0/reuse/source_ngql_for_quick_start.md +++ b/docs-2.0/reuse/source_ngql_for_quick_start.md @@ -6,7 +6,7 @@ ![{{nebula.name}} and graph spaces](https://docs-cdn.nebula-graph.com.cn/docs-2.0/2.quick-start/nebula-graph-instance-and-graph-spaces.png) -为了在图空间中插入数据，需要为图数据库定义一个 Schema。NebulaGraph 的 Schema 是由如下几部分组成。 +为了在图空间中插入数据，需要为图数据库定义一个 Schema。{{nebula.name}}的 Schema 是由如下几部分组成。 | 组成部分 | 说明| | :--- | :--- | diff --git a/docs-2.0/synchronization-and-migration/replication-between-clusters.md b/docs-2.0/synchronization-and-migration/replication-between-clusters.md index 80a065f929a..71490a1f301 100644 --- a/docs-2.0/synchronization-and-migration/replication-between-clusters.md +++ b/docs-2.0/synchronization-and-migration/replication-between-clusters.md @@ -65,7 +65,7 @@ drainer：机器 IP 地址为`192.168.10.104`，只启动 drainer 服务。 ### 1.搭建主从集群、listener 和 drainer 服务 -1. 在所有机器上安装 NebulaGraph，修改配置文件： +1. 在所有机器上安装{{nebula.name}}，修改配置文件： - 主、从集群修改：`nebula-graphd.conf`、`nebula-metad.conf`、`nebula-storaged.conf`。 From 9bacb4916a8f4cdb18845c83c0a360b6ef156be3 Mon Sep 17 00:00:00 2001 From: randomJoe211 <69501902+randomJoe211@users.noreply.github.com> Date: Thu, 13 Apr 2023 12:11:32 +0800 Subject: [PATCH 132/137] update --- docs-2.0/1.introduction/0-1-graph-database.md | 2 +- .../3.nebula-graph-architecture/4.storage-service.md | 2 +- docs-2.0/15.contribution/how-to-contribute.md | 2 +- .../3.quick-start-on-premise/3.1add-storage-hosts.md | 4 ++-- docs-2.0/20.appendix/0.FAQ.md | 4 ++-- docs-2.0/20.appendix/history.md | 2 +- .../3.deploy-nebula-graph-with-docker-compose.md | 4 ++-- .../upgrade-nebula-ent-from-3.x-3.4.md | 2 +- .../upgrade-nebula-graph-to-latest.md | 2 +- docs-2.0/8.service-tuning/3.system-design.md | 2 +- docs-2.0/8.service-tuning/load-balance.md | 2 +- docs-2.0/README.md | 2 +- .../use-exchange/ex-ug-import-from-orc.md | 10 +++++----- .../use-exchange/ex-ug-import-from-parquet.md | 10 +++++----- .../use-exchange/ex-ug-import-from-pulsar.md | 2 +- .../use-exchange/ex-ug-import-from-sst.md | 12 ++++++------ .../about-explorer/ex-ug-what-is-explorer.md | 2 +- .../db-management/10.create-schema.md | 2 +- .../nebula-explorer/db-management/11.import-data.md | 2 +- .../nebula-explorer/deploy-connect/ex-ug-deploy.md | 2 +- docs-2.0/nebula-explorer/iframe.md | 4 ++-- .../nebula-explorer/workflow/1.prepare-resources.md | 2 +- .../workflow/workflow-api/workflow-api-overview.md | 4 ++-- docs-2.0/nebula-explorer/workflow/workflows.md | 2 +- docs-2.0/nebula-importer/use-importer.md | 12 ++++++------ .../1.introduction-to-nebula-operator.md | 6 +++--- .../nebula-operator/11.rolling-update-strategy.md | 2 +- docs-2.0/nebula-operator/2.deploy-nebula-operator.md | 2 +- .../4.connect-to-nebula-graph-service.md | 10 +++++----- .../8.1.custom-conf-parameter.md | 2 +- docs-2.0/nebula-operator/9.upgrade-nebula-cluster.md | 2 +- docs-2.0/reuse/source_create_instance_aliyun.md | 12 ++++++------ 32 files changed, 66 insertions(+), 66 deletions(-) diff --git a/docs-2.0/1.introduction/0-1-graph-database.md b/docs-2.0/1.introduction/0-1-graph-database.md index df51af008ba..589f7bbb60c 100644 --- a/docs-2.0/1.introduction/0-1-graph-database.md +++ b/docs-2.0/1.introduction/0-1-graph-database.md @@ -153,7 +153,7 @@ Cypher 启发了一系列后续的图查询语言，包括 [^GSQL]: https://docs.tigergraph.com/dev/gsql-ref -2019 年，NebulaGraph 以 openCypher 为基础发布其扩展的图语言 NebulaGraph Query Language, nGQL。 +2019 年，{{nebula.name}}以 openCypher 为基础发布其扩展的图语言 NebulaGraph Query Language, nGQL。 ![Image](https://docs-cdn.nebula-graph.com.cn/books/images/langhis.jpg "图语言的历史") diff --git a/docs-2.0/1.introduction/3.nebula-graph-architecture/4.storage-service.md b/docs-2.0/1.introduction/3.nebula-graph-architecture/4.storage-service.md index 3b5ce1ca53a..a9d13eb60b3 100644 --- a/docs-2.0/1.introduction/3.nebula-graph-architecture/4.storage-service.md +++ b/docs-2.0/1.introduction/3.nebula-graph-architecture/4.storage-service.md @@ -277,7 +277,7 @@ Storage 服务基于 Raft 协议实现的分布式架构，与 HDFS 的分布式 用户也可以通过视频全方位了解{{nebula.name}}的存储设计。 -- [nMeetup·上海 ｜ Storage in NebulaGraph 2.0](https://www.bilibili.com/video/BV16b4y1Q77k)（24 分 29 秒） +- [nMeetup·上海 ｜ Storage in {{nebula.name}} 2.0](https://www.bilibili.com/video/BV16b4y1Q77k)（24 分 29 秒） --> diff --git a/docs-2.0/15.contribution/how-to-contribute.md b/docs-2.0/15.contribution/how-to-contribute.md index 6d437eb3086..caaae179ddd 100644 --- a/docs-2.0/15.contribution/how-to-contribute.md +++ b/docs-2.0/15.contribution/how-to-contribute.md @@ -28,7 +28,7 @@ ### Step 1：通过 GitHub fork 仓库 -{{nebula.name}}项目有很多[仓库](https://github.com/vesoft-inc)，以 [NebulaGraph 仓库](https://github.com/vesoft-inc/nebula)为例： +{{nebula.name}}项目有很多[仓库](https://github.com/vesoft-inc)，以 [{{nebula.name}}仓库](https://github.com/vesoft-inc/nebula)为例： 1. 访问 [github.com/vesoft-inc/nebula](https://github.com/vesoft-inc/nebula)。 diff --git a/docs-2.0/2.quick-start/3.quick-start-on-premise/3.1add-storage-hosts.md b/docs-2.0/2.quick-start/3.quick-start-on-premise/3.1add-storage-hosts.md index 280da202435..f4029d65439 100644 --- a/docs-2.0/2.quick-start/3.quick-start-on-premise/3.1add-storage-hosts.md +++ b/docs-2.0/2.quick-start/3.quick-start-on-premise/3.1add-storage-hosts.md @@ -5,8 +5,8 @@ !!! compatibility "历史版本兼容性" diff --git a/docs-2.0/20.appendix/0.FAQ.md b/docs-2.0/20.appendix/0.FAQ.md index ade67f8ba77..9ec2ac77c16 100644 --- a/docs-2.0/20.appendix/0.FAQ.md +++ b/docs-2.0/20.appendix/0.FAQ.md @@ -30,7 +30,7 @@ ## 关于执行报错 @@ -50,7 +50,7 @@ diff --git a/docs-2.0/4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-ent-from-3.x-3.4.md b/docs-2.0/4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-ent-from-3.x-3.4.md index 5bf7214b0d0..5a7e4acfcba 100644 --- a/docs-2.0/4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-ent-from-3.x-3.4.md +++ b/docs-2.0/4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-ent-from-3.x-3.4.md @@ -5,7 +5,7 @@ ## 升级说明 - 此升级操作仅适用于升级{{nebula.name}} 3.x（x < 4）至 {{nebula.release}}。对于升级 3.4.0 及以上版本至 {{nebula.release}}，可以直接替换二进制文件进行升级。具体操作请参见[升级{{nebula.name}} 至 {{nebula.release}}](https://docs.nebula-graph.com.cn/{{nebula.release}}/4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-graph-to-latest/)。 - + !!! note 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 e1f7c7a692e..23c3768e970 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 @@ -40,7 +40,7 @@ ps：如果2.x（x<5）来做到3.4的升级，升级过程不会报错，因为 diff --git a/docs-2.0/8.service-tuning/3.system-design.md b/docs-2.0/8.service-tuning/3.system-design.md index fb4b6332517..fdbf104d9fd 100644 --- a/docs-2.0/8.service-tuning/3.system-design.md +++ b/docs-2.0/8.service-tuning/3.system-design.md @@ -8,7 +8,7 @@ !!! note - 本文仅介绍 NebulaGraph Analytics 的参数，NebulaGraph Algorithm 的参数请先参见对应的[算法文件](https://github.com/vesoft-inc/nebula-algorithm/tree/{{algorithm.branch}}/example/src/main/scala/com/vesoft/nebula/algorithm)。 + 本文仅介绍{{plato.name}}的参数，NebulaGraph Algorithm 的参数请先参见对应的[算法文件](https://github.com/vesoft-inc/nebula-algorithm/tree/{{algorithm.branch}}/example/src/main/scala/com/vesoft/nebula/algorithm)。 -- NebulaGraph Analytics +- {{plato.name}} - 传入参数 @@ -73,7 +73,7 @@ KCore 算法用于计算出没有小于 K 度的点组成的子图，通常使 |`degree`|`1`|| --> -- NebulaGraph Analytics +- {{plato.name}} - 传入参数 @@ -103,7 +103,7 @@ DegreeCentrality（度中心性） 算法用于查找图中的流行点。度中 !!! note - NebulaGraph Analytics 仅粗略估算度中心性。 + {{plato.name}}仅粗略估算度中心性。 参数说明如下。 @@ -118,7 +118,7 @@ DegreeCentrality（度中心性） 算法用于查找图中的流行点。度中 |``|``|| --> -- NebulaGraph Analytics +- {{plato.name}} - 传入参数 @@ -157,7 +157,7 @@ DegreeWithTime 算法是基于边的时间范围统计邻居，查找出图中 !!! note - 仅 NebulaGraph Analytics 支持该算法。 + 仅{{plato.name}}支持该算法。 参数说明如下。 @@ -206,7 +206,7 @@ BetweennessCentrality（介数中心性）算法是一种检测点对图中信 |`maxIter`|`5`|最大迭代次数。| --> -- NebulaGraph Analytics +- {{plato.name}} - 传入参数 @@ -241,7 +241,7 @@ ClosenessCentrality（紧密中心性）算法用于计算一个点到所有其 |``|``|| --> -- NebulaGraph Analytics +- {{plato.name}} - 传入参数 @@ -265,7 +265,7 @@ APSP（全图最短路径）算法用于寻找图中两点之间的所有最短 !!! note - 仅 NebulaGraph Analytics 支持该算法。 + 仅{{plato.name}}支持该算法。 参数说明如下。 @@ -291,7 +291,7 @@ SSSP（单源最短路径）算法用于计算给定的一个点（起始点） |`sourceid`|-|起始点的 VID。| --> -- NebulaGraph Analytics +- {{plato.name}} - 传入参数 @@ -323,7 +323,7 @@ BFS（广度优先遍历）算法是一种基础的图遍历算法，它给定 |``|``|| --> -- NebulaGraph Analytics +- {{plato.name}} - 传入参数 @@ -343,7 +343,7 @@ BFS（广度优先遍历）算法是一种基础的图遍历算法，它给定 ShortestPath（最短路径）算法用于寻找图中起点和终点任意两两之间的最短路径，适用于路径设计、网络规划等场景。 -- NebulaGraph Analytics +- {{plato.name}} - 传入参数 @@ -377,7 +377,7 @@ LPA（标签传播）算法是一种基于图的半监督学习方法，其基 |``|``|| --> -- NebulaGraph Analytics +- {{plato.name}} - 传入参数 @@ -412,7 +412,7 @@ HANP（Hop Attenuation & Node Preference）算法是LPA算法的优化算法， |`preference`|`1.0`|| --> -- NebulaGraph Analytics +- {{plato.name}} - 传入参数 @@ -438,7 +438,7 @@ ConnectedComponent（联通分量）算法用于计算出图中的一个子图 !!! note - NebulaGraph Analytics 仅支持弱联通分量。 + {{plato.name}}仅支持弱联通分量。 参数说明如下。 @@ -450,7 +450,7 @@ ConnectedComponent（联通分量）算法用于计算出图中的一个子图 |`maxIter`|`10`|最大迭代次数。| --> -- NebulaGraph Analytics +- {{plato.name}} - 传入参数 @@ -484,7 +484,7 @@ Louvain 算法是基于模块度的社区发现算法，该算法在效率和效 |`tol`|`0.5`|| --> -- NebulaGraph Analytics +- {{plato.name}} - 传入参数 @@ -510,9 +510,9 @@ InfoMap 算法使用双层编码方式将有向图进行社区分类。不同社 !!! note - 仅 NebulaGraph Analytics 支持该算法。 + 仅{{plato.name}}支持该算法。 -- NebulaGraph Analytics +- {{plato.name}} - 传入参数 @@ -551,7 +551,7 @@ TriangleCount（三角计数）算法用于统计图中三角形个数。三角 |``|``|| --> -- NebulaGraph Analytics +- {{plato.name}} - 传入参数 @@ -609,7 +609,7 @@ Node2Vec算法在 DeepWalk 的基础上提出了更加合理的图特征学习 |`modelPath`|`"hdfs://127.0.0.1:9000/model"`|| --> -- NebulaGraph Analytics +- {{plato.name}} - 传入参数 @@ -632,9 +632,9 @@ Tree_stat 算法用于统计图空间中指定根节点的子图的宽度或深 !!! note - 仅 NebulaGraph Analytics 支持该算法。 + 仅{{plato.name}}支持该算法。 -- NebulaGraph Analytics +- {{plato.name}} - 传入参数 @@ -655,9 +655,9 @@ HyperANF 算法用于评估图中任意两点的平均距离。 !!! note - 仅 NebulaGraph Analytics 支持该算法。 + 仅{{plato.name}}支持该算法。 -- NebulaGraph Analytics +- {{plato.name}} - 传入参数 @@ -690,7 +690,7 @@ ClusteringCoefficient（聚集系数）算法用于计算图中节点的聚集 |``|``|| --> -- NebulaGraph Analytics +- {{plato.name}} - 传入参数 @@ -733,7 +733,7 @@ Jaccard（杰卡德相似度）算法用于计算两个点（或集合）的相 |``|``|| --> -- NebulaGraph Analytics +- {{plato.name}} - 传入参数 diff --git a/docs-2.0/graph-computing/analytics-ent-license.md b/docs-2.0/graph-computing/analytics-ent-license.md index 3644b7958aa..b8dd8e66df4 100644 --- a/docs-2.0/graph-computing/analytics-ent-license.md +++ b/docs-2.0/graph-computing/analytics-ent-license.md @@ -1,6 +1,6 @@ -# NebulaGraph Analytics License +# {{plato.name}} License -License 是为用户提供的软件授权证书。用户在部署 NebulaGraph Analytics 时，需要设置 License 才能正常启动 NebulaGraph Analytics。本文介绍 NebulaGraph Analytics 的 License 相关信息。 +License 是为用户提供的软件授权证书。用户在部署{{plato.name}}时，需要设置 License 才能正常启动 NebulaGraph Analytics。本文介绍{{plato.name}}的 License 相关信息。 ## 注意事项 @@ -20,15 +20,15 @@ License 是为用户提供的软件授权证书。用户在部署 NebulaGraph An ## 获取方式 -[联系我们](https://www.nebula-graph.com.cn/contact)申请 NebulaGraph Analytics License。 +[联系我们](https://www.nebula-graph.com.cn/contact)申请{{plato.name}}License。 !!! note - 填写 [NebulaGraph Analytics 试用申请](https://wj.qq.com/s2/10158890/69a8)可获取 30 天免费试用的 License。 + 填写 [{{plato.name}}试用申请](https://wj.qq.com/s2/10158890/69a8)可获取 30 天免费试用的 License。 -## NebulaGraph Analytics License 说明 +## {{plato.name}} License 说明 -NebulaGraph Analytics License 是一个名为`nebula.license`的文件，内容示例如下： +{{plato.name}} License 是一个名为`nebula.license`的文件，内容示例如下： ```bash ----------License Content Start---------- @@ -72,15 +72,15 @@ License 文件包含生效时间、过期时间等信息。说明如下。 ## 使用方式 -关于如何使用 NebulaGraph Analytics License，参见[NebulaGraph Analytics](nebula-analytics.md)。 +关于如何使用{{plato.name}}License，参见[{{plato.name}}](nebula-analytics.md)。 ## 续期操作 -按照以下操作续期 NebulaGraph Analytics License。 +按照以下操作续期{{plato.name}}License。 -1. [联系我们](https://www.nebula-graph.com.cn/contact)申请新的 NebulaGraph Analytics License 文件`nebula.license`。 -2. 在 NebulaGraph Analytics 的安装目录下（例如，`/usr/local/nebula-analytics/scripts/`），使用新的 License 文件替换旧的 License 文件。 +1. [联系我们](https://www.nebula-graph.com.cn/contact)申请新的{{plato.name}}License 文件`nebula.license`。 +2. 在{{plato.name}}的安装目录下（例如，`/usr/local/nebula-analytics/scripts/`），使用新的 License 文件替换旧的 License 文件。 !!! note - NebulaGraph Analytics License 过期后，用户无法正常使用 Analytics。为了保证业务正常运行，请及时更新 License。 + {{plato.name}} License 过期后，用户无法正常使用 Analytics。为了保证业务正常运行，请及时更新 License。 diff --git a/docs-2.0/graph-computing/nebula-analytics.md b/docs-2.0/graph-computing/nebula-analytics.md index 8fe958c8551..1fec06e71d8 100644 --- a/docs-2.0/graph-computing/nebula-analytics.md +++ b/docs-2.0/graph-computing/nebula-analytics.md @@ -1,6 +1,6 @@ -# NebulaGraph Analytics +# {{plato.name}} -NebulaGraph Analytics 是一款高性能图计算框架工具，支持对{{nebula.name}}数据库中的数据执行图分析。 +{{plato.name}}是一款高性能图计算框架工具，支持对{{nebula.name}}数据库中的数据执行图分析。 ## 前提条件 @@ -15,7 +15,7 @@ NebulaGraph Analytics 是一款高性能图计算框架工具，支持对{{nebul ## 适用场景 -支持将数据源为{{nebula.name}}集群、HDFS 上的 CSV 文件或本地 CSV 文件中的数据导入 NebulaGraph Analytics，并将图计算结果输出至{{nebula.name}}集群、HDFS 上的 CSV 文件或本地 CSV 文件。 +支持将数据源为{{nebula.name}}集群、HDFS 上的 CSV 文件或本地 CSV 文件中的数据导入 {{plato.name}}，并将图计算结果输出至{{nebula.name}}集群、HDFS 上的 CSV 文件或本地 CSV 文件。 ## 使用限制 @@ -23,9 +23,9 @@ NebulaGraph Analytics 是一款高性能图计算框架工具，支持对{{nebul ## 版本兼容性 -NebulaGraph Analytics 版本和{{nebula.name}}内核的版本对应关系如下。 +{{plato.name}}版本和{{nebula.name}}内核的版本对应关系如下。 -|{{nebula.name}}版本|NebulaGraph Analytics 版本| +|{{nebula.name}}版本|{{plato.name}}版本| |:---|:---| |3.4.0 ~ 3.4.1| 3.4.0 | |3.3.0 | 3.3.0 | @@ -35,7 +35,7 @@ NebulaGraph Analytics 版本和{{nebula.name}}内核的版本对应关系如下 ## 支持算法 -NebulaGraph Analytics 支持的图计算算法如下。 +{{plato.name}}支持的图计算算法如下。 | 算法名 |说明 |分类 | |:----------------------|:----------------|:-----------| @@ -61,9 +61,9 @@ NebulaGraph Analytics 支持的图计算算法如下。 | Clustering Coefficient| 聚集系数 | 聚类 | | Jaccard | 杰卡德相似度 | 相似度 | -## 安装 NebulaGraph Analytics +## 安装 {{plato.name}} -1. 安装 NebulaGraph Analytics。在多个机器安装由多个 NebulaGraph Analytics 服务构成的集群时，需要安装路径相同，并设置节点间 SSH 免密登录。 +1. 安装 {{plato.name}}。在多个机器安装由多个{{plato.name}}服务构成的集群时，需要安装路径相同，并设置节点间 SSH 免密登录。 ``` $ sudo rpm -ivh --prefix @@ -88,12 +88,12 @@ NebulaGraph Analytics 支持的图计算算法如下。 export JAVA_HOME= ``` -3. 拷贝 License 至所有机器的 NebulaGraph Analytics 安装路径的`scripts`目录内。 +3. 拷贝 License 至所有机器的{{plato.name}}安装路径的`scripts`目录内。 diff --git a/docs-2.0/20.appendix/0.FAQ.md b/docs-2.0/20.appendix/0.FAQ.md index 9ec2ac77c16..b7612275e05 100644 --- a/docs-2.0/20.appendix/0.FAQ.md +++ b/docs-2.0/20.appendix/0.FAQ.md @@ -354,7 +354,7 @@ $ ./nebula-graphd --version {{ ent.ent_begin }} ### 如何扩缩容（仅限企业版） -- 使用 Dashboard（企业版），在可视化页面对 graphd 和 storaged 进行快速扩缩容，详情参见[集群操作-扩缩容](../nebula-dashboard-ent/4.cluster-operator/operator/scale.md)。 +- 使用悦数运维监控，在可视化页面对 graphd 和 storaged 进行快速扩缩容，详情参见[集群操作-扩缩容](../nebula-dashboard-ent/4.cluster-operator/operator/scale.md)。 - 使用 NebulaGraph Operator 扩缩容集群，详情参见[使用 Kubectl 部署{{nebula.name}}集群](../nebula-operator/3.deploy-nebula-graph-cluster/3.1create-cluster-with-kubectl.md)和[使用 Helm 部署{{nebula.name}}集群](../nebula-operator/3.deploy-nebula-graph-cluster/3.2create-cluster-with-helm.md)。 {{nebula.name}} {{ nebula.release }} 未提供运维命令以实现自动扩缩容，参考以下步骤： @@ -539,33 +539,33 @@ dmp 文件是错误报告文件，详细记录了进程退出的信息，可以 | 序号 | 所属产品/服务 | 类型 | 默认端口 | 说明 | | :--- | :--------------------- | :--- | :---------------------------- | :----------------------------------------------------------- | -| 1 | NebulaGraph | TCP | 9669 | Graph 服务的 RPC 守护进程监听端口（通常用于客户端连接Graph服务）。 | -| 2 | NebulaGraph | TCP | 19669 | Graph 服务的 HTTP 端口。 | -| 3 | NebulaGraph | TCP | 19670 | Graph 服务的 HTTP/2 端口。（3.x 后已弃用该端口） | -| 4 | NebulaGraph | TCP | 9559 | Meta 服务的 RPC 守护进程监听端口。（通常由 Graph 服务和 Storage 服务发起请求，用于获取和更新图数据库的元数据信息。 | -| 5 | NebulaGraph | TCP | 9560 | Meta 服务之间的 Raft 通信端口。 | -| 6 | NebulaGraph | TCP | 19559 | Meta 服务的 HTTP 端口。 | -| 7 | NebulaGraph | TCP | 19560 | Meta 服务的 HTTP/2 端口。（3.x 后已弃用该端口） | -| 8 | NebulaGraph | TCP | 9777 | Storage 服务中，Drainer 服务占用端口（仅在企业版集群中暴露）。 | -| 9 | NebulaGraph | TCP | 9778 | Storage 服务中，Admin 服务占用端口。 | -| 10 | NebulaGraph | TCP | 9779 | Storage 服务的 RPC 守护进程监听端口。（通常由 Graph 服务发起请求，用于执行数据存储相关的操作，例如读取、写入或删除数据。） | -| 11 | NebulaGraph | TCP | 9780 | Storage 服务之间的 Raft 通信端口。 | -| 12 | NebulaGraph | TCP | 19779 | Storage 服务的 HTTP 端口。 | -| 13 | NebulaGraph | TCP | 19780 | Storage 服务的 HTTP/2 端口。（3.x 后已弃用该端口） | -| 14 | NebulaGraph | TCP | 8888 | 备份和恢复功能的 Agent 服务端口。Agent 是集群中每台机器的一个守护进程，用于启停{{nebula.name}}服务和上传、下载备份文件。 | -| 15 | NebulaGraph | TCP | 9789、9790、9788 | 全文索引中 Raft Listener 的端口，从 Storage 服务读取数据，然后将它们写入 Elasticsearch 集群。
也是集群间数据同步中 Storage Listener 的端口。用于同步主集群的 Storage 数据。端口 9790、9788 由端口 9789 加一减一后自动生成。 | -| 16 | NebulaGraph | TCP | 9200 | {{nebula.name}}使用该端口与 Elasticsearch 进行 HTTP 通信，以执行全文搜索查询和管理全文索引。 | -| 17 | NebulaGraph | TCP | 9569、9570、9568| 集群间数据同步功能中 Meta Listener 的端口，用于同步主集群的 Meta 数据。端口 9570、9568 由端口 9569 加一减一后自动生成。 | -| 18 | NebulaGraph | TCP | 9889、9890、9888 | 集群间数据同步功能中 Drainer 服务端口。用于同步 Storage、Meta 数据给从集群。端口 9890、9888 由端口 9889 加一减一后自动生成。| +| 1 | {{nebula.name}} | TCP | 9669 | Graph 服务的 RPC 守护进程监听端口（通常用于客户端连接Graph服务）。 | +| 2 | {{nebula.name}} | TCP | 19669 | Graph 服务的 HTTP 端口。 | +| 3 | {{nebula.name}} | TCP | 19670 | Graph 服务的 HTTP/2 端口。（3.x 后已弃用该端口） | +| 4 | {{nebula.name}} | TCP | 9559 | Meta 服务的 RPC 守护进程监听端口。（通常由 Graph 服务和 Storage 服务发起请求，用于获取和更新图数据库的元数据信息。 | +| 5 | {{nebula.name}} | TCP | 9560 | Meta 服务之间的 Raft 通信端口。 | +| 6 | {{nebula.name}} | TCP | 19559 | Meta 服务的 HTTP 端口。 | +| 7 | {{nebula.name}} | TCP | 19560 | Meta 服务的 HTTP/2 端口。（3.x 后已弃用该端口） | +| 8 | {{nebula.name}} | TCP | 9777 | Storage 服务中，Drainer 服务占用端口（仅在企业版集群中暴露）。 | +| 9 | {{nebula.name}} | TCP | 9778 | Storage 服务中，Admin 服务占用端口。 | +| 10 | {{nebula.name}} | TCP | 9779 | Storage 服务的 RPC 守护进程监听端口。（通常由 Graph 服务发起请求，用于执行数据存储相关的操作，例如读取、写入或删除数据。） | +| 11 | {{nebula.name}} | TCP | 9780 | Storage 服务之间的 Raft 通信端口。 | +| 12 | {{nebula.name}} | TCP | 19779 | Storage 服务的 HTTP 端口。 | +| 13 | {{nebula.name}} | TCP | 19780 | Storage 服务的 HTTP/2 端口。（3.x 后已弃用该端口） | +| 14 | {{nebula.name}} | TCP | 8888 | 备份和恢复功能的 Agent 服务端口。Agent 是集群中每台机器的一个守护进程，用于启停{{nebula.name}}服务和上传、下载备份文件。 | +| 15 | {{nebula.name}} | TCP | 9789、9790、9788 | 全文索引中 Raft Listener 的端口，从 Storage 服务读取数据，然后将它们写入 Elasticsearch 集群。
也是集群间数据同步中 Storage Listener 的端口。用于同步主集群的 Storage 数据。端口 9790、9788 由端口 9789 加一减一后自动生成。 | +| 16 | {{nebula.name}} | TCP | 9200 | {{nebula.name}}使用该端口与 Elasticsearch 进行 HTTP 通信，以执行全文搜索查询和管理全文索引。 | +| 17 | {{nebula.name}} | TCP | 9569、9570、9568| 集群间数据同步功能中 Meta Listener 的端口，用于同步主集群的 Meta 数据。端口 9570、9568 由端口 9569 加一减一后自动生成。 | +| 18 | {{nebula.name}} | TCP | 9889、9890、9888 | 集群间数据同步功能中 Drainer 服务端口。用于同步 Storage、Meta 数据给从集群。端口 9890、9888 由端口 9889 加一减一后自动生成。| | 19 | NebulaGraph Studio | TCP | 7001 | Studio 提供 Web 服务占用端口。 | -| 20 | NebulaGraph Dashboard | TCP | 8090 | Nebula HTTP Gateway 依赖服务端口。为集群服务提供 HTTP 接口，执行 nGQL 语句与{{nebula.name}}数据库进行交互。 | -| 21 | NebulaGraph Dashboard | TCP | 9200 | Nebula Stats Exporter 依赖服务端口。收集集群的性能指标，包括服务 IP 地址、版本和监控指标（例如查询数量、查询延迟、心跳延迟 等）。 | -| 22 | NebulaGraph Dashboard | TCP | 9100 | Node Exporter 依赖服务端口。收集集群中机器的资源信息，包括 CPU、内存、负载、磁盘和流量。 | -| 23 | NebulaGraph Dashboard | TCP | 9090 | Prometheus 服务的端口。存储监控数据的时间序列数据库。 | -| 24 | NebulaGraph Dashboard | TCP | 7003 | Dashboard 社区版 提供 Web 服务占用端口。 | -| 25 | NebulaGraph Dashboard | TCP | 7005 | Dashboard 企业版 提供 Web 服务占用端口。 | -| 26 | NebulaGraph Dashboard | TCP | 9093 | Alertmanager 服务的端口。接收 Prometheus 告警，发送告警通知给 Dashboard。 | -| 27 | NebulaGraph Explorer | TCP | 7002 | Explorer 提供的 Web 服务占用端口。 | +| 20 | {{dashboard_ent.name}} | TCP | 8090 | Nebula HTTP Gateway 依赖服务端口。为集群服务提供 HTTP 接口，执行 nGQL 语句与{{nebula.name}}数据库进行交互。 | +| 21 | {{dashboard_ent.name}} | TCP | 9200 | Nebula Stats Exporter 依赖服务端口。收集集群的性能指标，包括服务 IP 地址、版本和监控指标（例如查询数量、查询延迟、心跳延迟 等）。 | +| 22 | {{dashboard_ent.name}} | TCP | 9100 | Node Exporter 依赖服务端口。收集集群中机器的资源信息，包括 CPU、内存、负载、磁盘和流量。 | +| 23 | {{dashboard_ent.name}} | TCP | 9090 | Prometheus 服务的端口。存储监控数据的时间序列数据库。 | +| 24 | NebulaGraph Dashboard | TCP | 7003 | Dashboard 社区版 提供 Web 服务占用端口。 | +| 25 | {{dashboard_ent.name}} | TCP | 7005 | {{dashboard_ent.name}}提供 Web 服务占用端口。 | +| 26 | {{dashboard_ent.name}} | TCP | 9093 | Alertmanager 服务的端口。接收 Prometheus 告警，发送告警通知给{{dashboard_ent.name}}。 | +| 27 | {{explorer.name}} | TCP | 7002 | {{explorer.name}}提供的 Web 服务占用端口。 | ### 如何测试端口是否已开放？ 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 5c018e216b5..2d1a674e964 100644 --- a/docs-2.0/20.appendix/6.eco-tool-version.md +++ b/docs-2.0/20.appendix/6.eco-tool-version.md @@ -62,11 +62,11 @@ NebulaGraph Dashboard（简称 Dashboard）是一款用于监控{{nebula.name}} {{ ent.ent_begin }} -## NebulaGraph Dashboard（企业版） +## {{dashboard_ent.name}} -NebulaGraph Dashboard（简称 Dashboard）是一款用于监控和管理{{nebula.name}}多集群中机器和服务状态的可视化工具，支持在可视化界面进行集群创建、集群导入、数据平衡、扩容缩容等操作。详情参见[什么是 NebulaGraph Dashboard](../nebula-dashboard-ent/1.what-is-dashboard-ent.md)。 +{{dashboard_ent.name}}是一款用于监控和管理{{nebula.name}}多集群中机器和服务状态的可视化工具，支持在可视化界面进行集群创建、集群导入、数据平衡、扩容缩容等操作。详情参见[什么是{{dashboard_ent.name}}](../nebula-dashboard-ent/1.what-is-dashboard-ent.md)。 -|{{nebula.name}}版本|Dashboard 企业版本| +|{{nebula.name}}版本|{{dashboard_ent.name}}版本| |:---|:---| | {{ nebula.tag }} | {{dashboard_ent.tag}}| @@ -74,11 +74,11 @@ NebulaGraph Dashboard（简称 Dashboard）是一款用于监控和管理{{nebul {{ ent.ent_begin }} -## NebulaGraph Explorer +## {{explorer.name}} -NebulaGraph Explorer（简称 Explorer）是一款可以通过 Web 访问的图探索可视化工具，搭配{{nebula.name}}内核使用，用于与图数据进行可视化交互。即使没有图数据操作经验，用户也可以快速成为图专家。详情参见[什么是 NebulaGraph Explorer](../nebula-explorer/about-explorer/ex-ug-what-is-explorer.md)。 +{{explorer.name}}是一款可以通过 Web 访问的图探索可视化工具，搭配{{nebula.name}}内核使用，用于与图数据进行可视化交互。即使没有图数据操作经验，用户也可以快速成为图专家。详情参见[什么是{{explorer.name}}](../nebula-explorer/about-explorer/ex-ug-what-is-explorer.md)。 -|{{nebula.name}}版本|Explorer 企业版本| +|{{nebula.name}}版本|{{explorer.name}}版本| |:---|:---| | {{ nebula.tag }} | {{explorer.tag}}| @@ -178,11 +178,12 @@ Docker Compose 可以快速部署{{nebula.name}}集群。如何使用请参见 [ {{ comm.comm_end }} {{ent.ent_begin}} -## Backup & Restore (企业版) -[Backup&Restore](../backup-and-restore/nebula-br-ent/1.br-ent-overview.md) 企业版是一款命令行界面（CLI）工具。通过 NebulaGraph BR（企业版），用户可以备份{{nebula.name}}企业版数据，并基于备份目录进行数据恢复。 +## {{br_ent.name}} -|{{nebula.name}}版本|BR 版本| +[{{br_ent.name}}](../backup-and-restore/nebula-br-ent/1.br-ent-overview.md)是一款命令行界面（CLI）工具。通过{{br_ent.name}}，用户可以备份{{nebula.name}}企业版数据，并基于备份目录进行数据恢复。 + +|{{nebula.name}}版本|{{br_ent.name}}版本| |:---|:---| | {{ nebula.tag }} | {{br_ent.tag}}| diff --git a/docs-2.0/20.appendix/8.about-license.md b/docs-2.0/20.appendix/8.about-license.md index cb2000fd0a7..22c15e98c40 100644 --- a/docs-2.0/20.appendix/8.about-license.md +++ b/docs-2.0/20.appendix/8.about-license.md @@ -11,23 +11,23 @@ License 是一种软件许可证，用以规定和限制用户使用软件的权 {{ ent.ent_end }} -## NebulaGraph Dashboard 企业版 +## {{dashboard_ent.name}} -NebulaGraph Dashboard 企业版是一款开箱即用的多集群可视化运维工具，支持可视化集群操作和多维度监控集群。 +{{dashboard_ent.name}}是一款开箱即用的多集群可视化运维工具，支持可视化集群操作和多维度监控集群。 -部署 NebulaGraph Dashboard 企业版时，用户需设置 NebulaGraph Dashboard 企业版 License。更多信息，参见 [NebulaGraph Dashboard 企业版 License](../nebula-dashboard-ent/11.dashboard-ent-license.md)。 +部署{{dashboard_ent.name}}时，用户需设置{{dashboard_ent.name}} License。更多信息，参见 [{{dashboard_ent.name}} License](../nebula-dashboard-ent/11.dashboard-ent-license.md)。 -## NebulaGraph Explorer 企业版 +## {{explorer.name}} -NebulaGraph Explorer 企业版是一款通过 Web 访问的图探索可视化工具，搭配{{nebula.name}}内核使用，无需掌握图查询语言即可对大规模业务数据进行查找分析，分析结果直接可视化展示，可轻松快速挖掘数据的业务价值。 +{{explorer.name}}是一款通过 Web 访问的图探索可视化工具，搭配{{nebula.name}}内核使用，无需掌握图查询语言即可对大规模业务数据进行查找分析，分析结果直接可视化展示，可轻松快速挖掘数据的业务价值。 -部署 NebulaGraph Explorer 企业版时，用户需设置 NebulaGraph Explorer 企业版 License。更多信息，参见 [NebulaGraph Explorer 企业版 License](../nebula-explorer/deploy-connect/3.explorer-license.md)。 +部署{{explorer.name}}时，用户需设置{{explorer.name}} License。更多信息，参见 [{{explorer.name}} License](../nebula-explorer/deploy-connect/3.explorer-license.md)。 ## License 常见问题 -### Dashboard/Explorer/{{nebula.name}}的 License 一样吗？ +### {{dashboard_ent.name}}/{{explorer.name}}/{{nebula.name}}的 License 一样吗？ -不一样，Dashboard、Explorer、{{nebula.name}}的 License 相互独立，不可互用。 +不一样，{{dashboard_ent.name}、{{explorer.name}}、{{nebula.name}}的 License 相互独立，不可互用。 ### License 过期前，是否有信息提示？License 过期后如何续期？ @@ -39,7 +39,7 @@ License 过期前，系统会发送过期提醒信息。 - 过期前 30 天和过期当天，在启动服务时有过期提醒。 - - 到期后有 14 天缓冲期。在缓冲期期间，有过期提示，用户能继续使用{{nebula.name}}/Dashboard/Explorer。缓冲期结束后，服务会停机并无法启动。 + - 到期后有 14 天缓冲期。在缓冲期期间，有过期提示，用户能继续使用{{nebula.name}}/{{dashboard_ent.name}/{{explorer.name}}。缓冲期结束后，服务会停机并无法启动。 - 试用版的 License 过期提醒： diff --git a/docs-2.0/20.appendix/learning-path.md b/docs-2.0/20.appendix/learning-path.md index fd5530099e5..d8e2138f63a 100644 --- a/docs-2.0/20.appendix/learning-path.md +++ b/docs-2.0/20.appendix/learning-path.md @@ -180,8 +180,8 @@ | 可视化工具 | 文档 | 视频 | | -------------- | ------------------------------------------------------------ | ------------------------------------------------------------ | | 数据可视化 | [Nebula Studio](https://docs.nebula-graph.com.cn/{{nebula.release}}/nebula-studio/about-studio/st-ug-what-is-graph-studio/) | [Nebula Studio 图探索功能](https://www.bilibili.com/video/BV1QN411Z7Vh)和[Nebula Studio 可视化建模](https://www.bilibili.com/video/BV19A411L77h?spm_id_from=333.999.0.0) | - | 数据监控和运维 | [Nebula Dashboard 企业版](https://docs.nebula-graph.com.cn/{{nebula.release}}/nebula-dashboard-ent/1.what-is-dashboard-ent/)和 [Nebula Dashboard 社区版](https://docs.nebula-graph.com.cn/{{nebula.release}}/nebula-dashboard/1.what-is-dashboard/) | [可视化监控 Nebula Dashboard](https://www.bilibili.com/video/BV1qQ4y1k7gb?) | - | 数据分析 | [Nebula Explorer 企业版](https://docs.nebula-graph.com.cn/{{nebula.release}}/nebula-explorer/about-explorer/ex-ug-what-is-explorer/) | [可视化图探索 Nebula Explorer](https://www.bilibili.com/video/BV1fP4y1h7Fx?) | + | 数据监控和运维 | [{{dashboard_ent.name}](https://docs.nebula-graph.com.cn/{{nebula.release}}/nebula-dashboard-ent/1.what-is-dashboard-ent/)和 [Nebula Dashboard 社区版](https://docs.nebula-graph.com.cn/{{nebula.release}}/nebula-dashboard/1.what-is-dashboard/) | [{{dashboard_ent.name}](https://www.bilibili.com/video/BV1qQ4y1k7gb?) | + | 数据分析 | [{{explorer.name}}](https://docs.nebula-graph.com.cn/{{nebula.release}}/nebula-explorer/about-explorer/ex-ug-what-is-explorer/) | [{{explorer.name}}](https://www.bilibili.com/video/BV1fP4y1h7Fx?) | - 数据导入与导出 @@ -262,7 +262,7 @@ | 作业内容 | 参考 | | ------------------------------------------------------- | ------------------------------------------------------------ | | 编译内核 | [使用源码安装{{nebula.name}}](https://docs.nebula-graph.com.cn/{{nebula.release}}/4.deployment-and-installation/2.compile-and-install-nebula-graph/1.install-nebula-graph-by-compiling-the-source-code/) | - | 部署可视化工具 Studio、Dashboard、Explorer | [部署 Studio](https://docs.nebula-graph.com.cn/{{nebula.release}}/nebula-studio/deploy-connect/st-ug-deploy/)、[部署 Dashboard](https://docs.nebula-graph.com.cn/{{nebula.release}}/nebula-dashboard/2.deploy-dashboard/)、[部署 Explorer](https://docs.nebula-graph.com.cn/{{nebula.release}}/nebula-explorer/deploy-connect/ex-ug-deploy/) | + | 部署可视化工具 Studio、Dashboard、Explorer | [部署 Studio](https://docs.nebula-graph.com.cn/{{nebula.release}}/nebula-studio/deploy-connect/st-ug-deploy/)、[部署 Dashboard](https://docs.nebula-graph.com.cn/{{nebula.release}}/nebula-dashboard/2.deploy-dashboard/)、[部署{{explorer.name}}](https://docs.nebula-graph.com.cn/{{nebula.release}}/nebula-explorer/deploy-connect/ex-ug-deploy/) | | 使用 K6 压测{{nebula.name}} | [K6 在{{nebula.name}}上的压测实践](https://nebula-graph.com.cn/posts/practice-k6-at-nebula-graph/) | | 导入 LDBC 数据 | [LDBC 数据导入及 nGQL 实践](https://mp.weixin.qq.com/s/tbLGuuX6vNzLIw6o8ZGKpw) | | 查询 LDBC 数据（点查、K度邻居查询、路径查询、子图查询） | [LDBC](chrome-extension://gfbliohnnapiefjpjlpjnehglfpaknnc/pages/pdf_viewer.html?r=http://ldbcouncil.org/ldbc_snb_docs/ldbc-snb-specification.pdf) 和 [interactive-short-1.cypher](https://github.com/ldbc/ldbc_snb_interactive/blob/main/cypher/queries/interactive-short-1.cypher) | 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 6152cdb3ccb..c4365b3c537 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,13 +1,13 @@ -# NebulaGraph Dashboard 企业版更新说明 +# {{dashboard_ent.name}更新说明 -## 企业版 v3.4.2 +## v3.4.2 - 优化 - 支持在备份恢复页面查看数据备份恢复的进度。 - 内置{{nebula.name}} v3.4.1 安装包。 -## 企业版 v3.4.1 +## v3.4.1 - 缺陷修复 @@ -15,14 +15,14 @@ - 修复 goconfig 文件夹权限问题导致无法查看集群导入信息的问题。 - 修复当许可证过期时间小于`30`天且`gracePeriod`大于`0`时页面提示错误的问题。 -## 企业版 v3.4.0 +## v3.4.0 - 功能 - 支持查看{{nebula.name}}集群[运行日志](../../nebula-dashboard-ent/4.cluster-operator/cluster-information/runtime-log.md)。 - 支持查看{{nebula.name}}集群[审计日志](../../nebula-dashboard-ent/4.cluster-operator/cluster-information/audit-log.md)。 - 支持[作业管理](../../nebula-dashboard-ent/4.cluster-operator/cluster-information/job-management.md)。 - 备份恢复支持[增量备份](../../nebula-dashboard-ent/4.cluster-operator/operator/backup-and-restore.md)。 - - 内置 [dashboard.service](../../nebula-dashboard-ent/2.deploy-connect-dashboard-ent.md) 脚本，支持一键管理 Dashboard 服务和查看 Dashboard 版本。 + - 内置 [dashboard.service](../../nebula-dashboard-ent/2.deploy-connect-dashboard-ent.md) 脚本，支持一键管理{{dashboard_ent.name}服务和查看{{dashboard_ent.name}版本。 - 新增产品反馈页面。 - 优化 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 1531186ab24..f02973e43f5 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,4 +1,4 @@ -# NebulaGraph Explorer 版本更新说明 +# {{explorer.name}}版本更新说明 ## v3.4.0 diff --git a/docs-2.0/4.deployment-and-installation/2.compile-and-install-nebula-graph/6.deploy-nebula-graph-with-peripherals.md b/docs-2.0/4.deployment-and-installation/2.compile-and-install-nebula-graph/6.deploy-nebula-graph-with-peripherals.md index 8a2750890b5..d686d9db9a6 100644 --- a/docs-2.0/4.deployment-and-installation/2.compile-and-install-nebula-graph/6.deploy-nebula-graph-with-peripherals.md +++ b/docs-2.0/4.deployment-and-installation/2.compile-and-install-nebula-graph/6.deploy-nebula-graph-with-peripherals.md @@ -3,7 +3,7 @@ 用户可以使用以下生态工具安装{{nebula.name}}： {{ ent.ent_begin }} -- 企业版 NebulaGraph Dashboard +- {{dashboard_ent.name} {{ ent.ent_end }} @@ -12,7 +12,7 @@ ## 安装详情 {{ ent.ent_begin }} -- 使用**企业版 NebulaGraph Dashboard** 安装{{nebula.name}}的详情，参见[创建集群](../../nebula-dashboard-ent/3.create-import-dashboard/1.create-cluster.md)。 +- 使用**{{dashboard_ent.name}** 安装{{nebula.name}}的详情，参见[创建集群](../../nebula-dashboard-ent/3.create-import-dashboard/1.create-cluster.md)。 {{ ent.ent_end }} diff --git a/docs-2.0/6.monitor-and-metrics/3.bbox/3.1.bbox.md b/docs-2.0/6.monitor-and-metrics/3.bbox/3.1.bbox.md index d78fe67d0e7..26317a11dd6 100644 --- a/docs-2.0/6.monitor-and-metrics/3.bbox/3.1.bbox.md +++ b/docs-2.0/6.monitor-and-metrics/3.bbox/3.1.bbox.md @@ -1,6 +1,6 @@ -# 黑匣子介绍 +# {{bbox.name}}介绍 -{{nebula.name}}黑匣子功能定期收集和归档操作系统和服务指标的数据。当服务出现故障时，可以帮助用户在无直连网络的情况下快速定位问题和分析原因。 +{{bbox.name}}（简称黑匣子）能定期收集和归档操作系统和服务指标的数据。当服务出现故障时，可以帮助用户在无直连网络的情况下快速定位问题和分析原因。 ## 功能说明 diff --git a/docs-2.0/backup-and-restore/nebula-br-ent/1.br-ent-overview.md b/docs-2.0/backup-and-restore/nebula-br-ent/1.br-ent-overview.md index aad32a66ac6..3ddf2ab770b 100644 --- a/docs-2.0/backup-and-restore/nebula-br-ent/1.br-ent-overview.md +++ b/docs-2.0/backup-and-restore/nebula-br-ent/1.br-ent-overview.md @@ -1,6 +1,6 @@ -# 什么是 Backup&Restore（企业版） +# 什么是{{br_ent.name}} -Backup&Restore（简称 BR）企业版是一款命令行界面（CLI）工具。通过 NebulaGraph BR（企业版），用户可以备份{{nebula.name}}数据，并基于备份目录进行数据恢复。 +{{br_ent.name}}企业版是一款命令行界面（CLI）工具。通过{{br_ent.name}}，用户可以备份{{nebula.name}}数据，并基于备份目录进行数据恢复。 !!! enterpriseonly @@ -26,13 +26,13 @@ Backup&Restore（简称 BR）企业版是一款命令行界面（CLI）工具。 - 数据备份过程中，指定图空间中的 DDL 和 DML 语句将会阻塞，我们建议在业务低峰期进行操作，例如凌晨 2 点至 5 点。 - 数据恢复需要原集群和目标集群的 Storage 主机数量及 IP 一致。 - 不支持备份指定图空间数据。 -- 不支持在容器部署的{{nebula.name}}集群中使用 BR 企业版。 +- 不支持在容器部署的{{nebula.name}}集群中使用{{br_ent.name}}。 ## 使用流程 可以按照以下步骤使用备份和恢复功能： -1. [安装 BR（企业版）工具](2.install-tools.md) +1. [安装](2.install-tools.md) 2. [备份数据](3.backup-data.md) 3. [恢复数据](4.restore-data.md) diff --git a/docs-2.0/backup-and-restore/nebula-br-ent/2.install-tools.md b/docs-2.0/backup-and-restore/nebula-br-ent/2.install-tools.md index 1c4064c9abe..29c0c0f129a 100644 --- a/docs-2.0/backup-and-restore/nebula-br-ent/2.install-tools.md +++ b/docs-2.0/backup-and-restore/nebula-br-ent/2.install-tools.md @@ -1,20 +1,20 @@ -# 安装 BR（企业版） +# 安装{{br_ent.name}} -备份和恢复{{nebula.name}}企业版数据需要安装 BR 企业版工具。本文介绍如何安装 BR 企业版工具。 +备份和恢复{{nebula.name}}数据需要安装{{br_ent.name}}。本文介绍如何安装{{br_ent.name}}。 ## 安装说明 -使用 BR （企业版）工具时，需要安装 NebulaGraph Agent 插件。Agent 是集群中每台机器的一个守护进程，用于启停{{nebula.name}}服务和上传/下载备份文件。BR（企业版）工具和 Agent 插件的安装方式如下文。 +使用{{br_ent.name}}时，需要安装 NebulaGraph Agent 插件。Agent 是集群中每台机器的一个守护进程，用于启停{{nebula.name}}服务和上传/下载备份文件。{{br_ent.name}}和 Agent 插件的安装方式如下文。 ## 版本兼容性 -|{{nebula.name}}|BR 企业版|Agent | +|{{nebula.name}}|{{br_ent.name}}|Agent | |:---|:---|:---| |3.4.1|3.4.1、3.4.0|3.4.0| -## 安装 BR（企业版） +## 安装{{br_ent.name}} -BR 企业版工具是一款命令行界面（CLI）工具，可以帮助备份{{nebula.name}}的图空间数据，或者通过备份目录恢复数据。 +{{br_ent.name}}是一款命令行界面（CLI）工具，可以帮助备份{{nebula.name}}的图空间数据，或者通过备份目录恢复数据。 操作步骤如下： @@ -22,16 +22,16 @@ BR 企业版工具是一款命令行界面（CLI）工具，可以帮助备份{{ !!! enterpriseonly - [联系我们](https://www.nebula-graph.com.cn/contact)获取 BR 企业版工具的安装包。 + [联系我们](https://www.nebula-graph.com.cn/contact)获取{{br_ent.name}}的安装包。 2. 使用`sudo rpm -i `命令安装 RPM 包。 - 例如，安装 BR 企业版需要运行以下命令，默认安装路径为`/usr/local/br-ent/`： + 例如，安装{{br_ent.name}}需要运行以下命令，默认安装路径为`/usr/local/br-ent/`： `sudo rpm -i nebula-br-ent-.x86_64.rpm` -在 BR 企业版工具的安装目录下，用户可以通过命令`./br version`查看版本信息。返回以下信息： +在{{br_ent.name}}的安装目录下，用户可以通过命令`./br version`查看版本信息。返回以下信息： ``` [br-ent]$ ./br version @@ -40,7 +40,7 @@ Nebula Backup And Restore Utility Tool,V-{{br_ent.release}} ## 安装 Agent -NebulaGraph Agent 以二进制形式存在各个机器的安装目录中，通过 RPC 协议对 BR 工具提供服务。 +NebulaGraph Agent 以二进制形式存在各个机器的安装目录中，通过 RPC 协议对{{br_ent.name}}提供服务。 在**每台机器**中，进行以下操作： diff --git a/docs-2.0/backup-and-restore/nebula-br-ent/3.backup-data.md b/docs-2.0/backup-and-restore/nebula-br-ent/3.backup-data.md index 6872394ccf9..fe86a2c5c39 100644 --- a/docs-2.0/backup-and-restore/nebula-br-ent/3.backup-data.md +++ b/docs-2.0/backup-and-restore/nebula-br-ent/3.backup-data.md @@ -1,6 +1,6 @@ -# 使用 BR（企业版）备份数据 +# 备份数据 -用户可以通过 BR 企业版工具备份{{nebula.name}}企业版数据。支持增量和全量备份，支持备份数据至本地及兼容亚马逊对象存储（Amazon S3）服务接口的云存储服务中。本文介绍如何备份数据。 +用户可以通过{{br_ent.name}}工具备份{{nebula.name}}数据。支持增量和全量备份，支持备份数据至本地及兼容亚马逊对象存储（Amazon S3）服务接口的云存储服务中。本文介绍如何备份数据。 ## 背景信息 @@ -21,9 +21,9 @@ - 已启动{{nebula.name}}服务。 -- 已安装 [BR 企业版工具和 Agent 插件](2.install-tools.md)并在集群中的每个机器上运行 Agent。 +- 已安装 [{{br_ent.name}}工具和 Agent 插件](2.install-tools.md)并在集群中的每个机器上运行 Agent。 -- 如果在本地保存备份目录，需要在 Meta 服务器、Storage 服务器和 BR 机器上创建绝对路径相同的目录，并记录绝对路径，同时需要保证账号对该目录有写权限。 +- 如果在本地保存备份目录，需要在 Meta 服务器、Storage 服务器和{{br_ent.name}}机器上创建绝对路径相同的目录，并记录绝对路径，同时需要保证账号对该目录有写权限。 ## 全量备份 @@ -33,7 +33,7 @@ 只支持备份数据至兼容亚马逊 S3 协议的云存储服务中。 -在 BR 企业版工具安装目录下执行以下命令备份整个集群数据至云存储服务： +在{{br_ent.name}}工具安装目录下执行以下命令备份整个集群数据至云存储服务： ``` ./br backup full --meta --s3.access_key --s3.secret_key --s3.region --storage s3:// --s3.endpoint @@ -49,11 +49,11 @@ !!! caution - 在生产环境中，建议用户将 NFS（Network File System）共享存储设备挂载到 Meta 服务器、Storage 服务器和 BR 机器上进行本地备份，或者使用 Alibaba Cloud OSS、Amazon S3 进行远程备份。否则当需要通过本地文件恢复数据前，必须手动将这些备份目录移动到指定目录。 + 在生产环境中，建议用户将 NFS（Network File System）共享存储设备挂载到 Meta 服务器、Storage 服务器和{{br_ent.name}}机器上进行本地备份，或者使用 Alibaba Cloud OSS、Amazon S3 进行远程备份。否则当需要通过本地文件恢复数据前，必须手动将这些备份目录移动到指定目录。 备份至本地时，只备份 leader metad 和 leader partition 的数据，因此当未使用共享存储且有多个 metad 或 partition 的 replica 数大于 1 时，需要手动将备份后的 leader metad 的目录（路径为`/meta`）拷贝并覆盖其他 follower metad 节点的对应目录，并将 leader partition 的目录中对应的分片数据（路径为`/`）拷贝至其他 follower partition 对应的目录中。不建议用户进行手动拷贝操作。 -在 BR 企业版工具安装目录下执行以下命令备份整个集群数据至本地： +在{{br_ent.name}}工具安装目录下执行以下命令备份整个集群数据至本地： !!! note @@ -109,7 +109,7 @@ 只支持备份数据至兼容亚马逊 S3 协议的云存储服务中。 -在 BR 企业版工具安装目录下执行以下命令备份增量数据至云存储服务： +在{{br_ent.name}}工具安装目录下执行以下命令备份增量数据至云存储服务： ``` ./br backup incr --meta --s3.access_key --s3.secret_key --s3.region --storage s3:// --s3.endpoint --base @@ -123,7 +123,7 @@ ### 增量备份数据至本地 -在 BR 企业版工具安装目录下执行以下命令备份增量数据至本地： +在{{br_ent.name}}工具安装目录下执行以下命令备份增量数据至本地： !!! note @@ -187,7 +187,7 @@ ## 查看备份进度 -在安装目录内可以查看 BR 的日志文件`br.log`。日志文件会记录备份进度，内容类似： +在安装目录内可以查看{{br_ent.name}}的日志文件`br.log`。日志文件会记录备份进度，内容类似： ```log {"level":"info","msg":"full upload storaged partition finished, progress: 1/20","time":"2023-03-15T02:13:20.946Z"} diff --git a/docs-2.0/backup-and-restore/nebula-br-ent/4.restore-data.md b/docs-2.0/backup-and-restore/nebula-br-ent/4.restore-data.md index 0b5014f1b41..8a4b6025995 100644 --- a/docs-2.0/backup-and-restore/nebula-br-ent/4.restore-data.md +++ b/docs-2.0/backup-and-restore/nebula-br-ent/4.restore-data.md @@ -1,4 +1,4 @@ -# 使用 BR（企业版）恢复数据 +# 恢复数据 如果使用[备份工具](2.install-tools.md)备份了{{nebula.name}}的数据，可以通过备份目录进行数据恢复。本文介绍如何通过备份目录恢复数据。 @@ -9,7 +9,7 @@ ## 准备工作 -- 已安装 [BR 企业版工具和 Agent 插件](2.install-tools.md)并在集群中的**每个**机器上运行 Agent。 +- 已安装 [{{br_ent.name}}工具和 Agent 插件](2.install-tools.md)并在集群中的**每个**机器上运行 Agent。 - 确认没有应用程序连接到待恢复数据的{{nebula.name}}集群。 @@ -17,7 +17,7 @@ ## 操作步骤 -在 BR 工具安装目录下执行以下操作： +在{{br_ent.name}}工具安装目录下执行以下操作： 1. 查看现有备份信息。 @@ -74,14 +74,14 @@ !!! note - 如果数据恢复失败，BR 会自动执行回滚流程，将集群的数据会自动还原回恢复前的数据。 + 如果数据恢复失败，{{br_ent.name}}会自动执行回滚流程，将集群的数据会自动还原回恢复前的数据。 3. 执行以下命令清理临时文件。该命令将清理集群和外部存储中的临时文件，同时也可以使用该命令清理旧的备份目录。示例如下： !!! note - 默认情况下，数据恢复执行发生错误时，BR 会自动清理临时文件。如果自动清理失败，需要手动执行命令清理临时文件。 + 默认情况下，数据恢复执行发生错误时，{{br_ent.name}}会自动清理临时文件。如果自动清理失败，需要手动执行命令清理临时文件。 - 清除本地的备份目录。 @@ -115,7 +115,7 @@ ## 查看恢复进度 -在安装目录内可以查看 BR 的日志文件`br.log`。日志文件会记录恢复进度，内容类似： +在安装目录内可以查看{{br_ent.name}}的日志文件`br.log`。日志文件会记录恢复进度，内容类似： ```log {"level":"info","msg":"download storaged partition finished, progress: 1/20","time":"2023-03-15T02:16:43.430Z"} diff --git a/docs-2.0/graph-computing/algorithm-description.md b/docs-2.0/graph-computing/algorithm-description.md index 398debeb4dc..d2860556bb5 100644 --- a/docs-2.0/graph-computing/algorithm-description.md +++ b/docs-2.0/graph-computing/algorithm-description.md @@ -386,7 +386,7 @@ LPA（标签传播）算法是一种基于图的半监督学习方法，其基 |`ITERATIONS`|`10`|最大迭代次数。| |`IS_DIRECTED`|`true`|是否考虑边的方向。如果设置为`false`，系统会自动添加反向边。| |`IS_CALC_MODULARITY`|`false`|是否计算模块度。| - |`IS_OUTPUT_MODULARITY`|`false`|是否计算并输出模块度。设置为`true`时，默认输出到文件的第三列，也可以通过选项`--nebula_output_props`和`--nebula_output_types`输出到{{nebula.name}}中。使用 Explorer 时暂不支持输出到{{nebula.name}}中。| + |`IS_OUTPUT_MODULARITY`|`false`|是否计算并输出模块度。设置为`true`时，默认输出到文件的第三列，也可以通过选项`--nebula_output_props`和`--nebula_output_types`输出到{{nebula.name}}中。使用{{explorer.name}}时暂不支持输出到{{nebula.name}}中。| |`IS_STAT_COMMUNITY`|`false`|是否统计社区的数量。| - 输出参数 @@ -422,7 +422,7 @@ HANP（Hop Attenuation & Node Preference）算法是LPA算法的优化算法， |`IS_DIRECTED`|`true`|是否考虑边的方向。如果设置为`false`，系统会自动添加反向边。| |`PREFERENCE`|`1.0`|对邻居节点度的偏向性。`m>0`表示偏向节点度高的邻居，`m<0`表示偏向节点度低的邻居，`m=0`表示不考虑邻居节点度。| |`HOP_ATT`|`0.1`|衰减因子。取值范围`0`~`1`。值越大衰减的越快，可以传递的次数越少。| - |`IS_OUTPUT_MODULARITY`|`false`|是否计算并输出模块度。设置为`true`时，默认输出到文件的第三列，也可以通过选项`--nebula_output_props`和`--nebula_output_types`输出到{{nebula.name}}中。使用 Explorer 时暂不支持输出到{{nebula.name}}中。| + |`IS_OUTPUT_MODULARITY`|`false`|是否计算并输出模块度。设置为`true`时，默认输出到文件的第三列，也可以通过选项`--nebula_output_props`和`--nebula_output_types`输出到{{nebula.name}}中。使用{{explorer.name}}时暂不支持输出到{{nebula.name}}中。| |`IS_STAT_COMMUNITY`|`false`|是否统计社区的数量。| - 输出参数 @@ -458,7 +458,7 @@ ConnectedComponent（联通分量）算法用于计算出图中的一个子图 |:--|:--|:--| |`IS_DIRECTED`|`true`|是否考虑边的方向。如果设置为`false`，系统会自动添加反向边。| |`IS_CALC_MODULARITY`|`false`|是否计算模块度。| - |`IS_OUTPUT_MODULARITY`|`false`|是否计算并输出模块度。设置为`true`时，默认输出到文件的第三列，也可以通过选项`--nebula_output_props`和`--nebula_output_types`输出到{{nebula.name}}中。使用 Explorer 时暂不支持输出到{{nebula.name}}中。| + |`IS_OUTPUT_MODULARITY`|`false`|是否计算并输出模块度。设置为`true`时，默认输出到文件的第三列，也可以通过选项`--nebula_output_props`和`--nebula_output_types`输出到{{nebula.name}}中。使用{{explorer.name}}时暂不支持输出到{{nebula.name}}中。| |`IS_STAT_COMMUNITY`|`false`|是否统计社区的数量。| - 输出参数 @@ -494,7 +494,7 @@ Louvain 算法是基于模块度的社区发现算法，该算法在效率和效 |`OUTER_ITERATION`|`20`|第一阶段最大迭代次数。| |`INNER_ITERATION`|`10`|第二阶段最大迭代次数。| |`IS_CALC_MODULARITY`|`false`|是否计算模块度。| - |`IS_OUTPUT_MODULARITY`|`false`|是否计算并输出模块度。设置为`true`时，默认输出到文件的第三列，也可以通过选项`--nebula_output_props`和`--nebula_output_types`输出到{{nebula.name}}中。使用 Explorer 时暂不支持输出到{{nebula.name}}中。| + |`IS_OUTPUT_MODULARITY`|`false`|是否计算并输出模块度。设置为`true`时，默认输出到文件的第三列，也可以通过选项`--nebula_output_props`和`--nebula_output_types`输出到{{nebula.name}}中。使用{{explorer.name}}时暂不支持输出到{{nebula.name}}中。| |`IS_STAT_COMMUNITY`|`false`|是否统计社区的数量。| - 输出参数 diff --git a/docs-2.0/graph-computing/use-explorer.md b/docs-2.0/graph-computing/use-explorer.md index 65e516d61d5..07d306cab7f 100644 --- a/docs-2.0/graph-computing/use-explorer.md +++ b/docs-2.0/graph-computing/use-explorer.md @@ -1,9 +1,9 @@ -# NebulaGraph Explorer Workflow +# {{explorer.name}} Workflow -NebulaGraph Explorer 提供 Workflow 功能进行可视化图计算。 +{{explorer.name}}提供 Workflow 功能进行可视化图计算。 详情参见[工作流简介](../nebula-explorer/workflow/workflows.md)。 !!! enterpriseonly - 如需获取 Nebula Explorer 安装包，请[联系我们](https://www.nebula-graph.com.cn/contact)。 + 如需获取{{explorer.name}}安装包，请[联系我们](https://www.nebula-graph.com.cn/contact)。 diff --git a/docs-2.0/nebula-cloud/1.what-is-cloud.md b/docs-2.0/nebula-cloud/1.what-is-cloud.md index 1719916ed27..9eef61cad69 100644 --- a/docs-2.0/nebula-cloud/1.what-is-cloud.md +++ b/docs-2.0/nebula-cloud/1.what-is-cloud.md @@ -15,7 +15,7 @@ NebulaGraph Cloud 支持： ## 产品功能 - 即买即用。用户可以根据自己的业务发展随时创建或停止{{nebula.name}}实例，业务提供充分的灵活性。 -- 集成可视化图数据库管理工具 Nebula Dashboard、Nebula Explorer。可以使用它们导入图数据集、执行 nGQL 语句查询、探索图数据、监控数据等。即使没有图数据库操作经验，也可以快速成为图专家。 +- 集成可视化图数据库管理工具 Nebula Dashboard、{{explorer.name}}。可以使用它们导入图数据集、执行 nGQL 语句查询、探索图数据、监控数据等。即使没有图数据库操作经验，也可以快速成为图专家。 - 用户可直接使用 Nebula Console 等客户端连接到云上数据库，而不需要先访问云平台。 - 权限控制。用户可以为指定图空间增加不同角色权限的数据库用户，保证业务数据安全。 - 官方支持。用户可以快速创建工单，咨询使用过程中遇到的问题。 diff --git a/docs-2.0/nebula-cloud/nebula-cloud-on-alibabacloud/1.create-service-instance.md b/docs-2.0/nebula-cloud/nebula-cloud-on-alibabacloud/1.create-service-instance.md index 2d2698cbe17..5c80d0e337f 100644 --- a/docs-2.0/nebula-cloud/nebula-cloud-on-alibabacloud/1.create-service-instance.md +++ b/docs-2.0/nebula-cloud/nebula-cloud-on-alibabacloud/1.create-service-instance.md @@ -47,8 +47,8 @@ NebulaGraph Cloud 阿里云版支持如下套餐版本。 | 套餐版本 | 说明 | | - | - | | 基础版 | 将所有{{nebula.name}}服务节点部署在 1 台 ECS 服务器上。 | -| 标准版 | 将 Graph 服务和 Storage 服务分别部署在不同的 ECS 服务器上，每个服务都是单节点（1 台 ECS）。将 Explorer 等生态工具混合部署在 1 台 ECS 服务器上。 | -| 高可用版 | 将 Graph 服务和 Storage 服务分别部署在不同的 ECS 服务器上，每个服务都包含 3 节点（3 台 ECS）。将 Explorer 等生态工具混合部署在 1 台 ECS 服务器上。 | +| 标准版 | 将 Graph 服务和 Storage 服务分别部署在不同的 ECS 服务器上，每个服务都是单节点（1 台 ECS）。将{{explorer.name}}等生态工具混合部署在 1 台 ECS 服务器上。 | +| 高可用版 | 将 Graph 服务和 Storage 服务分别部署在不同的 ECS 服务器上，每个服务都包含 3 节点（3 台 ECS）。将{{explorer.name}}等生态工具混合部署在 1 台 ECS 服务器上。 | 付费版和免费试用版服务实例支持的套餐版本有所不同，详情参见创建实例页面。 diff --git a/docs-2.0/nebula-cloud/nebula-cloud-on-alibabacloud/2.use-cloud-services.md b/docs-2.0/nebula-cloud/nebula-cloud-on-alibabacloud/2.use-cloud-services.md index 85293b0f666..37c8b933e7e 100644 --- a/docs-2.0/nebula-cloud/nebula-cloud-on-alibabacloud/2.use-cloud-services.md +++ b/docs-2.0/nebula-cloud/nebula-cloud-on-alibabacloud/2.use-cloud-services.md @@ -18,7 +18,7 @@ 2. 在实例列表中，单击目标实例的**服务实例ID**，或其右侧**操作**列的**详情**。 -3. 在**概览**标签页的**基本信息**区域，可以查看 Graph 服务、Storage 服务，以及 Explorer、Dashboard 等周边工具的连接信息。 +3. 在**概览**标签页的**基本信息**区域，可以查看 Graph 服务、Storage 服务，以及{{explorer.name}}、Dashboard 等周边工具的连接信息。 ## 连接{{nebula.name}} 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 ed8b290074a..fb9c54257dd 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 @@ -1,10 +1,10 @@ -# 什么是 NebulaGraph Dashboard（企业版） +# 什么是{{dashboard_ent.name} -NebulaGraph Dashboard（简称 Dashboard）是一款用于监控和管理{{nebula.name}}多集群中机器和服务状态的可视化工具。本文主要介绍企业版 Dashboard，社区版详情参见[什么是 NebulaGraph Dashboard（社区版）](../nebula-dashboard/1.what-is-dashboard.md)。 +{{dashboard_ent.name}是一款用于监控和管理{{nebula.name}}多集群中机器和服务状态的可视化工具。 !!! note - 用户也可以[在线试用 Dashboard](https://dashboard.nebula-graph.io/clusters)部分功能。 + 用户也可以[在线试用{{dashboard_ent.name}](https://dashboard.nebula-graph.io/clusters)部分功能。 ![intro-overview](https://docs-cdn.nebula-graph.com.cn/figures/intro-overview-20220711-cn.gif) @@ -32,7 +32,7 @@ NebulaGraph Dashboard（简称 Dashboard）是一款用于监控和管理{{nebul - 监控数据默认保留 14 天，即只能查询最近 14 天内任意时间段的监控数据。 - 只支持 2.5.0 及以上版本的{{nebula.name}}。 -- 建议使用最新版本的 Chrome 访问 Dashboard。 +- 建议使用最新版本的 Chrome 访问{{dashboard_ent.name}。 - 建议使用官方提供的安装包进行集群创建或导入。 !!! note @@ -41,9 +41,9 @@ NebulaGraph Dashboard（简称 Dashboard）是一款用于监控和管理{{nebul ## 版本兼容性 -{{nebula.name}}的版本和 Dashboard 企业版的版本对应关系如下。 +{{nebula.name}}的版本和{{dashboard_ent.name}的版本对应关系如下。 -|{{nebula.name}}版本|Dashboard 版本| +|{{nebula.name}}版本|{{dashboard_ent.name}版本| |:---|:---| |3.4.0 ~ 3.4.1 |3.4.2、3.4.1、3.4.0、3.2.4、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| @@ -56,5 +56,5 @@ NebulaGraph Dashboard（简称 Dashboard）是一款用于监控和管理{{nebul ## 视频 -* [NebulaGraph Dashboard Demo 介绍（v3.0 版本）](https://www.bilibili.com/video/BV12A4y1f7KL/)（2 分 57 秒） +* [{{dashboard_ent.name} Demo 介绍（v3.0 版本）](https://www.bilibili.com/video/BV12A4y1f7KL/)（2 分 57 秒） diff --git a/docs-2.0/nebula-dashboard-ent/10.tasks.md b/docs-2.0/nebula-dashboard-ent/10.tasks.md index 22658fe51a6..ca218a015c4 100644 --- a/docs-2.0/nebula-dashboard-ent/10.tasks.md +++ b/docs-2.0/nebula-dashboard-ent/10.tasks.md @@ -1,6 +1,6 @@ # 任务中心 -NebulaGraph Dashboard 企业版支持展示正在运行的任务的进度和已结束的历史任务的信息。 +{{dashboard_ent.name}支持展示正在运行的任务的进度和已结束的历史任务的信息。 ## 注意事项 @@ -20,7 +20,7 @@ NebulaGraph Dashboard 企业版支持展示正在运行的任务的进度和已 ## 入口 -在 NebulaGraph Dashboard 企业版顶部导航栏中，单击**任务中心**可查看相关任务信息。 +在{{dashboard_ent.name}顶部导航栏中，单击**任务中心**可查看相关任务信息。 ## 运行中的任务 diff --git a/docs-2.0/nebula-dashboard-ent/11.dashboard-ent-license.md b/docs-2.0/nebula-dashboard-ent/11.dashboard-ent-license.md index 204b6b2b4d0..913ace920ff 100644 --- a/docs-2.0/nebula-dashboard-ent/11.dashboard-ent-license.md +++ b/docs-2.0/nebula-dashboard-ent/11.dashboard-ent-license.md @@ -1,11 +1,11 @@ -# NebulaGraph Dashboard 企业版 License +# {{dashboard_ent.name} License -License 是为用户提供的软件授权证书。用户在部署 NebulaGraph Dashboard 企业版时，需要设置 License 才能正常启动 NebulaGraph Dashboard 企业版。本文介绍 NebulaGraph Dashboard 企业版的 License 相关信息。 +License 是为用户提供的软件授权证书。用户在部署{{dashboard_ent.name}时，需要设置 License 才能正常启动{{dashboard_ent.name}。本文介绍{{dashboard_ent.name}的 License 相关信息。 ## 注意事项 -- 没有设置 License 时，NebulaGraph Dashboard 企业版无法启动。 +- 没有设置 License 时，{{dashboard_ent.name}无法启动。 - 请勿修改 License，否则会导致 License 失效。 @@ -21,15 +21,15 @@ License 是为用户提供的软件授权证书。用户在部署 NebulaGraph Da ## 获取方式 -[联系我们](https://www.nebula-graph.com.cn/contact)申请 NebulaGraph Dashboard 企业版 License。 +[联系我们](https://www.nebula-graph.com.cn/contact)申请{{dashboard_ent.name} License。 !!! note - 填写 [NebulaGraph Dashboard 试用申请](https://wj.qq.com/s2/10158890/69a8)可获取 30 天免费试用的 License。 + 填写 [{{dashboard_ent.name}试用申请](https://wj.qq.com/s2/10158890/69a8)可获取 30 天免费试用的 License。 -## NebulaGraph Dashboard 企业版 License 说明 +## {{dashboard_ent.name} License 说明 -NebulaGraph Dashboard 企业版 License 是一个名为`nebula.license`的文件，内容示例如下： +{{dashboard_ent.name} License 是一个名为`nebula.license`的文件，内容示例如下： ```bash ----------License Content Start---------- @@ -59,7 +59,7 @@ License 文件包含生效时间、过期时间等信息。说明如下。 |`organization`| 用户名称。| |`issuedDate`| License 生效时间。| |`expirationDate`| License 过期时间。| -|`product`| 产品类型。NebulaGraph Dashboard 企业版的产品类型为`nebula_graph_dashboard`。| +|`product`| 产品类型。{{dashboard_ent.name}的产品类型为`nebula_graph_dashboard`。| |`version`| 版本支持的信息。| |`licenseType`| License 类型（预留参数）。包括`enterprise`、`samll_bussiness`、`pro`、`individual`。| |`gracePeriod`| 证书过期后可继续使用服务的缓冲时间（单位天），超过缓冲期后停止服务。试用版的 License 过期后无缓冲期，默认值为 0。 | @@ -67,15 +67,15 @@ License 文件包含生效时间、过期时间等信息。说明如下。 ## 使用方式 -关于如何使用 NebulaGraph Dashboard 企业版 License，参见[部署 Dashboard 企业版](2.deploy-connect-dashboard-ent.md)。 +关于如何使用{{dashboard_ent.name} License，参见[部署{{dashboard_ent.name}](2.deploy-connect-dashboard-ent.md)。 ## 续期操作 -按照以下操作续期 NebulaGraph Dashboard 企业版 License。 +按照以下操作续期{{dashboard_ent.name} License。 -1. [联系我们](https://www.nebula-graph.com.cn/contact)申请新的 NebulaGraph Dashboard 企业版 License 文件`nebula.license`。 -2. 在 NebulaGraph Dashboard 企业版的安装目录下（例如，`/usr/local/nebula-dashboard-ent`），使用新的 License 文件替换旧的 License 文件。 +1. [联系我们](https://www.nebula-graph.com.cn/contact)申请新的{{dashboard_ent.name} License 文件`nebula.license`。 +2. 在{{dashboard_ent.name}的安装目录下（例如，`/usr/local/nebula-dashboard-ent`），使用新的 License 文件替换旧的 License 文件。 !!! note - NebulaGraph Dashboard 企业版 License 过期后，用户无法登录 Dashboard。为了保证业务正常运行，请及时更新 License。 \ No newline at end of file + License 过期后，用户无法登录{{dashboard_ent.name}。为了保证业务正常运行，请及时更新 License。 \ No newline at end of file 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 6b2787a4499..83f1d4c8acd 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 @@ -1,34 +1,34 @@ -# 部署 Dashboard 企业版 +# 部署{{dashboard_ent.name} -本文将详细介绍如何安装并部署 Dashboard 企业版。 +本文将详细介绍如何安装并部署{{dashboard_ent.name}。 ## 前提条件 -在部署 Dashboard 之前，用户需要确认以下信息： +在部署{{dashboard_ent.name}之前，用户需要确认以下信息： -- 选择并下载符合版本的 Dashboard。关于 Dashboard 和{{nebula.name}}的版本对应关系，参见[版本兼容性](1.what-is-dashboard-ent.md)。 +- 选择并下载符合版本的{{dashboard_ent.name}。关于{{dashboard_ent.name}和{{nebula.name}}的版本对应关系，参见[版本兼容性](1.what-is-dashboard-ent.md)。 -- Dashboard 支持 SQLite 和 MySQL 存储 Dashboard 元数据。如果用户使用 MySQL，需准备版本为 5.7 以上的 [MySQL](https://www.mysql.com/cn/) 环境，创建名称为`dashboard`的数据库，字符集为`utf8`。 +- {{dashboard_ent.name}支持 SQLite 和 MySQL 存储{{dashboard_ent.name}元数据。如果用户使用 MySQL，需准备版本为 5.7 以上的 [MySQL](https://www.mysql.com/cn/) 环境，创建名称为`dashboard`的数据库，字符集为`utf8`。 !!! note - 如果使用 SQLite 存储 Dashboard 元数据，则无需准备 SQLite 环境。 + 如果使用 SQLite 存储{{dashboard_ent.name}元数据，则无需准备 SQLite 环境。 - 确保在安装开始前，以下端口处于未被使用状态。 | 端口号 | 说明 | | ------ | --------------------------------- | - | 7005 | Dashboard 提供 web 服务的端口。 | + | 7005 | {{dashboard_ent.name}提供 web 服务的端口。 | | 9090 | Prometheus 服务的端口。 | | 9200 | nebula-stats-exporter 服务的端口。 | - | 9093 | Alertmanager 服务的端口。接收 Prometheus 告警，发送告警通知给 Dashboard。| + | 9093 | Alertmanager 服务的端口。接收 Prometheus 告警，发送告警通知给{{dashboard_ent.name}。| | 9100 | node-exporter 的服务端口。在集群创建后，自动部署在目标机器内，收集集群中机器的资源信息，包括 CPU、内存、负载、磁盘和流量。 | - [准备 License](11.dashboard-ent-license.md)。 !!! enterpriseonly - License 仅在企业版提供，申请 License 需填写 [NebulaGraph Dashboard 试用申请](https://wj.qq.com/s2/10158890/69a8)。 + License 仅在企业版提供，申请 License 需填写 [{{dashboard_ent.name}试用申请](https://wj.qq.com/s2/10158890/69a8)。 ## 使用 TAR 包部署 @@ -38,7 +38,7 @@ !!! enterpriseonly - 用户可以[在线申请](https://wj.qq.com/s2/10158890/69a8)试用 Dashboard 企业版；如需购买，请[联系我们](https://www.nebula-graph.com.cn/contact)。点击[定价](https://nebula-graph.com.cn/pricing/)查看更多。 + 用户可以[在线申请](https://wj.qq.com/s2/10158890/69a8)试用{{dashboard_ent.name}；如需购买，请[联系我们](https://www.nebula-graph.com.cn/contact)。点击[定价](https://nebula-graph.com.cn/pricing/)查看更多。 2. 使用`tar -xzvf`解压 TAR 包。 @@ -56,13 +56,13 @@ ```bash Name: dashboard-api - Host: 0.0.0.0 # 指定能访问 Dashboard 的地址。 - Port: 7005 # 访问 Dashboard 企业版服务的默认端口。 + Host: 0.0.0.0 # 指定能访问{{dashboard_ent.name}的地址。 + Port: 7005 # 访问{{dashboard_ent.name}企业版服务的默认端口。 MaxBytes: 1073741824 # Http 可接受请求的最大 ContentLength，默认为 1048576。取值范围：0 ~ 8388608。 Timeout: 15000 # 访问超时时间。 Debug: # 是否开启Debug模式。 Enable: false - Log: # Dashboard 运行日志设置。 + Log: # {{dashboard_ent.name}运行日志设置。 KeepDays: 7 # 日志保留天数。 Mode: console # 日志保存方式，支持 console 和 file。console 表示服务日志会记录在 webserver.log里；file 表示服务日志会分别记录在 access.log、error.log、severe.log、slow.log 和 stat.log 里。 Database: @@ -93,7 +93,7 @@ # 系统信息 System: - WebAddress: http://127.0.0.1:7005 # 外网访问 Dashboard 的地址，也可以设置为域名。用于一些接口回调，例如邮件被邀请人可以使用此链接访问 Dashboard。 + WebAddress: http://127.0.0.1:7005 # 外网访问{{dashboard_ent.name}的地址，也可以设置为域名。用于一些接口回调，例如邮件被邀请人可以使用此链接访问{{dashboard_ent.name}。 MessageStore: 90 # 保存告警消息的天数，默认 90 天。 # LDAP 信息 @@ -117,16 +117,16 @@ $ cp -r nebula.license /usr/local/nebula-dashboard-ent ``` -5. 启动 Dashboard。 +5. 启动{{dashboard_ent.name}。 - 可以使用以下命令一键启动 Dashboard。 + 可以使用以下命令一键启动{{dashboard_ent.name}。 ```bash $ cd /usr/local/nebula-dashboard-ent/scripts $ sudo ./dashboard.service start all ``` - 或是执行以下命令，分别启动 Prometheus、nebula-dashboard-server、nebula-stats-exporter 和 Alertmanager 依赖服务以启动 Dashboard。 + 或是执行以下命令，分别启动 Prometheus、nebula-dashboard-server、nebula-stats-exporter 和 Alertmanager 依赖服务以启动{{dashboard_ent.name}。 ```bash $ cd scripts @@ -138,7 +138,7 @@ !!! note - 在启动 Dashboard 后，如再修改配置文件的话，在修改后，可在`scripts`目录下执行`dashboard.service restart all`同步修改至 Dashboard 客户端页面中。 + 在启动{{dashboard_ent.name}后，如再修改配置文件的话，在修改后，可在`scripts`目录下执行`dashboard.service restart all`同步修改至{{dashboard_ent.name}客户端页面中。 ## 使用 RPM 包部署 @@ -148,11 +148,11 @@ !!! enterpriseonly - 用户可以[在线申请](https://wj.qq.com/s2/10158890/69a8)试用 Dashboard 企业版；如需购买，请[联系我们](https://www.nebula-graph.com.cn/contact)。点击[定价](https://nebula-graph.com.cn/pricing/)查看更多。 + 用户可以[在线申请](https://wj.qq.com/s2/10158890/69a8)试用{{dashboard_ent.name}；如需购买，请[联系我们](https://www.nebula-graph.com.cn/contact)。点击[定价](https://nebula-graph.com.cn/pricing/)查看更多。 2. 使用`sudo rpm -ivh `命令安装 RPM 包。 - 例如，安装 Dashboard 企业版需要运行以下命令，默认安装路径为`/usr/local/nebula-dashboard-ent`： + 例如，安装{{dashboard_ent.name}需要运行以下命令，默认安装路径为`/usr/local/nebula-dashboard-ent`： ```bash sudo rpm -ivh nebula-dashboard-ent-.x86_64.rpm @@ -199,7 +199,7 @@ password: "" # SMTP 服务器的密码。 # 系统信息 system: - webAddress: http://127.0.0.1:7005 # 邮件被邀请人连接 Dashboard 的访问地址。 + webAddress: http://127.0.0.1:7005 # 邮件被邀请人连接{{dashboard_ent.name}的访问地址。 messageStore: 90 # 保存告警消息的天数，默认 90 天。 # LDAP 信息 ldap: @@ -213,7 +213,7 @@ ### 卸载 -执行以下命令卸载通过 RPM 包部署的 Dashboard。 +执行以下命令卸载通过 RPM 包部署的{{dashboard_ent.name}。 ``` sudo rpm -e @@ -227,12 +227,12 @@ sudo rpm -e !!! enterpriseonly - 用户可以[在线申请](https://wj.qq.com/s2/10158890/69a8)试用 Dashboard 企业版；如需购买，请[联系我们](https://www.nebula-graph.com.cn/contact)。点击[定价](https://nebula-graph.com.cn/pricing/)查看更多。 + 用户可以[在线申请](https://wj.qq.com/s2/10158890/69a8)试用{{dashboard_ent.name}；如需购买，请[联系我们](https://www.nebula-graph.com.cn/contact)。点击[定价](https://nebula-graph.com.cn/pricing/)查看更多。 2. 使用`sudo dpkg -i `命令安装 DEB 包。 - 例如，安装 Dashboard 企业版需要运行以下命令，默认安装路径为`/usr/local/nebula-dashboard-ent`： + 例如，安装{{dashboard_ent.name}需要运行以下命令，默认安装路径为`/usr/local/nebula-dashboard-ent`： ```bash sudo dpkg -i nebula-dashboard-ent-{{dashboard_ent.release}}.ubuntu1804.amd64.deb @@ -240,7 +240,7 @@ sudo rpm -e !!! note - 使用 DEB 包安装 Dashboard 企业版时不支持自定义安装路径。 + 使用 DEB 包安装{{dashboard_ent.name}时不支持自定义安装路径。 3. 拷贝 License 至`nebula-dashboard-ent`目录下。 @@ -277,21 +277,21 @@ sudo rpm -e password: "" # SMTP 服务器的密码。 # 系统信息 system: - webAddress: http://127.0.0.1:7005 # 邮件被邀请人连接 Dashboard 的访问地址。 + webAddress: http://127.0.0.1:7005 # 邮件被邀请人连接{{dashboard_ent.name}的访问地址。 messageStore: 90 # 告警消息保存的天数，默认 90 天。 ``` ### 卸载 -执行以下命令卸载通过 DEB 包部署的 Dashboard。 +执行以下命令卸载通过 DEB 包部署的{{dashboard_ent.name}。 ``` sudo dpkg -r ``` -## 管理 Dashboard 服务 +## 管理{{dashboard_ent.name}服务 -Dashboard 使用脚本`dashboard.service`管理服务，包括启动、重启、停止和查看状态。 +{{dashboard_ent.name}使用脚本`dashboard.service`管理服务，包括启动、重启、停止和查看状态。 ```bash sudo /scripts/dashboard.service @@ -301,7 +301,7 @@ sudo /scripts/dashboard.service | 参数 | 说明 | | :------------------------- | :------------------- | -| `dashboard_path` | Dashboard 安装路径。 | +| `dashboard_path` | {{dashboard_ent.name}安装路径。 | | `-v` | 显示详细调试信息。 | | `-h` | 显示帮助信息。 | | `start` | 启动服务。 | @@ -316,22 +316,22 @@ sudo /scripts/dashboard.service !!! note - 查看 Dashboard 版本可以使用命令`./dashboard.service -version`。 + 查看{{dashboard_ent.name}版本可以使用命令`./dashboard.service -version`。 ### 示例 Dashboard 的安装在当前目录下，用户可以用以下命令管理服务。 ```bash -$ sudo /dashboard/scripts/dashboard.service start all #启动 Dashboard 所有服务。 -$ sudo /dashboard/scripts/dashboard.service stop all #停止 Dashboard 所有服务。 -$ sudo /dashboard/scripts/dashboard.service status all #查看 Dashboard 所有服务状态。 -$ sudo /dashboard/scripts/dashboard.service restart all #重启 Dashboard 所有服务状态。 +$ sudo /dashboard/scripts/dashboard.service start all #启动{{dashboard_ent.name}所有服务。 +$ sudo /dashboard/scripts/dashboard.service stop all #停止{{dashboard_ent.name}所有服务。 +$ sudo /dashboard/scripts/dashboard.service status all #查看{{dashboard_ent.name}所有服务状态。 +$ sudo /dashboard/scripts/dashboard.service restart all #重启{{dashboard_ent.name}所有服务状态。 ``` ## 查看日志 -用户可以在`logs`目录内查看 Dashboard 企业版的日志。 +用户可以在`logs`目录内查看{{dashboard_ent.name}的日志。 例如： @@ -347,13 +347,13 @@ cat logs/prometheus.log |`nebula-stats-exporter.log`| nebula-stats-exporter 服务日志。 | |`prometheus.log`| Prometheus 服务日志。 | |`br`| 备份恢复日志。 | -|`webserver.log`| Dashboard 服务日志。
Dashboard 的配置`Log.Mode`为`console`时生效。 | -|`access.log`| 访问日志。
Dashboard 的配置`Log.Mode`为`file`时生效。 | -|`error.log`| 错误日志。
Dashboard 的配置`Log.Mode`为`file`时生效。 | -|`severe.log`| 严重错误日志。
Dashboard 的配置`Log.Mode`为`file`时生效。 | -|`slow.log`| 慢日志。
Dashboard 的配置`Log.Mode`为`file`时生效。 | -|`stat.log`| 统计日志。
Dashboard 的配置`Log.Mode`为`file`时生效。 | +|`webserver.log`| {{dashboard_ent.name}服务日志。
{{dashboard_ent.name}的配置`Log.Mode`为`console`时生效。 | +|`access.log`| 访问日志。
{{dashboard_ent.name}的配置`Log.Mode`为`file`时生效。 | +|`error.log`| 错误日志。
{{dashboard_ent.name}的配置`Log.Mode`为`file`时生效。 | +|`severe.log`| 严重错误日志。
{{dashboard_ent.name}的配置`Log.Mode`为`file`时生效。 | +|`slow.log`| 慢日志。
{{dashboard_ent.name}的配置`Log.Mode`为`file`时生效。 | +|`stat.log`| 统计日志。
{{dashboard_ent.name}的配置`Log.Mode`为`file`时生效。 | ## 后续操作 -[连接 Dashboard](3.connect-dashboard.md) +[连接{{dashboard_ent.name}](3.connect-dashboard.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 index c2b09fa0b1f..97ff079bf31 100644 --- a/docs-2.0/nebula-dashboard-ent/3.connect-dashboard.md +++ b/docs-2.0/nebula-dashboard-ent/3.connect-dashboard.md @@ -1,27 +1,27 @@ -# 连接 Dashboard +# 连接{{dashboard_ent.name} -Dashboard 部署完成后，可以通过浏览器登录使用 Dashboard。 +{{dashboard_ent.name}部署完成后，可以通过浏览器登录使用{{dashboard_ent.name}。 ## 前提条件 -- Dashboard 相关服务已经启动。详情请参见[部署 Dashboard](2.deploy-connect-dashboard-ent.md)。 +- {{dashboard_ent.name}相关服务已经启动。详情请参见[部署{{dashboard_ent.name}](2.deploy-connect-dashboard-ent.md)。 - 建议使用 Chrome 89 及以上的版本的 Chrome 浏览器，否则可能有兼容问题。 ## 操作步骤 -1. 确认 Dashboard 服务所在机器的 IP 地址，在浏览器中输入`http://:7005`打开登录页面。 +1. 确认{{dashboard_ent.name}服务所在机器的 IP 地址，在浏览器中输入`http://:7005`打开登录页面。 - 如在浏览器窗口中看到以下登录界面，则表示已经成功部署并启动了 Dashboard。 + 如在浏览器窗口中看到以下登录界面，则表示已经成功部署并启动了{{dashboard_ent.name}。 ![dashboard-login-cn](https://docs-cdn.nebula-graph.com.cn/figures/login_20220909_cn.png) !!! note - 首次登录企业版 NebulaGraph Dashboard 的时候，页面显示*最终用户许可协议*的内容，请仔细阅读并单击**同意**。 + 首次登录{{dashboard_ent.name}的时候，页面显示*最终用户许可协议*的内容，请仔细阅读并单击**同意**。 -2. 使用初始化用户名`nebula`和密码`nebula`登录 Dashboard。 +2. 使用初始化用户名`nebula`和密码`nebula`登录{{dashboard_ent.name}。 !!! note - 登录 Dashboard 后可创建 LDAP 账户、OAuth2.0 账户和普通账户，然后使用不同的账户登录 Dashboard。关于账户的详情，参见[权限管理](5.account-management.md)。 + 登录{{dashboard_ent.name}后可创建 LDAP 账户、OAuth2.0 账户和普通账户，然后使用不同的账户登录{{dashboard_ent.name}。关于账户的详情，参见[权限管理](5.account-management.md)。 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 e1d130b7bb9..cc2bce593a9 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 @@ -1,12 +1,12 @@ # 创建集群 -本文介绍如何通过 Dashboard 创建集群。 +本文介绍如何通过{{dashboard_ent.name}创建集群。 ## 操作步骤 按以下方式创建集群： -1. 在 Dashboard 页面顶部，单击**集群管理**。 +1. 在{{dashboard_ent.name}页面顶部，单击**集群管理**。 2. 在集群管理页面，单击**创建集群**标签。 3. 在创建集群页面，完成以下配置： - 输入**集群名称**，最大可输入 15 个字符。 @@ -14,7 +14,7 @@ !!! note - Dashboard 默认内置企业版的{{nebula.name}}安装包。如果用户需要安装其他版本的{{nebula.name}}，可以在**安装包管理**页面下载或上传，详情参见[安装包管理](../system-settings/manage-package.md)。 + {{dashboard_ent.name}默认内置企业版的{{nebula.name}}安装包。如果用户需要安装其他版本的{{nebula.name}}，可以在**安装包管理**页面下载或上传，详情参见[安装包管理](../system-settings/manage-package.md)。 - 单击**上传证书**。 @@ -30,7 +30,7 @@ - SSH 密码：输入 SSH 用户对应的密码。 - - SSH 密钥：单击**上传**，选择节点的私钥文件。需要提前在待添加节点上生成密钥文件，并将私钥发送给当前电脑（非 Dashboard 机器）。如果设置了短密码（passphrase），也需要填写。 + - SSH 密钥：单击**上传**，选择节点的私钥文件。需要提前在待添加节点上生成密钥文件，并将私钥发送给当前电脑（非{{dashboard_ent.name}机器）。如果设置了短密码（passphrase），也需要填写。 ![cluster](https://docs-cdn.nebula-graph.com.cn/figures/create-cluster-221115_cn.png) diff --git a/docs-2.0/nebula-dashboard-ent/3.create-import-dashboard/2.import-cluster.md b/docs-2.0/nebula-dashboard-ent/3.create-import-dashboard/2.import-cluster.md index 6538a787ef9..66eb4e4220f 100644 --- a/docs-2.0/nebula-dashboard-ent/3.create-import-dashboard/2.import-cluster.md +++ b/docs-2.0/nebula-dashboard-ent/3.create-import-dashboard/2.import-cluster.md @@ -1,6 +1,6 @@ # 导入集群 -本文介绍如何通过 Dashboard 导入集群。当前版本仅支持官方下载的 DEB、RPM 包部署的集群和 Dashboard 创建的集群导入，暂不支持导入使用 Docker 和 Kubernetes 方式部署的集群。 +本文介绍如何通过{{dashboard_ent.name}导入集群。当前版本仅支持官方下载的 DEB、RPM 包部署的集群和{{dashboard_ent.name}创建的集群导入，暂不支持导入使用 Docker 和 Kubernetes 方式部署的集群。 ## 操作步骤 diff --git a/docs-2.0/nebula-dashboard-ent/4.cluster-operator/1.overview.md b/docs-2.0/nebula-dashboard-ent/4.cluster-operator/1.overview.md index ad10221af30..5d85fd61ce9 100644 --- a/docs-2.0/nebula-dashboard-ent/4.cluster-operator/1.overview.md +++ b/docs-2.0/nebula-dashboard-ent/4.cluster-operator/1.overview.md @@ -1,12 +1,12 @@ # 集群总览 -本文主要介绍 Dashboard 的集群总览页面。 +本文主要介绍{{dashboard_ent.name}的集群总览页面。 -在 Dashboard 页面顶部，单击**集群管理**，然后在集群列表右侧，单击**详情**，即可进入指定集群的集群总览页面。 +在{{dashboard_ent.name}页面顶部，单击**集群管理**，然后在集群列表右侧，单击**详情**，即可进入指定集群的集群总览页面。 ## 概览 -Dashboard 的集群总览页面分为五个部分： +{{dashboard_ent.name}的集群总览页面分为五个部分： - 集群概况 - 告警 @@ -37,7 +37,7 @@ Dashboard 的集群总览页面分为五个部分： 只有当创建或导入的集群为{{nebula.name}}企业版时，才会显示过期时间。 -- **创建用户**：显示创建或导入的{{nebula.name}}集群时使用的 Dashboard 用户名。 +- **创建用户**：显示创建或导入的{{nebula.name}}集群时使用的{{dashboard_ent.name}用户名。 - **版本**：显示{{nebula.name}}集群的版本信息。右侧有版本升级按钮，方便快速跳转至[版本升级](operator/version-upgrade.md)页面。 在**集群信息**区域右上方，单击![watch](https://docs-cdn.nebula-graph.com.cn/figures/watch_cn.png)进入集群信息详情页面，查看集群的详细信息，包括名字、创建时间、创建用户、版本、创建用户的角色。 diff --git a/docs-2.0/nebula-dashboard-ent/4.cluster-operator/2.monitor.md b/docs-2.0/nebula-dashboard-ent/4.cluster-operator/2.monitor.md index 73ec53121ea..8f553f743db 100644 --- a/docs-2.0/nebula-dashboard-ent/4.cluster-operator/2.monitor.md +++ b/docs-2.0/nebula-dashboard-ent/4.cluster-operator/2.monitor.md @@ -1,8 +1,8 @@ # 集群监控 -本文主要介绍 Dashboard 的集群监控中的节点监控、服务监控以及可视化的监控大屏。 +本文主要介绍{{dashboard_ent.name}的集群监控中的节点监控、服务监控以及可视化的监控大屏。 -在 Dashboard 顶部导航栏，单击**集群管理**，在目标集群右侧单击**详情**，在左侧导航栏的**集群监控**下包含**节点监控**、**服务监控**和**监控大屏**。 +在{{dashboard_ent.name}顶部导航栏，单击**集群管理**，在目标集群右侧单击**详情**，在左侧导航栏的**集群监控**下包含**节点监控**、**服务监控**和**监控大屏**。 ## 节点监控 @@ -59,13 +59,13 @@ 服务监控页面还可以监控图空间级别指标。**只有当图空间指标的行为被触发后，用户才能指定图空间查看对应的图空间指标的信息**。图空间的监控指标记录不同图空间的数据。目前，只有 Graph 服务支持基于图空间的监控指标。 -Dashboard 支持的图空间指标，参见[图空间](../7.monitor-parameter.md)。 +{{dashboard_ent.name}支持的图空间指标，参见[图空间](../7.monitor-parameter.md)。 ![graph-metrics](https://docs-cdn.nebula-graph.com.cn/figures/space_level_metrics_cn.png) ## 可视化监控大屏 -Dashboard 企业版的可视化监控大屏帮助用户一目了然地把握集群的健康状态、服务及节点信息。 +{{dashboard_ent.name}的可视化监控大屏帮助用户一目了然地把握集群的健康状态、服务及节点信息。 单击**集群监控**->**监控大屏**进入监控大屏页面。 diff --git a/docs-2.0/nebula-dashboard-ent/4.cluster-operator/5.operation-record.md b/docs-2.0/nebula-dashboard-ent/4.cluster-operator/5.operation-record.md index f0a1902cd3d..48bf6255be1 100644 --- a/docs-2.0/nebula-dashboard-ent/4.cluster-operator/5.operation-record.md +++ b/docs-2.0/nebula-dashboard-ent/4.cluster-operator/5.operation-record.md @@ -1,7 +1,7 @@ # 操作记录 -本文主要介绍 Dashboard 的操作记录。 +本文主要介绍{{dashboard_ent.name}的操作记录。 -在 Dashboard 顶部导航栏，单击**集群管理**，单击目标集群右侧**详情**，然后在左侧导航栏，单击**操作记录**进入操作记录页面。 +在{{dashboard_ent.name}顶部导航栏，单击**集群管理**，单击目标集群右侧**详情**，然后在左侧导航栏，单击**操作记录**进入操作记录页面。 在操作页面可以看到 1 小时、6 小时、12 小时、1 天、3 天、7 天和 14 天的操作记录，操作人、操作、时间、集群的信息。 \ No newline at end of file diff --git a/docs-2.0/nebula-dashboard-ent/4.cluster-operator/6.settings.md b/docs-2.0/nebula-dashboard-ent/4.cluster-operator/6.settings.md index f1546b9121a..918ccf8173c 100644 --- a/docs-2.0/nebula-dashboard-ent/4.cluster-operator/6.settings.md +++ b/docs-2.0/nebula-dashboard-ent/4.cluster-operator/6.settings.md @@ -1,8 +1,8 @@ # 其他设置 -本文主要介绍 Dashboard 的其他设置。 +本文主要介绍{{dashboard_ent.name}的其他设置。 -在 Dashboard 顶部导航栏，单击**集群管理**，单击目标集群右侧**详情**，然后在左侧导航栏，单击**其他设置**进入其他设置页面。 +在{{dashboard_ent.name}顶部导航栏，单击**集群管理**，单击目标集群右侧**详情**，然后在左侧导航栏，单击**其他设置**进入其他设置页面。 - 集群信息：显示集群名称、创建时间、创建用户信息、集群所有者名称。 diff --git a/docs-2.0/nebula-dashboard-ent/4.cluster-operator/9.notification.md b/docs-2.0/nebula-dashboard-ent/4.cluster-operator/9.notification.md index 524fadc43ba..161ce79781e 100644 --- a/docs-2.0/nebula-dashboard-ent/4.cluster-operator/9.notification.md +++ b/docs-2.0/nebula-dashboard-ent/4.cluster-operator/9.notification.md @@ -2,7 +2,7 @@ 通知是监控{{nebula.name}}集群的监控指标进行报警的服务。用户可以查看告警信息，设置告警规则和告警接收方。 -在 Dashboard 顶部导航栏，单击**集群管理**，在目标集群右侧单击**详情**，在左侧导航栏的**通知**下包含**告警信息**、**告警规则**和**接收人设置**。 +在{{dashboard_ent.name}}顶部导航栏，单击**集群管理**，在目标集群右侧单击**详情**，在左侧导航栏的**通知**下包含**告警信息**、**告警规则**和**接收人设置**。 ![Alerts](https://docs-cdn.nebula-graph.com.cn/figures/alerts_cn.gif) @@ -20,17 +20,17 @@ - 支持根据信息的严重级别、类型、状态，筛选告警信息。用户可单击**重置**置空所有的筛选项。 - 用户可标记告警信息的处理状态，告警信息处理状态默认为`unsolved`，用户可手动标记为`处理中`和`已解决`状态。 -用户不可删除告警信息，但可在`nebula-dashboard-ent/config/config.yaml`文件中，通过修改`messageStore`参数的值来设置保存告警信息的天数。NebulaGraph Dashboard 默认保存 90 天内的信息。具体操作，参见[部署 Dashboard](../2.deploy-connect-dashboard-ent.md)。 +用户不可删除告警信息，但可在`nebula-dashboard-ent/config/config.yaml`文件中，通过修改`messageStore`参数的值来设置保存告警信息的天数。{{dashboard_ent.name}}默认保存 90 天内的信息。具体操作，参见[部署{{dashboard_ent.name}}](../2.deploy-connect-dashboard-ent.md)。 ## 告警规则 -对集群监控指标进行告警前，需要设置告警规则。用户可以自定义告警规则或者使用 Dashboard 内置的规则。 +对集群监控指标进行告警前，需要设置告警规则。用户可以自定义告警规则或者使用{{dashboard_ent.name}}内置的规则。 ### 创建自定义规则 用户创建自定义规则的步骤如下： -1. 在 Dashboard 顶部导航栏中，单击**集群管理**，然后在目标集群右侧，单击**详情**。 +1. 在{{dashboard_ent.name}}顶部导航栏中，单击**集群管理**，然后在目标集群右侧，单击**详情**。 2. 在**集群管理**页面左侧导航栏中，单击**通知**->**告警规则**。 3. 在**告警规则**页面，单击**自定义规则**，然后单击右侧的**创建规则**。 4. 设置创建规则的所需的信息。 @@ -79,7 +79,7 @@ ### 内置规则 -内置规则是 Dashboard 为用户提供的默认规则。用户可打开和关闭内置规则，开启状态显示 **active**，关闭状态显示 **disable**。 +内置规则是{{dashboard_ent.name}}为用户提供的默认规则。用户可打开和关闭内置规则，开启状态显示 **active**，关闭状态显示 **disable**。 !!! note 内置规则不可被修改和删除。 @@ -92,7 +92,7 @@ 用户可为目标集群设置接收告警消息的邮箱，并且查看 Webhook 的地址及 Webhook 的开启状态。有关 Webhook 的介绍，参见[通知设置](../system-settings/notification-endpoint.md)。 -1. 在 Dashboard 顶部导航栏中，单击**集群管理**，然后在目标集群右侧，单击**详情**。 +1. 在{{dashboard_ent.name}}顶部导航栏中，单击**集群管理**，然后在目标集群右侧，单击**详情**。 2. 在**集群管理**页面左侧导航栏中，单击**通知**->**接收人设置**。 3. 在**接收人设置**页面： diff --git a/docs-2.0/nebula-dashboard-ent/4.cluster-operator/analysis-diagnosis/cluster-diagnosis.md b/docs-2.0/nebula-dashboard-ent/4.cluster-operator/analysis-diagnosis/cluster-diagnosis.md index d148bfec64e..2bcfcde5140 100644 --- a/docs-2.0/nebula-dashboard-ent/4.cluster-operator/analysis-diagnosis/cluster-diagnosis.md +++ b/docs-2.0/nebula-dashboard-ent/4.cluster-operator/analysis-diagnosis/cluster-diagnosis.md @@ -10,7 +10,7 @@ ## 入口 -1. 在 Dashboard 企业版顶部导航栏，单击**集群管理**。 +1. 在{{dashboard_ent.name}}顶部导航栏，单击**集群管理**。 2. 单击目标集群右侧**详情**。 3. 在左侧导航栏，单击**分析诊断**->**集群诊断**。 diff --git a/docs-2.0/nebula-dashboard-ent/4.cluster-operator/analysis-diagnosis/slow-query-analyst.md b/docs-2.0/nebula-dashboard-ent/4.cluster-operator/analysis-diagnosis/slow-query-analyst.md index 10d1f4e8a66..0af37d98030 100644 --- a/docs-2.0/nebula-dashboard-ent/4.cluster-operator/analysis-diagnosis/slow-query-analyst.md +++ b/docs-2.0/nebula-dashboard-ent/4.cluster-operator/analysis-diagnosis/slow-query-analyst.md @@ -1,6 +1,6 @@ # 慢查询分析 -在 DBA 的日常工作中，需要对集群的查询语句执行情况进行分析和治理，NebulaGraph Dashboard 支持查看慢查询的情况，包括语句、耗时、类型、执行计划等。 +在 DBA 的日常工作中，需要对集群的查询语句执行情况进行分析和治理，{{dashboard_ent.name}}支持查看慢查询的情况，包括语句、耗时、类型、执行计划等。 ## 功能介绍 @@ -13,7 +13,7 @@ ## 入口 -1. 在 Dashboard 企业版顶部导航栏，单击**集群管理**。 +1. 在{{dashboard_ent.name}}顶部导航栏，单击**集群管理**。 2. 单击目标集群右侧的**详情**。 3. 在左侧导航栏，单击**分析诊断**->**慢查询分析**。 diff --git a/docs-2.0/nebula-dashboard-ent/4.cluster-operator/cluster-information/audit-log.md b/docs-2.0/nebula-dashboard-ent/4.cluster-operator/cluster-information/audit-log.md index 41b204f1cdd..2f31c512341 100644 --- a/docs-2.0/nebula-dashboard-ent/4.cluster-operator/cluster-information/audit-log.md +++ b/docs-2.0/nebula-dashboard-ent/4.cluster-operator/cluster-information/audit-log.md @@ -1,6 +1,6 @@ # 审计日志 -{{nebula.name}}的审计日志功能可以将 Graph 服务接受到的所有操作进行分类存储，Dashboard 可以快速查看审计日志。 +{{nebula.name}}的审计日志功能可以将 Graph 服务接受到的所有操作进行分类存储，{{dashboard_ent.name}}可以快速查看审计日志。 !!! enterpriseonly @@ -8,7 +8,7 @@ ## 入口 -1. 在 Dashboard 企业版顶部导航栏，单击**集群管理**。 +1. 在{{dashboard_ent.name}}顶部导航栏，单击**集群管理**。 2. 单击目标集群右侧**详情**。 3. 在左侧导航栏，单击**集群信息**->**审计日志**。 diff --git a/docs-2.0/nebula-dashboard-ent/4.cluster-operator/cluster-information/job-management.md b/docs-2.0/nebula-dashboard-ent/4.cluster-operator/cluster-information/job-management.md index 9f7a80c7334..f7ede0f0399 100644 --- a/docs-2.0/nebula-dashboard-ent/4.cluster-operator/cluster-information/job-management.md +++ b/docs-2.0/nebula-dashboard-ent/4.cluster-operator/cluster-information/job-management.md @@ -1,6 +1,6 @@ # 集群作业管理 -Dashboard 可以管理指定图空间中的作业，包括查看、停止、恢复图空间内的作业，并支持查看单个作业的详情。 +{{dashboard_ent.name}}可以管理指定图空间中的作业，包括查看、停止、恢复图空间内的作业，并支持查看单个作业的详情。 !!! note @@ -12,10 +12,10 @@ Dashboard 可以管理指定图空间中的作业，包括查看、停止、恢 ## 入口 -1. 在 Dashboard 企业版顶部导航栏，单击**集群管理**。 +1. 在{{dashboard_ent.name}}顶部导航栏，单击**集群管理**。 2. 单击目标集群右侧**详情**。 3. 在左侧导航栏，单击**集群信息**->**作业管理**。 -4. 选择任意一个在线的 Graph 服务地址，输入登录{{nebula.name}}的账号（非 Dashboard 登录账号）和对应密码。 +4. 选择任意一个在线的 Graph 服务地址，输入登录{{nebula.name}}的账号（非{{dashboard_ent.name}}登录账号）和对应密码。 5. 在左上角选择目标图空间。 ## 查看作业 diff --git a/docs-2.0/nebula-dashboard-ent/4.cluster-operator/cluster-information/overview-info.md b/docs-2.0/nebula-dashboard-ent/4.cluster-operator/cluster-information/overview-info.md index 3a1a813954d..aed4b2a30c8 100644 --- a/docs-2.0/nebula-dashboard-ent/4.cluster-operator/cluster-information/overview-info.md +++ b/docs-2.0/nebula-dashboard-ent/4.cluster-operator/cluster-information/overview-info.md @@ -4,13 +4,13 @@ ## 入口 -1. 在 Dashboard 企业版顶部导航栏，单击**集群管理**。 +1. 在{{dashboard_ent.name}}顶部导航栏，单击**集群管理**。 2. 单击目标集群右侧**详情**。 3. 在左侧导航栏，单击**集群信息**->**信息总览**。 !!! note - 在查看集群信息之前，用户需要选择任意一个在线的 Graph 服务地址，输入登录{{nebula.name}}的账号（非 Dashboard 登录账号）和对应密码。 + 在查看集群信息之前，用户需要选择任意一个在线的 Graph 服务地址，输入登录{{nebula.name}}的账号（非{{dashboard_ent.name}}登录账号）和对应密码。 ![coreinfo](https://docs-cdn.nebula-graph.com.cn/figures/clustercore-info_2022-04-11_cn.png) diff --git a/docs-2.0/nebula-dashboard-ent/4.cluster-operator/cluster-information/runtime-log.md b/docs-2.0/nebula-dashboard-ent/4.cluster-operator/cluster-information/runtime-log.md index 909abdf82b2..28e11765669 100644 --- a/docs-2.0/nebula-dashboard-ent/4.cluster-operator/cluster-information/runtime-log.md +++ b/docs-2.0/nebula-dashboard-ent/4.cluster-operator/cluster-information/runtime-log.md @@ -1,10 +1,10 @@ # 运行日志 -运行日志通常提供给 DBA 或开发人员查看，当系统出现故障，DBA 或开发人员可以根据运行日志定位问题。Dashboard 可以快速查看运行日志。 +运行日志通常提供给 DBA 或开发人员查看，当系统出现故障，DBA 或开发人员可以根据运行日志定位问题。{{dashboard_ent.name}}可以快速查看运行日志。 ## 入口 -1. 在 Dashboard 企业版顶部导航栏，单击**集群管理**。 +1. 在{{dashboard_ent.name}}顶部导航栏，单击**集群管理**。 2. 单击目标集群右侧**详情**。 3. 在左侧导航栏，单击**集群信息**->**运行日志**。 diff --git a/docs-2.0/nebula-dashboard-ent/4.cluster-operator/operator/backup-and-restore.md b/docs-2.0/nebula-dashboard-ent/4.cluster-operator/operator/backup-and-restore.md index b3a00a83d11..a8eb568cada 100644 --- a/docs-2.0/nebula-dashboard-ent/4.cluster-operator/operator/backup-and-restore.md +++ b/docs-2.0/nebula-dashboard-ent/4.cluster-operator/operator/backup-and-restore.md @@ -1,6 +1,6 @@ -# 使用 NebulaGraph Dashboard 备份和恢复{{nebula.name}}数据 +# 使用{{dashboard_ent.name}}备份和恢复{{nebula.name}}数据 -为了防止操作失误或者系统故障导致数据丢失，我们需要经常对数据进行备份，{{nebula.name}}提供 Backup & Restore（BR）工具可帮助用户备份和恢复图数据。NebulaGraph Dashboard 企业版集成了 BR 能力并提供简单的 UI，用户只需几步即可进行数据备份和恢复操作。本文介绍如何使用 NebulaGraph Dashboard 备份和恢复{{nebula.name}}数据。 +为了防止操作失误或者系统故障导致数据丢失，我们需要经常对数据进行备份，{{nebula.name}}提供{{br_ent.name}}工具可帮助用户备份和恢复图数据。{{dashboard_ent.name}}集成了{{br_ent.name}}能力并提供简单的 UI，用户只需几步即可进行数据备份和恢复操作。本文介绍如何使用{{dashboard_ent.name}}备份和恢复{{nebula.name}}数据。 ## 使用限制 @@ -17,14 +17,14 @@ ## 前提条件 -- [使用 Dashboard 创建{{nebula.name}}集群](../../3.create-import-dashboard/1.create-cluster.md)。 +- [使用{{dashboard_ent.name}}创建{{nebula.name}}集群](../../3.create-import-dashboard/1.create-cluster.md)。 - 开通兼容 S3 协议的云存储服务并创建存储桶。具体操作，参见对应云存储服务的文档。 ## 操作步骤 ### 入口 -1. 在 NebulaGraph Dashboard 企业版顶部导航栏，单击**集群管理**。 +1. 在{{dashboard_ent.name}}顶部导航栏，单击**集群管理**。 2. 在目标集群右侧**详情**。 3. 在左侧导航栏，单击**集群操作**->**备份恢复**。 diff --git a/docs-2.0/nebula-dashboard-ent/4.cluster-operator/operator/member-management.md b/docs-2.0/nebula-dashboard-ent/4.cluster-operator/operator/member-management.md index e051e6ddccc..d25bae48c93 100644 --- a/docs-2.0/nebula-dashboard-ent/4.cluster-operator/operator/member-management.md +++ b/docs-2.0/nebula-dashboard-ent/4.cluster-operator/operator/member-management.md @@ -4,7 +4,7 @@ ## 入口 -1. 在 Dashboard 企业版顶部导航栏，单击**集群管理**。 +1. 在{{dashboard_ent.name}}顶部导航栏，单击**集群管理**。 2. 单击目标集群右侧**详情**。 3. 在左侧导航栏，单击**集群操作**->**成员管理**。 @@ -14,7 +14,7 @@ !!! note - 集群管理员必需是用户创建的 Dashboard 企业版账户。关于如何创建账户，参见[权限管理](../../5.account-management.md)。 + 集群管理员必需是用户创建的{{dashboard_ent.name}}账户。关于如何创建账户，参见[权限管理](../../5.account-management.md)。 - 删除集群管理员：在集群管理员右侧操作列单击![delete](https://docs-cdn.nebula-graph.com.cn/figures/alert_delete_cn.png)，然后单击**确认**。 diff --git a/docs-2.0/nebula-dashboard-ent/4.cluster-operator/operator/node.md b/docs-2.0/nebula-dashboard-ent/4.cluster-operator/operator/node.md index e2273f5289b..23a0dc43757 100644 --- a/docs-2.0/nebula-dashboard-ent/4.cluster-operator/operator/node.md +++ b/docs-2.0/nebula-dashboard-ent/4.cluster-operator/operator/node.md @@ -4,7 +4,7 @@ ## 入口 -1. 在 Dashboard 企业版顶部导航栏，单击**集群管理**。 +1. 在{{dashboard_ent.name}}顶部导航栏，单击**集群管理**。 2. 单击目标集群右侧**详情**。 3. 在左侧导航栏，单击**集群操作**->**节点管理**。 @@ -16,7 +16,7 @@ - SSH 密码：输入 SSH 用户对应的密码。 -- SSH 密钥：单击**上传**，选择节点的私钥文件。需要提前在待添加节点上生成密钥文件，并将私钥发送给当前电脑（非 Dashboard 机器）。如果设置了短密码（passphrase），也需要填写。 +- SSH 密钥：单击**上传**，选择节点的私钥文件。需要提前在待添加节点上生成密钥文件，并将私钥发送给当前电脑（非{{dashboard_ent.name}}机器）。如果设置了短密码（passphrase），也需要填写。 !!! note diff --git a/docs-2.0/nebula-dashboard-ent/4.cluster-operator/operator/scale.md b/docs-2.0/nebula-dashboard-ent/4.cluster-operator/operator/scale.md index 8e03e7246a1..cd3858bde4a 100644 --- a/docs-2.0/nebula-dashboard-ent/4.cluster-operator/operator/scale.md +++ b/docs-2.0/nebula-dashboard-ent/4.cluster-operator/operator/scale.md @@ -8,7 +8,7 @@ ## 入口 -1. 在 Dashboard 企业版顶部导航栏，单击**集群管理**。 +1. 在{{dashboard_ent.name}}顶部导航栏，单击**集群管理**。 2. 单击目标集群右侧**详情**。 3. 在左侧导航栏，单击**集群操作**->**扩缩容**。 diff --git a/docs-2.0/nebula-dashboard-ent/4.cluster-operator/operator/service.md b/docs-2.0/nebula-dashboard-ent/4.cluster-operator/operator/service.md index 5bc2f72a40e..ef9dabcc94c 100644 --- a/docs-2.0/nebula-dashboard-ent/4.cluster-operator/operator/service.md +++ b/docs-2.0/nebula-dashboard-ent/4.cluster-operator/operator/service.md @@ -4,7 +4,7 @@ ## 入口 -1. 在 Dashboard 企业版顶部导航栏，单击**集群管理**。 +1. 在{{dashboard_ent.name}}顶部导航栏，单击**集群管理**。 2. 单击目标集群右侧**详情**。 3. 在左侧导航栏，单击**集群操作**->**服务管理**。 diff --git a/docs-2.0/nebula-dashboard-ent/4.cluster-operator/operator/update-config.md b/docs-2.0/nebula-dashboard-ent/4.cluster-operator/operator/update-config.md index 7433061da7f..8896129b651 100644 --- a/docs-2.0/nebula-dashboard-ent/4.cluster-operator/operator/update-config.md +++ b/docs-2.0/nebula-dashboard-ent/4.cluster-operator/operator/update-config.md @@ -4,7 +4,7 @@ ## 入口 -1. 在 Dashboard 企业版顶部导航栏，单击**集群管理**。 +1. 在{{dashboard_ent.name}}顶部导航栏，单击**集群管理**。 2. 单击目标集群右侧**详情**。 3. 在左侧导航栏，单击**集群操作**->**更新配置**。 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 96e9639e585..d485377dde0 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 @@ -1,6 +1,6 @@ # 版本升级 -Dashboard 企业版支持升级现有{{nebula.name}}集群的版本。 +{{dashboard_ent.name}}支持升级现有{{nebula.name}}集群的版本。 !!! caution @@ -17,7 +17,7 @@ Dashboard 企业版支持升级现有{{nebula.name}}集群的版本。 ## 操作说明 -1. 在 Dashboard 企业版顶部导航栏，单击**集群管理**。 +1. 在{{dashboard_ent.name}}顶部导航栏，单击**集群管理**。 2. 在目标集群右侧，单击**详情**。 3. 在左侧导航栏，单击**集群操作**->**版本升级**。 4. 在**版本升级**页面确认**当前{{nebula.name}}版本**，选择**待升级目标版本**。 @@ -26,7 +26,7 @@ Dashboard 企业版支持升级现有{{nebula.name}}集群的版本。 如果没有找到合适的版本，单击**包管理中心**，下载或上传所需的版本安装包。详情参见[安装包管理](../../system-settings/manage-package.md)。 -5. 单击**上传证书**上传 Dashboard 企业版 License（如升级社区版{{nebula.name}}集群，忽略此步）。 +5. 单击**上传证书**上传{{dashboard_ent.name}} License（如升级社区版{{nebula.name}}集群，忽略此步）。 !!! enterpriseonly diff --git a/docs-2.0/nebula-dashboard-ent/5.account-management.md b/docs-2.0/nebula-dashboard-ent/5.account-management.md index 426f7dffcd1..f20f5382a69 100644 --- a/docs-2.0/nebula-dashboard-ent/5.account-management.md +++ b/docs-2.0/nebula-dashboard-ent/5.account-management.md @@ -1,6 +1,6 @@ # 权限管理 -用户可以使用不同账户登录 NebulaGraph Dashboard 企业版，不同账户拥有不同权限。本文介绍账户类型、账户角色及角色权限等。 +用户可以使用不同账户登录{{dashboard_ent.name}，不同账户拥有不同权限。本文介绍账户类型、账户角色及角色权限等。 !!! note @@ -8,11 +8,11 @@ ## 账户类型 -Dashboard 企业版的初始化账户名为`nebula`和密码为`nebula`。使用初始化账户名和密码登录 Dashboard 企业版后，即可创建不同类型的账户：LDAP 账户、OAuth2.0 账户和普通账户。 +{{dashboard_ent.name}的初始化账户名为`nebula`和密码为`nebula`。使用初始化账户名和密码登录{{dashboard_ent.name}后，即可创建不同类型的账户：LDAP 账户、OAuth2.0 账户和普通账户。 ### LDAP 账户 -Dashboard 企业版通过对接 [LDAP（Lightweight Directory Access Protocol）](https://ldap.com/)，使得用户可以使用企业内部账户体系登录 Dashboard 企业版。 +{{dashboard_ent.name}通过对接 [LDAP（Lightweight Directory Access Protocol）](https://ldap.com/)，使得用户可以使用企业内部账户体系登录{{dashboard_ent.name}。 ### OAuth2.0 账户 @@ -20,15 +20,15 @@ Dashboard 企业版通过对接 [LDAP（Lightweight Directory Access Protocol） 该功能仍处于测试中，后续会继续进行调整优化。 -Dashboard 企业版基于 [OAuth2.0](https://oauth.net/2/) 协议，使用 access_token 来授权第三方应用访问受保护的信息。 +{{dashboard_ent.name}基于 [OAuth2.0](https://oauth.net/2/) 协议，使用 access_token 来授权第三方应用访问受保护的信息。 ### 普通账户 -Dashboard 企业版支持用户自行创建本地账号。 +{{dashboard_ent.name}支持用户自行创建本地账号。 ## 账户角色 -用户可以为账户设置不同的角色，不同的角色拥有的权限不同。Dashboard 企业版中的账户角色有两种类型：系统角色（`admin`和`user`）和集群角色（`owner`和`operator`）。 +用户可以为账户设置不同的角色，不同的角色拥有的权限不同。{{dashboard_ent.name}中的账户角色有两种类型：系统角色（`admin`和`user`）和集群角色（`owner`和`operator`）。 系统角色和集群角色的关系及介绍如下。 @@ -53,14 +53,14 @@ Dashboard 企业版支持用户自行创建本地账号。 角色为`admin`的账户可以创建账户。步骤如下： -1. 在 Dashboard 企业版页面的顶部，单击**权限管理**，然后单击**创建**。 +1. 在{{dashboard_ent.name}页面的顶部，单击**权限管理**，然后单击**创建**。 2. 选择创建方式并填入信息，然后单击**确定**。 - - 邀请（LDAP 或 OAuth2.0 账户）：设置被邀请人的账号类型、企业邮箱和角色。被邀请人单击邮件中的 **Accept** 按钮激活账户后，然后单击**登录**自动跳转至 Dashboard 企业版登录页面。被邀请人使用企业邮箱账号和邮箱密码即可登录 Dashboard 企业版。 + - 邀请（LDAP 或 OAuth2.0 账户）：设置被邀请人的账号类型、企业邮箱和角色。被邀请人单击邮件中的 **Accept** 按钮激活账户后，然后单击**登录**自动跳转至{{dashboard_ent.name}登录页面。被邀请人使用企业邮箱账号和邮箱密码即可登录{{dashboard_ent.name}。 !!! note - 开启 LDAP 后还支持自动注册。在登录页面选择 LDAP 方式输入未注册账号登录时，Dashboard 会自动注册该账号，但是角色权限为`user`。 + 开启 LDAP 后还支持自动注册。在登录页面选择 LDAP 方式输入未注册账号登录时，{{dashboard_ent.name}会自动注册该账号，但是角色权限为`user`。 - 创建账户（普通账户）：设置新账户的登录名称、密码、角色。关于角色的详情，参见上文。 diff --git a/docs-2.0/nebula-dashboard-ent/7.monitor-parameter.md b/docs-2.0/nebula-dashboard-ent/7.monitor-parameter.md index 78a3cd8f7ef..08100fbc62e 100644 --- a/docs-2.0/nebula-dashboard-ent/7.monitor-parameter.md +++ b/docs-2.0/nebula-dashboard-ent/7.monitor-parameter.md @@ -1,6 +1,6 @@ # 监控指标说明 -本文介绍 Dashboard 中展示的{{nebula.name}}监控指标。 +本文介绍{{dashboard_ent.name}中展示的{{nebula.name}}监控指标。 ## 机器 @@ -8,7 +8,7 @@ - 以下机器指标适用于 Linux 操作系统。 - 磁盘容量和流量的默认单位为字节（Byte），页面显示时单位会随着数据量级而变化，例如流量低于 1 KB/s 时单位为 Bytes/s。 - - 对于所有版本的企业版 Dashboard，机器的 Buff 和 Cache 所占的内存没有被计算在内存使用率中。 + - 对于所有版本的{{dashboard_ent.name}，机器的 Buff 和 Cache 所占的内存没有被计算在内存使用率中。 ### CPU |参数|说明| @@ -79,7 +79,7 @@ !!! note - 以下为 Dashboard 获取内核的全量指标，但 Dashboard 仅展示重要的指标。 + 以下为{{dashboard_ent.name}获取内核的全量指标，但{{dashboard_ent.name}仅展示重要的指标。 {% include "/source-monitoring-metrics.md" %} diff --git a/docs-2.0/nebula-dashboard-ent/8.faq.md b/docs-2.0/nebula-dashboard-ent/8.faq.md index 6e9566d6114..c8679580409 100644 --- a/docs-2.0/nebula-dashboard-ent/8.faq.md +++ b/docs-2.0/nebula-dashboard-ent/8.faq.md @@ -1,10 +1,10 @@ # 常见问题 FAQ -本文列出了使用 Dashboard 时可能遇到的常见问题，用户可以使用文档中心或者浏览器的搜索功能查找相应问题。 +本文列出了使用{{dashboard_ent.name}时可能遇到的常见问题，用户可以使用文档中心或者浏览器的搜索功能查找相应问题。 ## 什么是集群、节点和服务？ -- 集群：Dashboard 集群特指由多个{{nebula.name}}服务所在的节点组成的一组系统。 +- 集群：{{dashboard_ent.name}集群特指由多个{{nebula.name}}服务所在的节点组成的一组系统。 - 节点：特指承载运行{{nebula.name}}服务的物理或虚拟机。 - 服务：特指{{nebula.name}}服务，包括 Metad，Storaged 和 Graphd。 @@ -18,32 +18,32 @@ ## 为什么要授权节点？ -由于集群的管理操作需要获取对应节点的 SSH 信息，因此 Dashboard 在执行操作前，需要先拥有最少可执行权限的 SSH 账号密码信息。 +由于集群的管理操作需要获取对应节点的 SSH 信息，因此{{dashboard_ent.name}在执行操作前，需要先拥有最少可执行权限的 SSH 账号密码信息。 ## 什么是扩缩容？ -{{nebula.name}}是分布式图数据库，可以支持运行时动态扩展和缩减服务。也可以通过 Dashboard 可视化的动态扩展或缩减 Storage 和 Graph 服务（不可以扩缩容 Metad）。 +{{nebula.name}}是分布式图数据库，可以支持运行时动态扩展和缩减服务。也可以通过{{dashboard_ent.name}可视化的动态扩展或缩减 Storage 和 Graph 服务（不可以扩缩容 Metad）。 ## 为什么不能操作 Meta 服务？ -Meta 服务主要存储{{nebula.name}}数据库中的元数据。一旦 Meta 服务出现问题，整个集群会面临瘫痪风险。且 Meta 处理的数据量较少，一般不会出现扩缩容场景，因此我们直接在 Dashboard 中禁用了操作 Meta，防止出现用户误操作导致集群不可用的情况。 +Meta 服务主要存储{{nebula.name}}数据库中的元数据。一旦 Meta 服务出现问题，整个集群会面临瘫痪风险。且 Meta 处理的数据量较少，一般不会出现扩缩容场景，因此我们直接在{{dashboard_ent.name}中禁用了操作 Meta，防止出现用户误操作导致集群不可用的情况。 ## 扩缩容之后对数据有什么影响？ -- 扩容 Storage：Dashboard 会在指定的机器上创建并运行 Storage 服务，对已有数据不会造成影响，可以在左侧导航栏**集群信息**->**信息总览**中的`Storage Leader 分布`和 `Partition`分布区域，根据自身需求选择进行`Balance Leader`或者`Balance Data`操作。 +- 扩容 Storage：{{dashboard_ent.name}会在指定的机器上创建并运行 Storage 服务，对已有数据不会造成影响，可以在左侧导航栏**集群信息**->**信息总览**中的`Storage Leader 分布`和 `Partition`分布区域，根据自身需求选择进行`Balance Leader`或者`Balance Data`操作。 - 缩容 Storage：如果 Storage 上有分片的话，无法直接缩容。用户需要先在左侧导航栏**集群信息**->**信息总览**中的`Partition 分布`区域单击`Balance Data Remove`，将指定的 Storage 服务中的所有分片迁移至其他 Storage 服务中。 - 扩缩容 Graph 对数据不会有影响。 -## 为什么无法启动 Dashboard（企业版）？ +## 为什么无法启动{{dashboard_ent.name}？ -- 确保 License 已拷贝至 Dashboard 目录中，且执行了`sudo ./dashboard.service start all`命令。 +- 确保 License 已拷贝至{{dashboard_ent.name}目录中，且执行了`sudo ./dashboard.service start all`命令。 - 确保 License 未过期。 -用户也可以在 Dashboard 目录中执行`cat logs/webserver.log`查看各个模块的启动信息。如果满足以上条件，仍无法启动 Dashboard，请前往 [{{nebula.name}}官方论坛](https://discuss.nebula-graph.com.cn/ "点击前往{{nebula.name}}官方论坛")咨询。 +用户也可以在{{dashboard_ent.name}目录中执行`cat logs/webserver.log`查看各个模块的启动信息。如果满足以上条件，仍无法启动{{dashboard_ent.name}，请前往 [{{nebula.name}}官方论坛](https://discuss.nebula-graph.com.cn/ "点击前往{{nebula.name}}官方论坛")咨询。 ## 是否可以手动添加{{nebula.name}}安装包？ -Dashboard 支持手动添加安装包，可以点击[如何获取{{nebula.name}}](https://nebula-graph.com.cn/download/) 下载所需系统和版本的 RPM 包或 DEB 包，添加到`nebula-dashboard-ent/download/nebula-graph`路径下。在创建、扩容集群时，可选择添加的包进行部署。 +{{dashboard_ent.name}支持手动添加安装包，可以点击[如何获取{{nebula.name}}](https://nebula-graph.com.cn/download/) 下载所需系统和版本的 RPM 包或 DEB 包，添加到`nebula-dashboard-ent/download/nebula-graph`路径下。在创建、扩容集群时，可选择添加的包进行部署。 ## 身份验证 -{{nebula.name}}默认不启用身份验证，一般情况下用户可以使用`root`账号和任意密码登录 Explorer。 +{{nebula.name}}默认不启用身份验证，一般情况下用户可以使用`root`账号和任意密码登录{{explorer.name}}。 -{{nebula.name}}启用了身份验证后，用户只能使用指定的账号和密码登录 Explorer。 +{{nebula.name}}启用了身份验证后，用户只能使用指定的账号和密码登录{{explorer.name}}。 关于{{nebula.name}}的身份验证功能，参考 [{{nebula.name}}用户手册](../../7.data-security/1.authentication/1.authentication.md "点击前往{{nebula.name}}官网")。 ## 版本兼容性 -{{nebula.name}}的版本和 Explorer 版本对应关系如下。 +{{nebula.name}}的版本和{{explorer.name}}版本对应关系如下。 -|{{nebula.name}}版本 | Explorer 版本 | +|{{nebula.name}}版本 | {{explorer.name}}版本 | | --- | --- | | 3.4.0 ~ 3.4.1 | 3.4.0、3.2.1、3.2.0 | | 3.3.0 | 3.2.1、3.2.0| diff --git a/docs-2.0/nebula-explorer/canvas-operations/canvas-overview.md b/docs-2.0/nebula-explorer/canvas-operations/canvas-overview.md index 43c217d255a..acb14fad6ea 100644 --- a/docs-2.0/nebula-explorer/canvas-operations/canvas-overview.md +++ b/docs-2.0/nebula-explorer/canvas-operations/canvas-overview.md @@ -37,7 +37,7 @@ ## 多布局 -Explorer 支持 6 种布局方式展示画布上的数据之间的关系。 +{{explorer.name}}支持 6 种布局方式展示画布上的数据之间的关系。 | 力导向图 | 层次图 | 环形图 | 网格 | 神经网络 | 辐射 | | -------- | ------ | ------ | ----- | -------- | ----- | diff --git a/docs-2.0/nebula-explorer/canvas-operations/canvas-snapshot.md b/docs-2.0/nebula-explorer/canvas-operations/canvas-snapshot.md index 0c892cb36b2..ce0b6c62048 100644 --- a/docs-2.0/nebula-explorer/canvas-operations/canvas-snapshot.md +++ b/docs-2.0/nebula-explorer/canvas-operations/canvas-snapshot.md @@ -1,6 +1,6 @@ # 管理快照 -Explorer 的快照功能可保存图探索得到的可视化结果，以便再次打开浏览器时还原保存的图数据。 +{{explorer.name}}的快照功能可保存图探索得到的可视化结果，以便再次打开浏览器时还原保存的图数据。 ## 创建快照 @@ -19,7 +19,7 @@ Explorer 的快照功能可保存图探索得到的可视化结果，以便再 - 目前最多存储 50 个历史快照。 - 历史快照存储在浏览器本地，清理浏览器可能造成快照数据丢失。 -在 Explorer 页面左侧导航栏，单击![snapshot_history](https://docs-cdn.nebula-graph.com.cn/figures/snapshot-history.png)图标进入快照列表页面。用户可切换图空间查看相应图空间的历史快照，还可以导入历史快照至画布，下载历史快照至本地，以及删除快照。 +在{{explorer.name}}页面左侧导航栏，单击![snapshot_history](https://docs-cdn.nebula-graph.com.cn/figures/snapshot-history.png)图标进入快照列表页面。用户可切换图空间查看相应图空间的历史快照，还可以导入历史快照至画布，下载历史快照至本地，以及删除快照。 在目标历史快照右侧的**操作**列下： diff --git a/docs-2.0/nebula-explorer/canvas-operations/visualization-mode.md b/docs-2.0/nebula-explorer/canvas-operations/visualization-mode.md index 0f085b2b29b..ba18d47b928 100644 --- a/docs-2.0/nebula-explorer/canvas-operations/visualization-mode.md +++ b/docs-2.0/nebula-explorer/canvas-operations/visualization-mode.md @@ -1,6 +1,6 @@ # 可视化模式 -Explorer 支持 **2D** 和 **3D** 两种可视化模式探索数据。2D 模式支持数据查看和图操作；3D 模式通过不同视角对图数据进行探索，适用于数据量级比较高或者需要演示的场合。 +{{explorer.name}}支持 **2D** 和 **3D** 两种可视化模式探索数据。2D 模式支持数据查看和图操作；3D 模式通过不同视角对图数据进行探索，适用于数据量级比较高或者需要演示的场合。 !!! note 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 0d6b2a3cf75..4ec654602ff 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,6 +1,6 @@ # Schema 管理 -Explorer 支持界面化方式管理 Schema。 +{{explorer.name}}支持界面化方式管理 Schema。 !!! Note 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 6cc6a111f6a..34417210369 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,6 +1,6 @@ # 数据导入 -Explorer 支持界面化地将 CSV 格式数据导入至{{nebula.name}}中。 +{{explorer.name}}支持界面化地将 CSV 格式数据导入至{{nebula.name}}中。 ## 前提条件 diff --git a/docs-2.0/nebula-explorer/db-management/dbuser_management.md b/docs-2.0/nebula-explorer/db-management/dbuser_management.md index 9f609a5137e..c0c2f880b31 100644 --- a/docs-2.0/nebula-explorer/db-management/dbuser_management.md +++ b/docs-2.0/nebula-explorer/db-management/dbuser_management.md @@ -1,10 +1,10 @@ # 数据库用户管理 -NebulaGraph Explorer 支持管理数据库用户，包括创建用户、删除用户、修改密码等。 +{{explorer.name}}支持管理数据库用户，包括创建用户、删除用户、修改密码等。 ## 前提条件 -登录 Explorer 的用户需要拥有相关操作的权限。例如`God`权限的用户可以执行所有操作，`Admin`权限的用户可以将权限内的图空间授权给其他用户。关于角色权限详情，参见[角色权限](../..//7.data-security/1.authentication/3.role-list.md)。 +登录{{explorer.name}}的用户需要拥有相关操作的权限。例如`God`权限的用户可以执行所有操作，`Admin`权限的用户可以将权限内的图空间授权给其他用户。关于角色权限详情，参见[角色权限](../..//7.data-security/1.authentication/3.role-list.md)。 ## 入口 diff --git a/docs-2.0/nebula-explorer/db-management/draft.md b/docs-2.0/nebula-explorer/db-management/draft.md index d6b1b25b309..06a5ac504b3 100644 --- a/docs-2.0/nebula-explorer/db-management/draft.md +++ b/docs-2.0/nebula-explorer/db-management/draft.md @@ -1,6 +1,6 @@ # Schema 草图 -Explorer 支持 Schema 草图功能。用户可以在画板上自行设计 Schema，可以直观展示点边关系，设计完成后可以将 Schema 应用到指定图空间。 +{{explorer.name}}支持 Schema 草图功能。用户可以在画板上自行设计 Schema，可以直观展示点边关系，设计完成后可以将 Schema 应用到指定图空间。 ## 功能说明 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 e66984d063c..89b3553fc6b 100644 --- a/docs-2.0/nebula-explorer/db-management/explorer-console.md +++ b/docs-2.0/nebula-explorer/db-management/explorer-console.md @@ -1,6 +1,6 @@ # 控制台 -Explorer 的控制台功能允许用户手动输入 nGQL 语句，并可视化地呈现查询结果。本文介绍控制台的界面。 +{{explorer.name}}的控制台功能允许用户手动输入 nGQL 语句，并可视化地呈现查询结果。本文介绍控制台的界面。 ## 入口 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 7d3a7300fbe..cf3518e74d3 100644 --- a/docs-2.0/nebula-explorer/db-management/ngql-template.md +++ b/docs-2.0/nebula-explorer/db-management/ngql-template.md @@ -1,6 +1,6 @@ # 查询语句模板 -NebulaGraph Explorer 支持将常用 nGQL 语句保存为模板，方便自己或他人使用。nGQL 语句中的文本还支持参数化，可根据需要填写参数值。 +{{explorer.name}}支持将常用 nGQL 语句保存为模板，方便自己或他人使用。nGQL 语句中的文本还支持参数化，可根据需要填写参数值。 ## 前提条件 diff --git a/docs-2.0/nebula-explorer/deploy-connect/3.explorer-license.md b/docs-2.0/nebula-explorer/deploy-connect/3.explorer-license.md index 44c406eb4e9..81e57902e4d 100644 --- a/docs-2.0/nebula-explorer/deploy-connect/3.explorer-license.md +++ b/docs-2.0/nebula-explorer/deploy-connect/3.explorer-license.md @@ -1,11 +1,11 @@ -# NebulaGraph Explorer 企业版 License +# {{explorer.name}} License -License 是为用户提供的软件授权证书。用户在部署 NebulaGraph Explorer 企业版时，需要设置 License 才能正常启动 NebulaGraph Explorer 企业版。本文介绍 NebulaGraph Explorer 企业版的 License 相关信息。 +License 是为用户提供的软件授权证书。用户在部署{{explorer.name}}时，需要设置 License 才能正常启动。本文介绍{{explorer.name}}的 License 相关信息。 ## 注意事项 -- 没有设置 License 时，NebulaGraph Explorer 企业版无法启动。 +- 没有设置 License 时，{{explorer.name}}无法启动。 - 请勿修改 License，否则会导致 License 失效。 @@ -21,15 +21,15 @@ License 是为用户提供的软件授权证书。用户在部署 NebulaGraph Ex ## 获取方式 -[联系我们](https://www.nebula-graph.com.cn/contact)申请 NebulaGraph Explorer 企业版 License。 +[联系我们](https://www.nebula-graph.com.cn/contact)申请{{explorer.name}} License。 !!! note - 填写 [NebulaGraph Explorer 试用申请](https://wj.qq.com/s2/10158890/69a8)可获取 30 天免费试用的 License。 + 填写 [{{explorer.name}}试用申请](https://wj.qq.com/s2/10158890/69a8)可获取 30 天免费试用的 License。 -## NebulaGraph Explorer 企业版 License 说明 +## {{explorer.name}} License 说明 -NebulaGraph Explorer 企业版 License 是一个名为`nebula.license`的文件，内容示例如下： +{{explorer.name}} License 是一个名为`nebula.license`的文件，内容示例如下： ```bash ----------License Content Start---------- @@ -59,7 +59,7 @@ License 文件包含生效时间、过期时间等信息。说明如下。 |`organization`| 用户名称。| |`issuedDate`| License 生效时间。| |`expirationDate`| License 过期时间。| -|`product`| 产品类型。NebulaGraph Explorer 企业版的产品类型为`nebula_graph_explorer`。| +|`product`| 产品类型。{{explorer.name}}的产品类型为`nebula_graph_explorer`。| |`version`| 版本支持的信息。| |`licenseType`| License 类型（预留参数）。包括`enterprise`、`samll_bussiness`、`pro`、`individual`。| |`gracePeriod`| 证书过期后可继续使用服务的缓冲时间（单位天），超过缓冲期后停止服务。试用版的 License 过期后无缓冲期，默认值为 0。 | @@ -67,15 +67,15 @@ License 文件包含生效时间、过期时间等信息。说明如下。 ## 使用方式 -关于如何使用 NebulaGraph Explorer，参见[部署 NebulaGraph Explorer](ex-ug-deploy.md)。 +关于如何使用{{explorer.name}}，参见[部署{{explorer.name}}](ex-ug-deploy.md)。 ## 续期操作 -按照以下操作续期 NebulaGraph Explorer License。 +按照以下操作续期{{explorer.name}} License。 -1. [联系我们](https://www.nebula-graph.com.cn/contact)申请新的 NebulaGraph Explorer License 文件`nebula.license`。 -2. 在 NebulaGraph Explorer 的安装目录下（例如，`/usr/local/nebula-explorer`），使用新的 License 文件替换旧的 License 文件。 +1. [联系我们](https://www.nebula-graph.com.cn/contact)申请新的{{explorer.name}} License 文件`nebula.license`。 +2. 在{{explorer.name}}的安装目录下（例如，`/usr/local/nebula-explorer`），使用新的 License 文件替换旧的 License 文件。 !!! note - NebulaGraph Explorer license 过期后，用户无法登录 Explorer。为了保证业务正常运行，请及时更新 License。 \ No newline at end of file + License 过期后，用户无法登录{{explorer.name}}。为了保证业务正常运行，请及时更新 License。 \ No newline at end of file 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 ea05c138571..5342505e83a 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 @@ -1,12 +1,12 @@ # 连接数据库 -在成功启动 Explorer 后，用户需要配置连接 NebulaGraph。默认情况下可以直接连接数据库。为保证数据安全，还支持 OAuth2.0 认证，认证通过后才可以连接数据库。 +在成功启动{{explorer.name}}后，用户需要配置连接{{nebula.name}}。默认情况下可以直接连接数据库。为保证数据安全，还支持 OAuth2.0 认证，认证通过后才可以连接数据库。 ## 前提条件 在连接{{nebula.name}}前，用户需要确认以下信息： -- 已经安装部署了 Explorer。详细信息，参见[部署 Explorer](../deploy-connect/ex-ug-deploy.md)。 +- 已经安装部署了{{explorer.name}}。详细信息，参见[部署{{explorer.name}}](../deploy-connect/ex-ug-deploy.md)。 - {{nebula.name}} 的 Graph 服务本机 IP 地址以及服务所用端口。默认端口为 `9669`。 @@ -24,7 +24,7 @@ 如果想直接连接数据库，请参见后文**连接数据库**部分。 -如果需要开启 OAuth2.0 认证，需要在 Explorer 安装目录内修改配置文件。路径为`config/app-config.yaml`。 +如果需要开启 OAuth2.0 认证，需要在{{explorer.name}}安装目录内修改配置文件。路径为`config/app-config.yaml`。 OAuth 部分的配置说明如下。 @@ -33,7 +33,7 @@ OAuth 部分的配置说明如下。 |`Enable`|`false`|是否开启 OAuth2.0 认证。| |`ClientID` | `4953xxx-mmnoge13xx.apps.googleusercontent.com`| 应用的 ClientId。 | |`ClientSecret` | `GOCxxx-xaytomFexxx` | 应用的 ClientSecret。 | -|`RedirectURL` | `http://dashboard.vesoft-inc.com/login` |重定向到 Dashboard 的 URL。 | +|`RedirectURL` | `http://dashboard.vesoft-inc.com/login` |重定向到{{dashboard_ent.name}}的 URL。 | |`AuthURL` | `https://accounts.google.com/o/oauth2/auth` | 认证 URL。 | |`TokenURL` | `https://oauth2.googleapis.com/token`| 获取 access_token 的 URL。 | |`UserInfoURL` | `https://www.googleapis.com/oauth2/v1/userinfo`| 获取用户信息的 URL。 | @@ -43,7 +43,7 @@ OAuth 部分的配置说明如下。 |`Scope`| `email`| OAuth 的权限范围。权限范围需要是厂商 OAuth2.0 平台配置的 scope 的子集，否则请求会失败。请求的 scope 需要能获取到`UsernameKey`的值。| |`AvatarKey`|`picture`|用户信息里的 Avatar Key。| -配置完成后重启 Explorer 服务，登录页面会先展示 OAuth 认证页面，通过后才能继续连接数据库。 +配置完成后重启{{explorer.name}}服务，登录页面会先展示 OAuth 认证页面，通过后才能继续连接数据库。 ## 连接数据库 @@ -51,21 +51,21 @@ OAuth 部分的配置说明如下。 1. 在浏览器地址栏输入 `http://:7002`。 - 在浏览器窗口中看到以下登录界面表示已经成功部署并启动了 Explorer。 + 在浏览器窗口中看到以下登录界面表示已经成功部署并启动了{{explorer.name}}。 - ![Nebula Explorer 登录页面](https://docs-cdn.nebula-graph.com.cn/figures/explorer_connect_230116_cn.png) + ![{{explorer.name}}登录页面](https://docs-cdn.nebula-graph.com.cn/figures/explorer_connect_230116_cn.png) !!! note - 首次登录 Nebula Explorer 的时候，页面显示*最终用户许可协议*的内容，请仔细阅读并单击**同意**。 + 首次登录{{explorer.name}}的时候，页面显示*最终用户许可协议*的内容，请仔细阅读并单击**同意**。 -2. 在 Explorer 的**配置数据库**页面上，输入以下信息： +2. 在{{explorer.name}}的**配置数据库**页面上，输入以下信息： - **Graphd IP 地址**：填写{{nebula.name}}的 Graph 服务本机 IP 地址。例如`192.168.10.100`。 !!! Note - - 即使{{nebula.name}}与 Explorer 部署在同一台机器上，用户也必须填写这台机器的本机 IP 地址，而不是 `127.0.0.1` 或者 `localhost`。 + - 即使{{nebula.name}}与{{explorer.name}}部署在同一台机器上，用户也必须填写这台机器的本机 IP 地址，而不是 `127.0.0.1` 或者 `localhost`。 - 在新的标签页连接另一个{{nebula.name}}时，会覆盖旧标签页的会话。如果需要同时登录多个{{nebula.name}}，可以用不同的浏览器或者无痕模式。 - **Port**：Graphd 服务的端口。默认为`9669`。 @@ -89,4 +89,4 @@ OAuth 部分的配置说明如下。 在页面右上角，选择![icon](https://docs-cdn.nebula-graph.com.cn/figures/image-icon10.png)图标 > 清空连接。 -如果浏览器上显示**配置数据库**页面，表示 Explorer 已经成功断开了与{{nebula.name}}的连接。 +如果浏览器上显示**配置数据库**页面，表示{{explorer.name}}已经成功断开了与{{nebula.name}}的连接。 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 5c05fac1b5d..01b0528b339 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 @@ -1,10 +1,10 @@ -# 部署 Explorer +# 部署{{explorer.name}} -本文介绍如何在本地通过 RPM、DEB 和 TAR 包部署 Explorer。 +本文介绍如何在本地通过 RPM、DEB 和 TAR 包部署{{explorer.name}}。 ## 前提条件 -在部署 Explorer 之前，用户需要确认以下信息： +在部署{{explorer.name}}之前，用户需要确认以下信息： - {{nebula.name}} 服务已经部署并启动。详细信息参考 [{{nebula.name}}安装部署](../../4.deployment-and-installation/1.resource-preparations.md "点击前往{{nebula.name}}安装部署")。 @@ -12,18 +12,18 @@ | 端口号 | 说明 | | :---- | :---- | - | 7002 | Explorer 提供的 web 服务 | + | 7002 | {{explorer.name}}提供的 web 服务 | !!! caution - Explorer 默认使用的端口号为 7002，用户可以在安装目录下的 `conf/app.conf` 文件中修改 `httpport`，并重启服务。 + {{explorer.name}}默认使用的端口号为 7002，用户可以在安装目录下的 `conf/app.conf` 文件中修改 `httpport`，并重启服务。 - 使用的 Linux 发行版为 CentOS。 - [准备 License](3.explorer-license.md)。 !!! enterpriseonly - License 仅在企业版提供，申请 License 需填写 [Nebula Explorer 试用申请](https://wj.qq.com/s2/10158890/69a8)。 + License 仅在企业版提供，申请 License 需填写 [{{explorer.name}}试用申请](https://wj.qq.com/s2/10158890/69a8)。 - 如果需要使用图计算，需要部署 HDFS。namenode 默认使用 8020 端口，datanode 默认使用 50010 端口。 @@ -33,7 +33,7 @@ ## 注意事项 -Explorer 从 3.2.0 版本开始内置了 Dag Controller 安装包，用于提供图计算服务。用户可以自行决定是否启动 Dag Controller 服务。如果没有启动 Dag Controller 服务， Explorer 中的 **Workflow** 菜单将显示为灰色无法点击。 +{{explorer.name}}从 3.2.0 版本开始内置了 Dag Controller 安装包，用于提供图计算服务。用户可以自行决定是否启动 Dag Controller 服务。如果没有启动 Dag Controller 服务，{{explorer.name}}中的 **Workflow** 菜单将显示为灰色无法点击。 ## RPM 部署 @@ -43,11 +43,11 @@ Explorer 从 3.2.0 版本开始内置了 Dag Controller 安装包，用于提供 !!! enterpriseonly - 用户可以[在线申请](https://wj.qq.com/s2/10158890/69a8)试用 Explorer 企业版；如需购买，请[联系我们](https://www.nebula-graph.com.cn/contact)。点击[定价](https://nebula-graph.com.cn/pricing/)查看更多。 + 用户可以[在线申请](https://wj.qq.com/s2/10158890/69a8)试用{{explorer.name}}；如需购买，请[联系我们](https://www.nebula-graph.com.cn/contact)。点击[定价](https://nebula-graph.com.cn/pricing/)查看更多。 2. 使用`sudo rpm -i `命令安装 RPM 包。 - 例如，安装 Explorer 需要运行以下命令，默认安装路径为`/usr/local/nebula-explorer`： + 例如，安装{{explorer.name}}需要运行以下命令，默认安装路径为`/usr/local/nebula-explorer`： ```bash sudo rpm -i nebula-explorer-.x86_64.rpm @@ -76,7 +76,7 @@ Explorer 从 3.2.0 版本开始内置了 Dag Controller 安装包，用于提供 ```bash cd nebula-explorer - # 启动 Explorer。 + # 启动{{explorer.name}}。 sudo ./scripts/start.sh # （可选）启动 Dag Controller。 @@ -96,15 +96,15 @@ systemctl start nebula-explorer #启动服务 也可以在安装目录下使用以下命令，手动启动或停止服务。 ```bash -sudo ./scripts/start.sh #启动 Explorer 服务 -sudo ./scripts/stop.sh #停止 Explorer 服务 +sudo ./scripts/start.sh #启动{{explorer.name}}服务 +sudo ./scripts/stop.sh #停止{{explorer.name}}服务 sudo ./dag-ctrl/scripts/start.sh #启动 Dag Controller 服务 sudo ./dag-ctrl/scripts/stop.sh #停止 Dag Controller 服务 ``` ### 卸载 -使用以下的命令卸载 Explorer。 +使用以下的命令卸载{{explorer.name}}。 ```bash sudo rpm -e nebula-explorer-.x86_64 @@ -118,12 +118,12 @@ sudo rpm -e nebula-explorer-.x86_64 !!! enterpriseonly - 用户可以[在线申请](https://wj.qq.com/s2/10158890/69a8)试用 Explorer 企业版；如需购买，请[联系我们](https://www.nebula-graph.com.cn/contact)。点击[定价](https://nebula-graph.com.cn/pricing/)查看更多。 + 用户可以[在线申请](https://wj.qq.com/s2/10158890/69a8)试用{{explorer.name}}；如需购买，请[联系我们](https://www.nebula-graph.com.cn/contact)。点击[定价](https://nebula-graph.com.cn/pricing/)查看更多。 2. 使用`sudo dpkg -i `命令安装 DEB 包。 - 例如，安装 Explorer 需要运行以下命令，默认安装路径为`/usr/local/nebula-explorer`： + 例如，安装{{explorer.name}}需要运行以下命令，默认安装路径为`/usr/local/nebula-explorer`： ```bash sudo dpkg -i nebula-explorer-{{explorer.release}}.x86_64.deb @@ -131,7 +131,7 @@ sudo rpm -e nebula-explorer-.x86_64 !!! note - 使用 DEB 包安装 Explorer 时不支持自定义安装路径。 + 使用 DEB 包安装{{explorer.name}}时不支持自定义安装路径。 3. 拷贝 License 至`nebula-explorer`目录下。 @@ -151,7 +151,7 @@ sudo rpm -e nebula-explorer-.x86_64 ```bash cd nebula-explorer - # 启动 Explorer。 + # 启动{{explorer.name}}。 sudo ./lib/start.sh # （可选）启动 Dag Controller。 @@ -172,7 +172,7 @@ sudo systemctl stop nebula-explorer.service ### 卸载 -使用以下的命令卸载 Explorer。 +使用以下的命令卸载{{explorer.name}}。 ```bash sudo dpkg -r nebula-explorer @@ -186,7 +186,7 @@ sudo dpkg -r nebula-explorer !!! enterpriseonly - Explorer 仅在企业版提供，点击[定价](https://nebula-graph.com.cn/pricing/)查看更多。 + {{explorer.name}}仅在企业版提供，点击[定价](https://nebula-graph.com.cn/pricing/)查看更多。 2. 使用 `tar -xvf` 解压 tar 包。 @@ -212,10 +212,10 @@ sudo dpkg -r nebula-explorer ```bash cd nebula-explorer - # 启动 Explorer 和 Dag Controller。 + # 启动{{explorer.name}}和 Dag Controller。 sudo ./scripts/start.sh - # 单独启动 Explorer。 + # 单独启动{{explorer.name}}。 sudo nohup ./nebula-explorer-server > explorer.log 2>&1 & ``` @@ -291,7 +291,7 @@ Dag Controller 可以结合{{plato.name}}进行复杂的图计算。例如 Dag C Debug: Enable: false #是否开启 Debug。 - # Explorer 和 Dag Controller 通信的密钥。无需修改。 + # {{explorer.name}}和 Dag Controller 通信的密钥。无需修改。 RsaPriKey: | -----BEGIN RSA PRIVATE KEY----- MIICXAIBAAKBgQDcR0keIMmmV... @@ -316,4 +316,4 @@ Dag Controller 可以结合{{plato.name}}进行复杂的图计算。例如 Dag C ## 后续操作 -[连接 Explorer](ex-ug-connect.md) \ No newline at end of file +[连接{{explorer.name}}](ex-ug-connect.md) \ No newline at end of file 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 52412dde3d6..3db3c39b4bc 100644 --- a/docs-2.0/nebula-explorer/ex-ug-page-overview.md +++ b/docs-2.0/nebula-explorer/ex-ug-page-overview.md @@ -1,8 +1,8 @@ # 页面概览 -本文介绍 NebulaGraph Explorer 的基本组成，帮忙用户了解 NebulaGraph Explorer 的各功能。 +本文介绍{{explorer.name}}的基本组成，帮忙用户了解{{explorer.name}}的各功能。 -NebulaGraph Explorer 由顶部导航栏、左侧导航栏、和画布三大模块组成。 +{{explorer.name}}由顶部导航栏、左侧导航栏、和画布三大模块组成。 ![explorer-overview](https://docs-cdn.nebula-graph.com.cn/figures/ex-overview-230105-cn.png) @@ -10,7 +10,7 @@ NebulaGraph Explorer 由顶部导航栏、左侧导航栏、和画布三大模 | 图标/元素 | 说明 | | ------------------------------------------------------------ | ---------------------------------------------------- | -| **Explorer** | 可视化探索及分析数据。详情参见[开始探索](graph-explorer/ex-ug-query-exploration.md)、[节点筛选](graph-explorer/node-filtering.md)、[探索拓展](graph-explorer/ex-ug-graph-exploration.md)、[图计算](graph-explorer/graph-algorithm.md)。 | +| **{{explorer.name}}** | 可视化探索及分析数据。详情参见[开始探索](graph-explorer/ex-ug-query-exploration.md)、[节点筛选](graph-explorer/node-filtering.md)、[探索拓展](graph-explorer/ex-ug-graph-exploration.md)、[图计算](graph-explorer/graph-algorithm.md)。 | | **Visual Query** | 可视化构造场景进行数据查询。详情参见[可视化查询](12.query-visually.md)。 | | **Workflow** | 可视化构造自定义工作流进行复杂图计算。需要在 ![setting](https://docs-cdn.nebula-graph.com.cn/figures/navbar-setting-0105.png) 里开启工作流才能显示 Workflow 页面。详情参见[工作流简介](workflow/workflows.md)。| | ![Schema_drafting](https://docs-cdn.nebula-graph.com.cn/figures/schema_drafting_221110.png) | 在画板上自行设计 Schema，可以直观展示点边关系。详情参见[Schema 草图](db-management/draft.md)。| @@ -19,7 +19,7 @@ NebulaGraph Explorer 由顶部导航栏、左侧导航栏、和画布三大模 | ![Console](https://docs-cdn.nebula-graph.com.cn/figures/nav-console2.png) | 对{{nebula.name}}内的数据使用 nGQL 进行查询操作。详情参见[控制台](db-management/explorer-console.md)。 | | ![Template](https://docs-cdn.nebula-graph.com.cn/figures/icon-navbar-queryTemplate.png)| nGQL 语句的模板列表。详情参见[查询语句模板](db-management/ngql-template.md)。| | ![db_user_management](https://docs-cdn.nebula-graph.com.cn/figures/db_user_management_221024.png) | 数据库用户管理。详情参见[数据库用户管理](db-management/dbuser_management.md)。 | -| ![setting](https://docs-cdn.nebula-graph.com.cn/figures/navbar-setting-0105.png) | 全局设置。可以设置 Explorer 页面的语言、开启 Beta 功能、画布查询结果最大数量等。 | +| ![setting](https://docs-cdn.nebula-graph.com.cn/figures/navbar-setting-0105.png) | 全局设置。可以设置{{explorer.name}}页面的语言、开启 Beta 功能、画布查询结果最大数量等。 | | ![help](https://docs-cdn.nebula-graph.com.cn/figures/navbar-help.png) | 帮助页面，指导和帮忙用户使用{{nebula.name}}。 | | ![feedback](https://docs-cdn.nebula-graph.com.cn/figures/navbar-feedback-230105.png) | 反馈页面。可以反馈故障、提交建议、参与调研或联系{{nebula.name}}团队。 | | ![clear_connection](https://docs-cdn.nebula-graph.com.cn/figures/session_221024.png) | 显示连接信息和版本信息。支持修改密码和退出登录。 | @@ -28,9 +28,9 @@ NebulaGraph Explorer 由顶部导航栏、左侧导航栏、和画布三大模 !!! note - 登录 Explorer 后，用户需选择并单击一个目标图空间，然后才可解锁左侧导航栏的查询及分析功能。详情参见[选择图空间](graph-explorer/13.choose-graphspace.md)。 + 登录{{explorer.name}}后，用户需选择并单击一个目标图空间，然后才可解锁左侧导航栏的查询及分析功能。详情参见[选择图空间](graph-explorer/13.choose-graphspace.md)。 -用户可以通过单击 Explorer 页面左侧的图标进行图数据导入、图数据分析与探索等操作。左侧导航栏的图标及描述如下： +用户可以通过单击{{explorer.name}}页面左侧的图标进行图数据导入、图数据分析与探索等操作。左侧导航栏的图标及描述如下： | 图标 | 说明 | | ----- | ---- | @@ -49,9 +49,9 @@ NebulaGraph Explorer 由顶部导航栏、左侧导航栏、和画布三大模 !!! note - 登录 Explorer 后，用户需选择并单击一个目标图空间，才可进入画布页面。详情参见[选择图空间](graph-explorer/13.choose-graphspace.md)。 + 登录{{explorer.name}}后，用户需选择并单击一个目标图空间，才可进入画布页面。详情参见[选择图空间](graph-explorer/13.choose-graphspace.md)。 -图数据可视化地展示在画布中。Explorer 的画布由以下部分组成： +图数据可视化地展示在画布中。{{explorer.name}}的画布由以下部分组成： - 顶部页签 - 可视化模式 diff --git a/docs-2.0/nebula-explorer/ex-ug-shortcuts.md b/docs-2.0/nebula-explorer/ex-ug-shortcuts.md index 93fe5831bf4..2e198257aa4 100644 --- a/docs-2.0/nebula-explorer/ex-ug-shortcuts.md +++ b/docs-2.0/nebula-explorer/ex-ug-shortcuts.md @@ -1,6 +1,6 @@ # 基本操作和快捷键 -本文列出了 Explorer 的基本操作及快捷键。 +本文列出了{{explorer.name}}的基本操作及快捷键。 ## 基本操作 diff --git a/docs-2.0/nebula-explorer/faq.md b/docs-2.0/nebula-explorer/faq.md index 1415ebf30dc..c96a082e101 100644 --- a/docs-2.0/nebula-explorer/faq.md +++ b/docs-2.0/nebula-explorer/faq.md @@ -1,6 +1,6 @@ # 常见问题 FAQ -本文列出了使用 Explorer 时可能遇到的常见问题，用户可以使用文档中心或者浏览器的搜索功能查找相应问题。 +本文列出了使用{{explorer.name}}时可能遇到的常见问题，用户可以使用文档中心或者浏览器的搜索功能查找相应问题。 ## 如果 Graph 服务返回的查询结果数据量过大，会导致 Dag Controller 服务崩溃吗？ diff --git a/docs-2.0/nebula-explorer/graph-explorer/13.choose-graphspace.md b/docs-2.0/nebula-explorer/graph-explorer/13.choose-graphspace.md index f9e52dea814..02a0aa03f19 100644 --- a/docs-2.0/nebula-explorer/graph-explorer/13.choose-graphspace.md +++ b/docs-2.0/nebula-explorer/graph-explorer/13.choose-graphspace.md @@ -1,20 +1,20 @@ # 选择图空间 -用户使用 Explorer 的功能前，需要先选择一个图空间，然后才能对图空间中的数据进行查询和分析。本文介绍如何选择图空间。 +用户使用{{explorer.name}}的功能前，需要先选择一个图空间，然后才能对图空间中的数据进行查询和分析。本文介绍如何选择图空间。 ## 前提条件 -已连接 Explorer。具体操作，参见[连接 Explorer](../deploy-connect/ex-ug-connect.md)。 +已连接{{explorer.name}}。具体操作，参见[连接{{explorer.name}}](../deploy-connect/ex-ug-connect.md)。 ## 操作步骤 -登录 Explorer 后，系统首先会显示图空间选择页面，用户只需选择目标图空间即可。 +登录{{explorer.name}}后，系统首先会显示图空间选择页面，用户只需选择目标图空间即可。 ![Create_graphspace](https://docs-cdn.nebula-graph.com.cn/figures/select-space-220718-cn.png) 之后如果要再次选择图空间，可以通过以下方式： -1. 在 Explorer 页面左侧的导航栏中，单击图空间![graphSpace](https://docs-cdn.nebula-graph.com.cn/figures/nav-graphSpace.png)图标。 +1. 在{{explorer.name}}页面左侧的导航栏中，单击图空间![graphSpace](https://docs-cdn.nebula-graph.com.cn/figures/nav-graphSpace.png)图标。 2. 选择目标图空间。 !!! note 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 e3a84183f41..4090edee545 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 @@ -12,7 +12,7 @@ ## 操作步骤 -在 Explorer 页面左侧单击**开始**图标![query](https://docs-cdn.nebula-graph.com.cn/figures/nav-query2_cn.png)然后查询数据。查询到的数据会显示在画布中。查询方式如下： +在{{explorer.name}}页面左侧单击**开始**图标![query](https://docs-cdn.nebula-graph.com.cn/figures/nav-query2_cn.png)然后查询数据。查询到的数据会显示在画布中。查询方式如下： - VID 查询 - Tag 查询 diff --git a/docs-2.0/nebula-explorer/iframe.md b/docs-2.0/nebula-explorer/iframe.md index 105e404c916..4bd15700fc5 100644 --- a/docs-2.0/nebula-explorer/iframe.md +++ b/docs-2.0/nebula-explorer/iframe.md @@ -1,19 +1,19 @@ # 内联框架 -NebulaGraph Explorer 支持内联框架（iframe），可以将画布嵌入至第三方页面中使用。本文介绍如何嵌入画布。 +{{explorer.name}}支持内联框架（iframe），可以将画布嵌入至第三方页面中使用。本文介绍如何嵌入画布。 ## 前提条件 -已安装 Explorer。 +已安装{{explorer.name}}。 ## 注意事项 -- 嵌入的 Explorer 页面默认直接访问目标图空间，因此会屏蔽部分页面及功能。例如上方导航栏、左侧导航栏中的模板查询和切换图空间等。如果需要访问多个图空间，可以在多个页面中分别嵌入。 +- 嵌入的{{explorer.name}}页面默认直接访问目标图空间，因此会屏蔽部分页面及功能。例如上方导航栏、左侧导航栏中的模板查询和切换图空间等。如果需要访问多个图空间，可以在多个页面中分别嵌入。 - 暂不支持切换语言，默认为中文页面。 ## 步骤 -1. 在 Explorer 安装目录内修改配置文件`config/app-config.yaml`。需要修改的内容如下。 +1. 在{{explorer.name}}安装目录内修改配置文件`config/app-config.yaml`。需要修改的内容如下。 ```bash # 取消 CertFile 和 KeyFile 参数的注释。 @@ -43,7 +43,7 @@ NebulaGraph Explorer 支持内联框架（iframe），可以将画布嵌入至 - `-out`：指定生成的证书请求或者自签名证书名称。 - `-keyout`：指定自动生成的密钥名称。 -3. 用户自行开发，在第三方页面中通过 iframe 方式嵌入 Explorer。 +3. 用户自行开发，在第三方页面中通过 iframe 方式嵌入{{explorer.name}}。 4. 在父页面通过 postMessage 方法传递登录消息，格式如下： @@ -62,16 +62,16 @@ NebulaGraph Explorer 支持内联框架（iframe），可以将画布嵌入至 - `host`：{{nebula.name}}的 Graph 服务地址。 - `space`：目标图空间名称。 -5. 启动 Explorer 服务。 +5. 启动{{explorer.name}}服务。 !!! note - 如果是 RPM/DEB 安装的 Explorer，请执行命令`sudo ./nebula-explorer-server &`。 + 如果是 RPM/DEB 安装的{{explorer.name}}，请执行命令`sudo ./nebula-explorer-server &`。 ```bash ./scripts/start.sh ``` -6. 访问第三方页面，检查是否可以查看到嵌入的 Explorer 页面。示例页面中第一个页面展示`basketballplayer`图空间，第二个和第三个页面展示其他图空间。 +6. 访问第三方页面，检查是否可以查看到嵌入的{{explorer.name}}页面。示例页面中第一个页面展示`basketballplayer`图空间，第二个和第三个页面展示其他图空间。 ![iframe_example](https://docs-cdn.nebula-graph.com.cn/figures/explorer_iframe_example_221025.png) \ No newline at end of file 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 58effaa2caf..25b7dbeeadc 100644 --- a/docs-2.0/nebula-explorer/workflow/1.prepare-resources.md +++ b/docs-2.0/nebula-explorer/workflow/1.prepare-resources.md @@ -5,11 +5,11 @@ ## 前提条件 - 已部署 {{plato.release}} 或以上版本的{{plato.name}}。详情参见[{{plato.name}}](../..//graph-computing/nebula-analytics.md)。 -- 已配置并启动 Dag Controller。详情参见[部署 Explorer](../deploy-connect/ex-ug-deploy.md)。 +- 已配置并启动 Dag Controller。详情参见[部署{{explorer.name}}](../deploy-connect/ex-ug-deploy.md)。 ## 操作步骤 -1. 在 Explorer 页面顶部的导航栏中，单击 **Workflow**。 +1. 在{{explorer.name}}页面顶部的导航栏中，单击 **Workflow**。 2. 在**工作流**标签页单击**配置**。 @@ -19,7 +19,7 @@ |类型|说明| |:--|:--| - |{{nebula.name}}配置| 执行图查询或写入图计算结果的 Graph 服务地址。默认为登录 Explorer 使用的 Graph 服务，无法修改。可以设置三种服务的超时时间。| + |{{nebula.name}}配置| 执行图查询或写入图计算结果的 Graph 服务地址。默认为登录{{explorer.name}}使用的 Graph 服务，无法修改。可以设置三种服务的超时时间。| |HDFS 配置| 存储结果的 HDFS 地址。单击**添加**新增地址，设置 HDFS 名称、HDFS 路径（`fs.defaultFS`配置）、HDFS 用户名。HDFS 路径支持配置保存路径，例如`hdfs://192.168.8.100:9000/test`。需要先在{{plato.name}}所在机器上安装 HDFS 客户端，该配置才能生效。| |{{plato.name}}配置| 执行图计算的{{plato.name}}地址。单击**添加**新增地址。| diff --git a/docs-2.0/nebula-explorer/workflow/2.create-workflow.md b/docs-2.0/nebula-explorer/workflow/2.create-workflow.md index af0d4b2ca85..69ca750a334 100644 --- a/docs-2.0/nebula-explorer/workflow/2.create-workflow.md +++ b/docs-2.0/nebula-explorer/workflow/2.create-workflow.md @@ -12,7 +12,7 @@ 以 MATCH 语句`MATCH (v1:player)--(v2) RETURN id(v1), id(v2);`的结果做为 PageRank 算法的输入，介绍如何创建一个简单的工作流。 -1. 在 Explorer 页面顶部的导航栏中，单击 **Workflow**。 +1. 在{{explorer.name}}页面顶部的导航栏中，单击 **Workflow**。 2. 在**工作流**标签页单击**新建工作流**，进入流程画布页面。 diff --git a/docs-2.0/nebula-explorer/workflow/3.workflow-management.md b/docs-2.0/nebula-explorer/workflow/3.workflow-management.md index 895937fbe1f..305b663d890 100644 --- a/docs-2.0/nebula-explorer/workflow/3.workflow-management.md +++ b/docs-2.0/nebula-explorer/workflow/3.workflow-management.md @@ -4,7 +4,7 @@ ## 操作步骤 -1. 在 Explorer 页面顶部的导航栏中，单击 **Workflow**。 +1. 在{{explorer.name}}页面顶部的导航栏中，单击 **Workflow**。 2. 在**工作流**标签页可以查看所有已保存的工作流，页面显示工作流名称、创建时间、最近一次修改时间、包含的图算法。 diff --git a/docs-2.0/nebula-explorer/workflow/4.jobs-management.md b/docs-2.0/nebula-explorer/workflow/4.jobs-management.md index 3e9583033f6..c92d983a14d 100644 --- a/docs-2.0/nebula-explorer/workflow/4.jobs-management.md +++ b/docs-2.0/nebula-explorer/workflow/4.jobs-management.md @@ -4,7 +4,7 @@ ## 操作步骤 -1. 在 Explorer 页面顶部的导航栏中，单击 **Workflow**。 +1. 在{{explorer.name}}页面顶部的导航栏中，单击 **Workflow**。 2. 在**作业**标签页可以查看所有执行的作业，页面显示作业 ID、作业名称、状态、创建时间、结束时间、工作流版本。 @@ -16,7 +16,7 @@ - 在列表的**操作**列，可以执行如下操作： - - **在Explorer中打开**：对于执行成功的作业，可以选择图空间和组件，查看组件的输出结果。支持将结果导出为 CSV 文件。 + - **在{{explorer.name}}中打开**：对于执行成功的作业，可以选择图空间和组件，查看组件的输出结果。支持将结果导出为 CSV 文件。 - **重跑**：对于执行失败的作业，可以重跑该作业。 diff --git a/docs-2.0/nebula-explorer/workflow/workflow-api/workflow-api-overview.md b/docs-2.0/nebula-explorer/workflow/workflow-api/workflow-api-overview.md index 9e3d4717323..dc36d0758dc 100644 --- a/docs-2.0/nebula-explorer/workflow/workflow-api/workflow-api-overview.md +++ b/docs-2.0/nebula-explorer/workflow/workflow-api/workflow-api-overview.md @@ -1,6 +1,6 @@ # 工作流 API 概览 -NebulaGraph Explorer 提供 API 接口使用工作流的部分功能。 +{{explorer.name}}提供 API 接口使用工作流的部分功能。 当前支持的 API 接口如下： @@ -23,9 +23,9 @@ curl http://:/?{} - ``：curl 支持大量选项，工作流使用较多的是`-X`、`-H`、`-d`。关于选项的详细说明，参见 [curl 官方文档](https://curl.se/docs/manpage.html)。 -- ``：NebulaGraph Explorer 访问地址。 +- ``：{{explorer.name}}访问地址。 -- ``：NebulaGraph Explorer 访问端口。 +- ``：{{explorer.name}}访问端口。 - ``：API 的调用路径。例如`api-open/v1/jobs`。 @@ -42,8 +42,8 @@ curl -i -X POST -H "Content-Type: application/json" -H "Authorization: Bearer `：Base64 编码后的{{nebula.name}}账号和密码字符串。以用户名`root`、密码`123`为例，序列化后的字符串为`["root","123"]`，Base64 编码后为`WyJyb290IiwiMTIzIl0=`。 - ``：{{nebula.name}}访问地址。 - ``：{{nebula.name}}访问端口。 -- ``：NebulaGraph Explorer 访问地址。 -- ``：NebulaGraph Explorer 访问端口。 +- ``：{{explorer.name}}访问地址。 +- ``：{{explorer.name}}访问端口。 示例： diff --git a/docs-2.0/nebula-explorer/workflow/workflows.md b/docs-2.0/nebula-explorer/workflow/workflows.md index cce7e5b61e5..7ae32a773f0 100644 --- a/docs-2.0/nebula-explorer/workflow/workflows.md +++ b/docs-2.0/nebula-explorer/workflow/workflows.md @@ -1,14 +1,14 @@ # 工作流简介 -Nebula Explorer 支持用自定义工作流进行可视化的复杂图计算。 +{{explorer.name}}支持用自定义工作流进行可视化的复杂图计算。 ## 背景信息 -Nebula Explorer 提供多种**组件**（Component），包括图查询组件和图计算组件，用户可以基于编排调度工具 Dag Controller 自由组合这些组件，例如将图查询组件的输出作为图计算组件的输入，最终形成一个有向无环的**工作流**（Workflow）。 +{{explorer.name}}提供多种**组件**（Component），包括图查询组件和图计算组件，用户可以基于编排调度工具 Dag Controller 自由组合这些组件，例如将图查询组件的输出作为图计算组件的输入，最终形成一个有向无环的**工作流**（Workflow）。 ![workflow-example](https://docs-cdn.nebula-graph.com.cn/figures/ex-workflow-example-220621.png) -需要进行图计算时再将工作流实例化，组件实例化后称为**任务**（Task），工作流实例化后称为**作业**（Job）。一个作业可以由多个任务构成。Explorer 将作业发送给{{plato.name}}进行图计算，完成后可以在作业列表查看对应的图计算结果。 +需要进行图计算时再将工作流实例化，组件实例化后称为**任务**（Task），工作流实例化后称为**作业**（Job）。一个作业可以由多个任务构成。{{explorer.name}}将作业发送给{{plato.name}}进行图计算，完成后可以在作业列表查看对应的图计算结果。 ## 功能说明 @@ -21,7 +21,7 @@ Nebula Explorer 提供多种**组件**（Component），包括图查询组件和 - 需要在 ![setting](https://docs-cdn.nebula-graph.com.cn/figures/navbar-setting-0105.png) 里开启工作流才能显示 Workflow 页面。 -- 使用工作流需要额外部署 Dag Controller 和{{plato.name}}。详情参见[{{plato.name}}](../..//graph-computing/nebula-analytics.md)和[部署 Explorer](../deploy-connect/ex-ug-deploy.md)。 +- 使用工作流需要额外部署 Dag Controller 和{{plato.name}}。详情参见[{{plato.name}}](../..//graph-computing/nebula-analytics.md)和[部署{{explorer.name}}](../deploy-connect/ex-ug-deploy.md)。 - 图查询组件的输入只能是查询语言。 diff --git a/docs-2.0/nebula-operator/10.backup-restore-using-operator.md b/docs-2.0/nebula-operator/10.backup-restore-using-operator.md index c02d952dcb6..9e1cdc86f50 100644 --- a/docs-2.0/nebula-operator/10.backup-restore-using-operator.md +++ b/docs-2.0/nebula-operator/10.backup-restore-using-operator.md @@ -8,7 +8,7 @@ ## 原理介绍 -[NebulaGraph BR（企业版）](../backup-and-restore/nebula-br-ent/1.br-ent-overview.md)工具是{{nebula.name}}企业版数据备份和恢复的命令行工具。NebulaGraph Operator 基于 BR 工具来实现 Kubernetes 上的{{nebula.name}}集群数据的备份和恢复。 +[{{br_ent.name}}](../backup-and-restore/nebula-br-ent/1.br-ent-overview.md)工具是{{nebula.name}}企业版数据备份和恢复的命令行工具。NebulaGraph Operator 基于{{br_ent.name}}工具来实现 Kubernetes 上的{{nebula.name}}集群数据的备份和恢复。 备份数据时，NebulaGraph Operator 会创建一个 Job，然后将{{nebula.name}}集群中的数据备份到指定的存储服务上。 @@ -120,7 +120,7 @@ spec: | ------------- | ---- | ---- | | `spec.parallelism` |1 |并行执行的任务数。 | | `spec.ttlSecondsAfterFinished` | 60 | 在任务完成后，保留任务信息的时间。 | -| `spec.template.spec.containers[0].image` | `vesoft/br-ent:{{br_ent.release}}`|NebulaGraph BR 企业版工具的镜像地址。 | +| `spec.template.spec.containers[0].image` | `vesoft/br-ent:{{br_ent.release}}`|{{br_ent.name}}工具的镜像地址。 | | `spec.template.spec.containers[0].command`| - | 备份数据至兼容 S3 协议存储服务的命令。
有关命令中选项的描述，参见[参数说明](../backup-and-restore/nebula-br-ent/3.backup-data.md#_12)。 | diff --git a/docs-2.0/reuse/source_create_instance_aliyun.md b/docs-2.0/reuse/source_create_instance_aliyun.md index 3fe996bfd57..29c9bd861a4 100644 --- a/docs-2.0/reuse/source_create_instance_aliyun.md +++ b/docs-2.0/reuse/source_create_instance_aliyun.md @@ -43,8 +43,8 @@ NebulaGraph Cloud 阿里云版支持如下套餐版本。 | 套餐版本 | 说明 | | - | - | | 基础版 | 将所有{{nebula.name}}服务节点部署在 1 台 ECS 服务器上。 | -| 标准版 | 将 Graph 服务和 Storage 服务分别部署在不同的 ECS 服务器上，每个服务都是单节点（1 台 ECS）。将 Explorer 等生态工具混合部署在 1 台 ECS 服务器上。 | -| 高可用版 | 将 Graph 服务和 Storage 服务分别部署在不同的 ECS 服务器上，每个服务都包含 3 节点（3 台 ECS）。将 Explorer 等生态工具混合部署在 1 台 ECS 服务器上。 | +| 标准版 | 将 Graph 服务和 Storage 服务分别部署在不同的 ECS 服务器上，每个服务都是单节点（1 台 ECS）。将{{explorer.name}}等生态工具混合部署在 1 台 ECS 服务器上。 | +| 高可用版 | 将 Graph 服务和 Storage 服务分别部署在不同的 ECS 服务器上，每个服务都包含 3 节点（3 台 ECS）。将{{explorer.name}}等生态工具混合部署在 1 台 ECS 服务器上。 | 付费版和免费试用版服务实例支持的套餐版本有所不同，详情参见创建实例页面。 diff --git a/docs-2.0/reuse/source_manage-service.md b/docs-2.0/reuse/source_manage-service.md index efafa2c08ec..a308b5442c9 100644 --- a/docs-2.0/reuse/source_manage-service.md +++ b/docs-2.0/reuse/source_manage-service.md @@ -51,7 +51,7 @@ $ sudo /usr/local/nebula/scripts/nebula.service - 安装{{nebula.name}}企业版后，systemd 所需的`.service`文件在安装目录的`etc/unit`目录内，使用 RPM/DEB 包安装的 NebulaGraph，会自动将这些`.service`文件放入`/usr/lib/systemd/system`目录内，并且`ExecStart`也会根据指定的{{nebula.name}}安装路径进行生成，因此可以直接使用`systemctl`命令。 - - 对于使用企业版 Dashboard 安装的企业版 NebulaGraph，不支持使用`systemctl`管理服务。 + - 对于使用{{dashboard_ent.name}}安装的{{nebula.name}}，不支持使用`systemctl`管理服务。 - 对于其他方式安装的企业版 NebulaGraph，需要用户手动将`.service`文件移动到`/usr/lib/systemd/system`目录内，并修改`.service`文件内的`ExecStart`的文件路径，才可以正常使用`systemctl`命令。 diff --git a/mkdocs.yml b/mkdocs.yml index b853c9e492f..d7b9c4cf5ee 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -253,6 +253,12 @@ extra: release: 3.4.2 tag: v3.4.2 branch: release-3.4 + # nav.ent.begin + name: 悦数运维监控 + # nav.ent.end + # nav.comm.begin + name: NebulaGraph Dashboard + # nav.comm.end console: release: 3.4.0 branch: release-3.4 @@ -264,6 +270,12 @@ extra: br_ent: release: 3.4.1 tag: v3.4.1 + # nav.ent.begin + name: 悦数备份&恢复 + # nav.ent.end + # nav.comm.begin + name: NebulaGraph Backup&Restore + # nav.comm.end agent: release: 3.4.0 tag: v3.4.0 @@ -305,6 +317,12 @@ extra: release: 3.4.0 branch: release-3.4 tag: v3.4.0 + # nav.ent.begin + name: 悦数黑匣子 + # nav.ent.end + # nav.comm.begin + name: NebulaGraph BlackBox + # nav.comm.end cloud: azureRelease: 3.1.1 # Azure云兼容的最新内核版本 aliyunRelease: 3.4.0 # 阿里云兼容的最新内核版本 @@ -558,8 +576,8 @@ nav: - 查询监控指标: 6.monitor-and-metrics/1.query-performance-metrics.md - RocksDB 统计数据: 6.monitor-and-metrics/2.rocksdb-statistics.md # nav.ent.begin - - 黑匣子: - - 黑匣子介绍: 6.monitor-and-metrics/3.bbox/3.1.bbox.md + - 悦数黑匣子: + - 悦数黑匣子介绍: 6.monitor-and-metrics/3.bbox/3.1.bbox.md - Nebula-BBox 工具: 6.monitor-and-metrics/3.bbox/3.2.bbox-reviewer.md # nav.ent.end @@ -582,11 +600,11 @@ nav: - 使用 BR 恢复数据: backup-and-restore/nebula-br/4.br-restore-data.md # nav.comm.end # nav.ent.begin - - NebulaGraph BR（企业版）: - - BR（企业版）概述: backup-and-restore/nebula-br-ent/1.br-ent-overview.md - - 安装 BR: backup-and-restore/nebula-br-ent/2.install-tools.md - - 使用 BR 备份数据: backup-and-restore/nebula-br-ent/3.backup-data.md - - 使用 BR 恢复数据: backup-and-restore/nebula-br-ent/4.restore-data.md + - 悦数备份&恢复: + - 悦数备份&恢复概述: backup-and-restore/nebula-br-ent/1.br-ent-overview.md + - 安装: backup-and-restore/nebula-br-ent/2.install-tools.md + - 备份数据: backup-and-restore/nebula-br-ent/3.backup-data.md + - 恢复数据: backup-and-restore/nebula-br-ent/4.restore-data.md # nav.ent.end - 快照: backup-and-restore/3.manage-snapshot.md @@ -674,11 +692,11 @@ nav: # nav.comm.end # nav.ent.begin - - NebulaGraph Dashboard（企业版）: - - 什么是 NebulaGraph Dashboard 企业版: nebula-dashboard-ent/1.what-is-dashboard-ent.md - - 部署 NebulaGraph Dashboard 企业版: nebula-dashboard-ent/2.deploy-connect-dashboard-ent.md - - 连接 Dashboard: nebula-dashboard-ent/3.connect-dashboard.md - - NebulaGraph Dashboard 企业版 License: nebula-dashboard-ent/11.dashboard-ent-license.md + - 悦数运维监控: + - 什么是悦数运维监控: nebula-dashboard-ent/1.what-is-dashboard-ent.md + - 部署悦数运维监控: nebula-dashboard-ent/2.deploy-connect-dashboard-ent.md + - 连接悦数运维监控: nebula-dashboard-ent/3.connect-dashboard.md + - 悦数运维监控 License: nebula-dashboard-ent/11.dashboard-ent-license.md - 创建及导入集群: - 创建集群: nebula-dashboard-ent/3.create-import-dashboard/1.create-cluster.md - 导入集群: nebula-dashboard-ent/3.create-import-dashboard/2.import-cluster.md @@ -717,12 +735,12 @@ nav: # nav.ent.end # nav.ent.begin - - NebulaGraph Explorer: - - 什么是 NebulaGraph Explorer: nebula-explorer/about-explorer/ex-ug-what-is-explorer.md + - 悦数图探索: + - 什么是悦数图探索: nebula-explorer/about-explorer/ex-ug-what-is-explorer.md - 安装与登录: - - 部署 Explorer: nebula-explorer/deploy-connect/ex-ug-deploy.md + - 部署悦数图探索: nebula-explorer/deploy-connect/ex-ug-deploy.md - 连接数据库: nebula-explorer/deploy-connect/ex-ug-connect.md - - NebulaGraph Explorer License（企业版）: nebula-explorer/deploy-connect/3.explorer-license.md + - 悦数图探索 License: nebula-explorer/deploy-connect/3.explorer-license.md - 页面概览: nebula-explorer/ex-ug-page-overview.md - 数据库管理: - Schema 草图: nebula-explorer/db-management/draft.md @@ -841,13 +859,8 @@ nav: # nav.ent.begin - 悦数图计算: graph-computing/nebula-analytics.md - 悦数图计算 License: graph-computing/analytics-ent-license.md + - 悦数图探索工作流: graph-computing/use-explorer.md # nav.ent.end -# nav.comm.begin - - NebulaGraph Analytics: graph-computing/nebula-analytics.md - - NebulaGraph Analytics License: graph-computing/analytics-ent-license.md -# nav.comm.end - - NebulaGraph Explorer 工作流: graph-computing/use-explorer.md - - NebulaGraph Spark Connector: nebula-spark-connector.md - NebulaGraph Flink Connector: nebula-flink-connector.md @@ -869,10 +882,10 @@ nav: - NebulaGraph Dashboard 社区版: 20.appendix/release-notes/dashboard-comm-release-note.md # nav.comm.end # nav.ent.begin - - NebulaGraph Dashboard 企业版: 20.appendix/release-notes/dashboard-ent-release-note.md + - 悦数运维监控: 20.appendix/release-notes/dashboard-ent-release-note.md # nav.ent.end # nav.ent.begin - - NebulaGraph Explorer: 20.appendix/release-notes/explorer-release-note.md + - 悦数图探索: 20.appendix/release-notes/explorer-release-note.md # nav.ent.end - 学习路径: 20.appendix/learning-path.md # nav.ent.begin