From bb68ce6c8f3590624d2f6c873fd9b1d6cd8086e8 Mon Sep 17 00:00:00 2001 From: "abby.huang" <78209557+abby-cyber@users.noreply.github.com> Date: Wed, 24 Nov 2021 17:12:13 +0800 Subject: [PATCH] whitespace before link error fix (#1258) --- .../1.introduction/1.what-is-nebula-graph.md | 8 +++---- docs-2.0/1.introduction/2.1.path.md | 2 +- .../2.meta-service.md | 4 ++-- .../4.storage-service.md | 10 ++++----- docs-2.0/1.introduction/3.vid.md | 2 +- docs-2.0/14.client/3.nebula-cpp-client.md | 4 ++-- docs-2.0/14.client/4.nebula-java-client.md | 2 +- docs-2.0/15.contribution/how-to-contribute.md | 6 ++--- .../2.quick-start/1.quick-start-workflow.md | 2 +- docs-2.0/2.quick-start/4.nebula-graph-crud.md | 14 ++++++------ docs-2.0/20.appendix/0.FAQ.md | 20 ++++++++--------- docs-2.0/20.appendix/6.eco-tool-version.md | 22 +++++++++---------- docs-2.0/20.appendix/mind-map.md | 4 ++-- docs-2.0/20.appendix/write-tools.md | 2 +- .../1.nGQL-overview/1.overview.md | 4 ++-- .../10.tag-statements/1.create-tag.md | 8 +++---- .../10.tag-statements/2.drop-tag.md | 2 +- .../10.tag-statements/3.alter-tag.md | 4 ++-- .../10.tag-statements/4.show-tags.md | 2 +- .../10.tag-statements/5.describe-tag.md | 2 +- .../10.tag-statements/6.delete-tag.md | 2 +- .../11.edge-type-statements/1.create-edge.md | 6 ++--- .../11.edge-type-statements/2.drop-edge.md | 2 +- .../11.edge-type-statements/3.alter-edge.md | 4 ++-- .../11.edge-type-statements/4.show-edges.md | 2 +- .../5.describe-edge.md | 2 +- .../12.vertex-statements/1.insert-vertex.md | 2 +- .../12.vertex-statements/4.delete-vertex.md | 2 +- .../13.edge-statements/4.delete-edge.md | 2 +- .../1.create-native-index.md | 6 ++--- .../14.native-index-statements/README.md | 4 ++-- .../1.search-with-text-based-index.md | 4 ++-- .../16.subgraph-and-path/1.get-subgraph.md | 2 +- .../16.subgraph-and-path/2.find-path.md | 2 +- .../.1.configs-syntax.md | 4 ++-- .../4.job-statements.md | 2 +- .../3.ngql-guide/3.data-types/10.geography.md | 2 +- .../3.data-types/4.date-and-time.md | 2 +- docs-2.0/3.ngql-guide/3.data-types/6.list.md | 2 +- .../2.user-defined-variables.md | 2 +- .../3.ngql-guide/5.operators/2.boolean.md | 2 +- .../5.operators/5.property-reference.md | 6 ++--- docs-2.0/3.ngql-guide/5.operators/6.set.md | 4 ++-- .../6.functions-and-expressions/14.geo.md | 2 +- .../6.functions-and-expressions/2.string.md | 2 +- .../7.general-query-statements/2.match.md | 6 ++--- .../7.general-query-statements/3.go.md | 4 ++-- .../7.general-query-statements/4.fetch.md | 2 +- .../7.general-query-statements/5.lookup.md | 2 +- .../6.show/10.show-roles.md | 2 +- .../6.show/11.show-snapshots.md | 2 +- .../6.show/18.show-queries.md | 2 +- .../8.clauses-and-options/group-by.md | 2 +- .../8.clauses-and-options/ttl-options.md | 2 +- .../8.clauses-and-options/where.md | 4 ++-- .../8.clauses-and-options/with.md | 2 +- .../8.clauses-and-options/yield.md | 4 ++-- .../9.space-statements/1.create-space.md | 8 +++---- .../9.space-statements/2.use-space.md | 2 +- .../9.space-statements/5.drop-space.md | 2 +- .../1.resource-preparations.md | 10 ++++----- ...bula-graph-by-compiling-the-source-code.md | 4 ++-- ...deploy-nebula-graph-with-docker-compose.md | 8 +++---- .../4.install-nebula-graph-from-tar.md | 2 +- .../deploy-nebula-graph-cluster.md | 2 +- .../upgrade-nebula-from-200-to-latest.md | 10 ++++----- .../upgrade-nebula-graph-to-latest.md | 8 +++---- .../4.uninstall-nebula-graph.md | 2 +- .../6.deploy-text-based-index/2.deploy-es.md | 4 ++-- .../3.deploy-listener.md | 12 +++++----- .../deploy-license.md | 4 ++-- .../1.configurations/1.configurations.md | 2 +- .../1.configurations/2.meta-config.md | 4 ++-- .../1.configurations/3.graph-config.md | 6 ++--- .../1.configurations/4.storage-config.md | 6 ++--- .../2.log-management/logs.md | 6 ++--- .../1.authentication/1.authentication.md | 4 ++-- .../1.authentication/2.management-user.md | 6 ++--- .../1.authentication/3.role-list.md | 4 ++-- .../2.backup-restore/3.br-backup-data.md | 6 ++--- .../2.backup-restore/4.br-restore-data.md | 2 +- docs-2.0/7.data-security/3.manage-snapshot.md | 6 ++--- docs-2.0/7.data-security/4.ssl.md | 2 +- docs-2.0/8.service-tuning/2.graph-modeling.md | 4 ++-- docs-2.0/8.service-tuning/3.system-design.md | 2 +- docs-2.0/8.service-tuning/compaction.md | 2 +- docs-2.0/8.service-tuning/load-balance.md | 2 +- docs-2.0/8.service-tuning/practice.md | 2 +- docs-2.0/8.service-tuning/super-node.md | 4 ++-- docs-2.0/nebula-algorithm.md | 4 ++-- .../1.what-is-dashboard-ent.md | 2 +- .../2.deploy-connect-dashboard-ent.md | 4 ++-- .../1.create-cluster.md | 2 +- .../2.import-cluster.md | 2 +- .../4.cluster-operator/2.monitor.md | 4 ++-- .../3.cluster-information.md | 4 ++-- .../4.cluster-operator/4.manage.md | 6 ++--- docs-2.0/nebula-dashboard-ent/8.faq.md | 2 +- .../nebula-dashboard/1.what-is-dashboard.md | 4 ++-- .../nebula-dashboard/3.connect-dashboard.md | 4 ++-- docs-2.0/nebula-dashboard/4.use-dashboard.md | 8 +++---- .../about-exchange/ex-ug-what-is-exchange.md | 4 ++-- docs-2.0/nebula-exchange/ex-ug-FAQ.md | 4 ++-- docs-2.0/nebula-exchange/ex-ug-compile.md | 4 ++-- .../parameter-reference/ex-ug-parameter.md | 6 ++--- .../ex-ug-import-from-clickhouse.md | 12 +++++----- .../use-exchange/ex-ug-import-from-csv.md | 12 +++++----- .../use-exchange/ex-ug-import-from-hbase.md | 12 +++++----- .../use-exchange/ex-ug-import-from-hive.md | 12 +++++----- .../use-exchange/ex-ug-import-from-json.md | 12 +++++----- .../use-exchange/ex-ug-import-from-kafka.md | 12 +++++----- .../ex-ug-import-from-maxcompute.md | 12 +++++----- .../use-exchange/ex-ug-import-from-mysql.md | 12 +++++----- .../use-exchange/ex-ug-import-from-neo4j.md | 12 +++++----- .../use-exchange/ex-ug-import-from-orc.md | 12 +++++----- .../use-exchange/ex-ug-import-from-parquet.md | 12 +++++----- .../use-exchange/ex-ug-import-from-pulsar.md | 12 +++++----- .../use-exchange/ex-ug-import-from-sst.md | 14 ++++++------ .../deploy-connect/ex-ug-connect.md | 2 +- .../deploy-connect/ex-ug-deploy.md | 6 ++--- .../operation-guide/ex-ug-canvas.md | 2 +- .../operation-guide/ex-ug-page-overview.md | 6 ++--- docs-2.0/nebula-importer/use-importer.md | 8 +++---- .../1.introduction-to-nebula-operator.md | 8 +++---- .../2.deploy-nebula-operator.md | 6 ++--- .../4.connect-to-nebula-graph-service.md | 2 +- .../nebula-operator/5.operator-failover.md | 2 +- .../6.get-started-with-operator.md | 2 +- .../8.1.custom-conf-parameter.md | 4 ++-- .../8.2.pv-reclaim.md | 2 +- .../8.3.balance-data-when-scaling-storage.md | 2 +- .../9.upgrade-nebula-cluster.md | 4 ++-- docs-2.0/nebula-spark-connector.md | 4 ++-- .../about-studio/st-ug-limitations.md | 2 +- .../st-ug-what-is-graph-studio.md | 4 ++-- .../deploy-connect/st-ug-connect.md | 4 ++-- .../deploy-connect/st-ug-deploy-by-helm.md | 2 +- .../deploy-connect/st-ug-deploy.md | 2 +- .../manage-schema/st-ug-crud-edge-type.md | 4 ++-- .../manage-schema/st-ug-crud-index.md | 2 +- .../manage-schema/st-ug-crud-space.md | 6 ++--- .../manage-schema/st-ug-crud-tag.md | 4 ++-- .../quick-start/st-ug-create-schema.md | 6 ++--- .../quick-start/st-ug-import-data.md | 4 ++-- .../st-ug-config-server-errors.md | 6 ++--- .../st-ug-connection-errors.md | 2 +- .../troubleshooting/st-ug-faq.md | 4 ++-- .../use-console/st-ug-console.md | 2 +- .../use-console/st-ug-open-in-explore.md | 6 ++--- .../use-console/st-ug-visualize-subgraph.md | 6 ++--- .../reuse/source_connect-to-nebula-graph.md | 6 ++--- ...urce_install-nebula-graph-by-rpm-or-deb.md | 2 +- .../reader/sc-ug-reader-example.md | 2 +- .../writer/sc-ug-writer-example.md | 2 +- 154 files changed, 369 insertions(+), 369 deletions(-) diff --git a/docs-2.0/1.introduction/1.what-is-nebula-graph.md b/docs-2.0/1.introduction/1.what-is-nebula-graph.md index 8765899e26..209622c54a 100644 --- a/docs-2.0/1.introduction/1.what-is-nebula-graph.md +++ b/docs-2.0/1.introduction/1.what-is-nebula-graph.md @@ -34,11 +34,11 @@ Nebula Graph 提供 Java、Python、C++和 Go 等流行编程语言的客户端 ### 高可靠访问控制 -Nebula Graph 支持严格的角色访问控制和 LDAP（Lightweight Directory Access Protocol）等外部认证服务，能够有效提高数据安全性。详情请参见 [验证和授权](../7.data-security/1.authentication/1.authentication.md)。 +Nebula Graph 支持严格的角色访问控制和 LDAP（Lightweight Directory Access Protocol）等外部认证服务，能够有效提高数据安全性。详情请参见[验证和授权](../7.data-security/1.authentication/1.authentication.md)。 ### 生态多样化 -Nebula Graph 开放了越来越多的原生工具，例如 [Nebula Graph Studio](https://github.com/vesoft-inc/nebula-studio)、[Nebula Console](https://github.com/vesoft-inc/nebula-console)、[Nebula Exchange](https://github.com/vesoft-inc/nebula-exchange) 等，更多工具可以查看 [生态工具概览](../20.appendix/6.eco-tool-version.md)。 +Nebula Graph 开放了越来越多的原生工具，例如 [Nebula Graph Studio](https://github.com/vesoft-inc/nebula-studio)、[Nebula Console](https://github.com/vesoft-inc/nebula-console)、[Nebula Exchange](https://github.com/vesoft-inc/nebula-exchange) 等，更多工具可以查看[生态工具概览](../20.appendix/6.eco-tool-version.md)。 此外，Nebula Graph 还具备与 Spark、Flink、HBase 等产品整合的能力，在这个充满挑战与机遇的时代，大大增强了自身的竞争力。 @@ -48,12 +48,12 @@ Nebula Graph 查询语言，简称为 nGQL，是一种声明性的、部分兼 ### 面向未来硬件，读写平衡 -闪存型设备有着极高的性能，并且 [价格快速下降](https://blocksandfiles.com/wp-content/uploads/2021/01/Wikibon-SSD-less-than-HDD-in-2026.jpg)， +闪存型设备有着极高的性能，并且[价格快速下降](https://blocksandfiles.com/wp-content/uploads/2021/01/Wikibon-SSD-less-than-HDD-in-2026.jpg)， Nebula Graph 是一个面向 SSD 设计的产品，相比于基于 HDD + 大内存的产品，更适合面向未来的硬件趋势，也更容易做到读写平衡。 ### 灵活数据建模 -用户可以轻松地在 Nebula Graph 中建立数据模型，不必将数据强制转换为关系表。而且可以自由增加、更新和删除属性。详情请参见 [数据模型](2.data-model.md)。 +用户可以轻松地在 Nebula Graph 中建立数据模型，不必将数据强制转换为关系表。而且可以自由增加、更新和删除属性。详情请参见[数据模型](2.data-model.md)。 ### 广受欢迎 diff --git a/docs-2.0/1.introduction/2.1.path.md b/docs-2.0/1.introduction/2.1.path.md index d35c07a373..a5a10b1619 100644 --- a/docs-2.0/1.introduction/2.1.path.md +++ b/docs-2.0/1.introduction/2.1.path.md @@ -2,7 +2,7 @@ 图论中一个非常重要的概念是路径，路径是指一个有限或无限的边序列，这些边连接着一系列点。 -路径的类型分为三种：`walk`、`trail`、`path`。关于路径的详细说明，请参见 [维基百科](https://en.wikipedia.org/wiki/Path_(graph_theory)#Walk,_trail,_path)。 +路径的类型分为三种：`walk`、`trail`、`path`。关于路径的详细说明，请参见[维基百科](https://en.wikipedia.org/wiki/Path_(graph_theory)#Walk,_trail,_path)。 本文以下图为例进行简单介绍。 diff --git a/docs-2.0/1.introduction/3.nebula-graph-architecture/2.meta-service.md b/docs-2.0/1.introduction/3.nebula-graph-architecture/2.meta-service.md index 75d9af561e..0b98c7c726 100644 --- a/docs-2.0/1.introduction/3.nebula-graph-architecture/2.meta-service.md +++ b/docs-2.0/1.introduction/3.nebula-graph-architecture/2.meta-service.md @@ -25,7 +25,7 @@ leader 是由多数派选举出来，只有 leader 能够对客户端或其他 Meta 服务中存储了用户的账号和权限信息，当客户端通过账号发送请求给 Meta 服务，Meta 服务会检查账号信息，以及该账号是否有对应的请求权限。 -更多 Nebula Graph 的访问控制说明，请参见 [身份验证](../../7.data-security/1.authentication/1.authentication.md)。 +更多 Nebula Graph 的访问控制说明，请参见[身份验证](../../7.data-security/1.authentication/1.authentication.md)。 ### 管理分片 @@ -41,7 +41,7 @@ Nebula Graph 是强类型图数据库，它的 Schema 包括 Tag、Edge type、T Meta 服务中存储了 Schema 信息，同时还负责 Schema 的添加、修改和删除，并记录它们的版本。 -更多 Nebula Graph 的 Schema 信息，请参见 [数据模型](../2.data-model.md)。 +更多 Nebula Graph 的 Schema 信息，请参见[数据模型](../2.data-model.md)。 ### 管理 TTL 信息 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 caceadd81a..c0d37f1ae2 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 @@ -14,7 +14,7 @@ Nebula Graph 的存储包含两个部分，一个是 Meta 相关的存储，称 - 高可用性（Raft） -- 支持向第三方系统进行同步（例如 [全文索引](../../4.deployment-and-installation/6.deploy-text-based-index/2.deploy-es.md)） +- 支持向第三方系统进行同步（例如[全文索引](../../4.deployment-and-installation/6.deploy-text-based-index/2.deploy-es.md)） ## Storage 服务架构 @@ -26,7 +26,7 @@ Storage 服务是由 nebula-storaged 进程提供的，用户可以根据场景 - Storage interface 层 - Storage 服务的最上层，定义了一系列和图相关的 API。API 请求会在这一层被翻译成一组针对 [分片](#数据分片)的 KV 操作，例如： + Storage 服务的最上层，定义了一系列和图相关的 API。API 请求会在这一层被翻译成一组针对[分片](#数据分片)的 KV 操作，例如： - `getNeighbors`：查询一批点的出边或者入边，返回边以及对应的属性，并且支持条件过滤。 @@ -154,7 +154,7 @@ EdgeA_Out 和 EdgeA_In 以方向相反的两条边的形式存在于存储层， 点和边分布在不同的分片，分片分布在不同的机器。分片数量在 CREATE SPACE 语句中指定，此后不可更改。 -如果需要将某些点放置在相同的分片（例如在一台机器上），可以参考 [公式或代码](https://github.com/vesoft-inc/nebula-common/blob/master/src/common/clients/meta/MetaClient.cpp)。 +如果需要将某些点放置在相同的分片（例如在一台机器上），可以参考[公式或代码](https://github.com/vesoft-inc/nebula-common/blob/master/src/common/clients/meta/MetaClient.cpp)。 下文用简单代码说明 VID 和分片的关系。 @@ -239,12 +239,12 @@ Listener 角色的存在主要是为了应对**扩容**，扩容时新增的机 新增 Listener 角色后，会写入 command 类型的 WAL，leader 在写 WAL 时如果发现有`add learner`的 command，会将 learner 加入自己的 peers，并将它标记为 Listener，在统计多数派的时候，不会算上 Listener，但是日志还是会照常发送给它们，Listener 本身也不会主动发起选举。 -Raft listener 进程还可以从 Leader 获取数据后，然后将它们写入 Elasticsearch 集群，以便实现全文搜索。详情请参见 [部署 Raft Listener](../../4.deployment-and-installation/6.deploy-text-based-index/3.deploy-listener.md)。 +Raft listener 进程还可以从 Leader 获取数据后，然后将它们写入 Elasticsearch 集群，以便实现全文搜索。详情请参见[部署 Raft Listener](../../4.deployment-and-installation/6.deploy-text-based-index/3.deploy-listener.md)。 --> ### leader 切换（Transfer Leadership） -leader 切换对于负载均衡至关重要，当把某个分片从一台机器迁移到另一台机器时，首先会检查分片是不是 leader，如果是的话，需要先切换 leader，数据迁移完毕之后，通常还要重新 [均衡 leader 分布](../../8.service-tuning/load-balance.md)。 +leader 切换对于负载均衡至关重要，当把某个分片从一台机器迁移到另一台机器时，首先会检查分片是不是 leader，如果是的话，需要先切换 leader，数据迁移完毕之后，通常还要重新[均衡 leader 分布](../../8.service-tuning/load-balance.md)。 对于 leader 来说，提交 leader 切换命令时，就会放弃自己的 leader 身份，当 follower 收到 leader 切换命令时，就会发起选举。 diff --git a/docs-2.0/1.introduction/3.vid.md b/docs-2.0/1.introduction/3.vid.md index 1a9e4c1dc5..5d65304006 100644 --- a/docs-2.0/1.introduction/3.vid.md +++ b/docs-2.0/1.introduction/3.vid.md @@ -46,7 +46,7 @@ VID 的生成工作完全交给应用端，有一些通用的建议： ## 定义和修改 VID 的数据类型 -VID 的数据类型必须在 [创建图空间](../3.ngql-guide/9.space-statements/1.create-space.md) 时定义，且一旦定义无法修改。 +VID 的数据类型必须在[创建图空间](../3.ngql-guide/9.space-statements/1.create-space.md) 时定义，且一旦定义无法修改。 ## "查询起始点"(`start vid`) 与全局扫描 diff --git a/docs-2.0/14.client/3.nebula-cpp-client.md b/docs-2.0/14.client/3.nebula-cpp-client.md index 1ba38bfd5c..5d17e65109 100644 --- a/docs-2.0/14.client/3.nebula-cpp-client.md +++ b/docs-2.0/14.client/3.nebula-cpp-client.md @@ -6,7 +6,7 @@ - 已安装 C++，GCC 版本为 4.8 及以上。 -- 编译安装需要准备正确的编译环境，详情请参见 [软硬件要求和安装三方库依赖包](../4.deployment-and-installation/1.resource-preparations.md)。 +- 编译安装需要准备正确的编译环境，详情请参见[软硬件要求和安装三方库依赖包](../4.deployment-and-installation/1.resource-preparations.md)。 ## 版本对照表 @@ -82,7 +82,7 @@ 将 CPP 文件编译为可执行文件即可。接下来以`SessionExample.cpp`为例，介绍如何操作。 -1. 使用 [示例代码](https://github.com/vesoft-inc/nebula-cpp/blob/master/examples/SessionExample.cpp) 创建`SessionExample.cpp`文件。 +1. 使用[示例代码](https://github.com/vesoft-inc/nebula-cpp/blob/master/examples/SessionExample.cpp) 创建`SessionExample.cpp`文件。 2. 编译文件，命令如下： diff --git a/docs-2.0/14.client/4.nebula-java-client.md b/docs-2.0/14.client/4.nebula-java-client.md index 662c0c4bc1..42fdaea988 100644 --- a/docs-2.0/14.client/4.nebula-java-client.md +++ b/docs-2.0/14.client/4.nebula-java-client.md @@ -60,7 +60,7 @@ ``` -如果没有 Maven 管理项目，请手动 [下载 JAR 包](https://repo1.maven.org/maven2/com/vesoft/) 进行安装。 +如果没有 Maven 管理项目，请手动[下载 JAR 包](https://repo1.maven.org/maven2/com/vesoft/) 进行安装。 ### 核心代码 diff --git a/docs-2.0/15.contribution/how-to-contribute.md b/docs-2.0/15.contribution/how-to-contribute.md index 757427511a..a03cee8683 100644 --- a/docs-2.0/15.contribution/how-to-contribute.md +++ b/docs-2.0/15.contribution/how-to-contribute.md @@ -4,7 +4,7 @@ ### github 或社区提交问题 -欢迎为项目贡献任何代码或文档，但是建议先在 [github](https://github.com/vesoft-inc/nebula) 或 [社区](https://discuss.nebula-graph.io/) 上提交一个问题，和大家共同讨论。 +欢迎为项目贡献任何代码或文档，但是建议先在 [github](https://github.com/vesoft-inc/nebula) 或[社区](https://discuss.nebula-graph.io/) 上提交一个问题，和大家共同讨论。 ### 签署贡献者许可协议（CLA） @@ -28,7 +28,7 @@ Nebula Graph 文档以 Markdown 语言编写。单击文档标题右侧的铅笔 ### Step 1：通过 GitHub fork 仓库 -Nebula Graph 项目有很多 [仓库](https://github.com/vesoft-inc)，以 [nebula-graph 仓库](https://github.com/vesoft-inc/nebula) 为例： +Nebula Graph 项目有很多[仓库](https://github.com/vesoft-inc)，以 [nebula-graph 仓库](https://github.com/vesoft-inc/nebula) 为例： 1. 访问 [https://github.com/vesoft-inc/nebula](https://github.com/vesoft-inc/nebula)。 @@ -132,7 +132,7 @@ Nebula Graph 项目有很多 [仓库](https://github.com/vesoft-inc)，以 [nebu - 构建代码时开启单元测试 - 详情请参见 [使用源码安装 Nebula Graph](../4.deployment-and-installation/2.compile-and-install-nebula-graph/1.install-nebula-graph-by-compiling-the-source-code.md)。 + 详情请参见[使用源码安装 Nebula Graph](../4.deployment-and-installation/2.compile-and-install-nebula-graph/1.install-nebula-graph-by-compiling-the-source-code.md)。 !!! Note diff --git a/docs-2.0/2.quick-start/1.quick-start-workflow.md b/docs-2.0/2.quick-start/1.quick-start-workflow.md index 59895b4a8f..f4db47ee89 100644 --- a/docs-2.0/2.quick-start/1.quick-start-workflow.md +++ b/docs-2.0/2.quick-start/1.quick-start-workflow.md @@ -8,7 +8,7 @@ 1. [安装 Nebula Graph](../4.deployment-and-installation/2.compile-and-install-nebula-graph/2.install-nebula-graph-by-rpm-or-deb.md) - 使用 RPM 或 DEB 文件可以快速安装 Nebula Graph。其它部署方式及相应的准备工作请参见 [安装部署](../4.deployment-and-installation/1.resource-preparations.md)。 + 使用 RPM 或 DEB 文件可以快速安装 Nebula Graph。其它部署方式及相应的准备工作请参见[安装部署](../4.deployment-and-installation/1.resource-preparations.md)。 2. [启动 Nebula Graph](5.start-stop-service.md) diff --git a/docs-2.0/2.quick-start/4.nebula-graph-crud.md b/docs-2.0/2.quick-start/4.nebula-graph-crud.md index 56f81284b5..e298d2af96 100644 --- a/docs-2.0/2.quick-start/4.nebula-graph-crud.md +++ b/docs-2.0/2.quick-start/4.nebula-graph-crud.md @@ -19,7 +19,7 @@ | 边（Edge） | 表示两个点之间**有方向**的关系。| | 边类型（Edge type） | 边的类型，定义了一组描述边的类型的属性。 | -更多信息，请参见 [数据结构](../1.introduction/2.data-model.md)。 +更多信息，请参见[数据结构](../1.introduction/2.data-model.md)。 本文将使用下图的数据集演示基础操作的语法。 @@ -61,7 +61,7 @@ nebula> SHOW HOSTS; !!! Note - 默认心跳周期是 10 秒。修改心跳周期参数`heartbeat_interval_secs`，请参见 [配置简介](../5.configurations-and-logs/1.configurations/1.configurations.md)。 + 默认心跳周期是 10 秒。修改心跳周期参数`heartbeat_interval_secs`，请参见[配置简介](../5.configurations-and-logs/1.configurations/1.configurations.md)。 为确保数据同步，后续操作能顺利进行，可采取以下方法之一： @@ -236,9 +236,9 @@ nebula> CREATE EDGE serve(start_year int, end_year int); - [FETCH](../3.ngql-guide/7.general-query-statements/4.fetch.md) 语句可以获得点或边的属性。 -- [LOOKUP](../3.ngql-guide/7.general-query-statements/5.lookup.md) 语句是基于 [索引](#_12) 的，和`WHERE`子句一起使用，查找符合特定条件的数据。 +- [LOOKUP](../3.ngql-guide/7.general-query-statements/5.lookup.md) 语句是基于[索引](#_12) 的，和`WHERE`子句一起使用，查找符合特定条件的数据。 -- [MATCH](../3ngql-guide/../3.ngql-guide/7.general-query-statements/2.match.md) 语句是查询图数据最常用的，可以灵活的描述各种图模式，但是它依赖 [索引](#_12) 去匹配 Nebula Graph 中的数据模型，性能也还需要调优。 +- [MATCH](../3ngql-guide/../3.ngql-guide/7.general-query-statements/2.match.md) 语句是查询图数据最常用的，可以灵活的描述各种图模式，但是它依赖[索引](#_12) 去匹配 Nebula Graph 中的数据模型，性能也还需要调优。 ### nGQL 语法 @@ -371,7 +371,7 @@ nebula> FETCH PROP ON player "player100"; !!! Note - `LOOKUP`和`MATCH`的示例在下文的 [索引](#_12) 部分查看。 + `LOOKUP`和`MATCH`的示例在下文的[索引](#_12) 部分查看。 ## 修改点和边 @@ -488,7 +488,7 @@ nebula> FETCH PROP ON player "player100"; `MATCH`和`LOOKUP`语句的执行都依赖索引，但是索引会导致写性能大幅降低（降低 90%甚至更多）。请**不要随意**在生产环境中使用索引，除非很清楚使用索引对业务的影响。 - **必须**为“已写入但未构建索引”的数据重建索引，否则无法在`MATCH`和`LOOKUP`语句中返回这些数据。参见 [重建索引](../3.ngql-guide/14.native-index-statements/4.rebuild-native-index.md)。 + **必须**为“已写入但未构建索引”的数据重建索引，否则无法在`MATCH`和`LOOKUP`语句中返回这些数据。参见[重建索引](../3.ngql-guide/14.native-index-statements/4.rebuild-native-index.md)。 ### nGQL 语法 @@ -507,7 +507,7 @@ nebula> FETCH PROP ON player "player100"; !!! Note - 为没有指定长度的变量属性创建索引时，需要指定索引长度。在 utf-8 编码中，一个中文字符占 3 字节，请根据变量属性长度设置合适的索引长度。例如 10 个中文字符，索引长度需要为 30。详情请参见 [创建索引](../3.ngql-guide/14.native-index-statements/1.create-native-index.md#_6)。 + 为没有指定长度的变量属性创建索引时，需要指定索引长度。在 utf-8 编码中，一个中文字符占 3 字节，请根据变量属性长度设置合适的索引长度。例如 10 个中文字符，索引长度需要为 30。详情请参见[创建索引](../3.ngql-guide/14.native-index-statements/1.create-native-index.md#_6)。 ### 基于索引的`LOOKUP`和`MATCH`示例 diff --git a/docs-2.0/20.appendix/0.FAQ.md b/docs-2.0/20.appendix/0.FAQ.md index 8d45379fdb..744cdaa10a 100644 --- a/docs-2.0/20.appendix/0.FAQ.md +++ b/docs-2.0/20.appendix/0.FAQ.md @@ -23,8 +23,8 @@ Nebula Graph 一直在持续开发，功能或操作的行为可能会有变化 !!! compatibility "`X`版本兼容性" Nebula Graph {{ nebula.release }} 与 历史版本 （包括 Nebula Graph 1.x 和 2.0-RC) 的数据格式、客户端通信协议均**双向不兼容**。 - 数据格式升级参见 [升级 Nebula Graph 历史版本至当前版本](../4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-graph-to-latest.md)。 - 客户端与工具均需要 [下载对应版本](../20.appendix/6.eco-tool-version.md)。 + 数据格式升级参见[升级 Nebula Graph 历史版本至当前版本](../4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-graph-to-latest.md)。 + 客户端与工具均需要[下载对应版本](../20.appendix/6.eco-tool-version.md)。 !!! compatibility "`Y`版本兼容性" @@ -103,7 +103,7 @@ Storage 服务使用 Raft 协议（多数表决），为保证可用性，要求 支持。 -详情请参见 [终止查询](../3.ngql-guide/18.operation-and-maintenance-statements/6.kill-query.md)。 +详情请参见[终止查询](../3.ngql-guide/18.operation-and-maintenance-statements/6.kill-query.md)。 ### 使用`GO`和`MATCH`执行相同语义的查询，查询结果为什么不同？ @@ -129,7 +129,7 @@ Storage 服务使用 Raft 协议（多数表决），为保证可用性，要求 所以使用`GO`和`MATCH`执行相同语义的查询，可能会出现`MATCH`语句的查询结果比`GO`语句少。 -关于路径的详细说明，请参见 [维基百科](https://en.wikipedia.org/wiki/Path_(graph_theory)#Walk,_trail,_path)。 +关于路径的详细说明，请参见[维基百科](https://en.wikipedia.org/wiki/Path_(graph_theory)#Walk,_trail,_path)。 ### 如何处理错误信息`[ERROR (-7)]: SyntaxError: syntax error near`？ @@ -236,7 +236,7 @@ Storage 服务在毫秒级时间内多次收到插入或者更新同一点或边 图空间、Tag、Edge type、属性以及索引的名称都需由大小写英文字母、数字或下划线组成，暂不支持使用中文字符。 -同时，上述标识符区分大小写，且不可使用 [关键字和保留字](../3.ngql-guide/1.nGQL-overview/keywords-and-reserved-words.md) 。 +同时，上述标识符区分大小写，且不可使用[关键字和保留字](../3.ngql-guide/1.nGQL-overview/keywords-and-reserved-words.md) 。 ### 获取指定点的出度（或者入度）? @@ -259,7 +259,7 @@ nebula > MATCH (s)<-[e]-() WHERE id(s) == "given" RETURN count(e); #入度 - Schema 中是否存在该 Tag 或 Edge type。 -- Tag 或 Edge type 的名称是否为关键字，如果是关键字，请使用反引号（\`）将它们括起来。详情请参见 [关键字](../3.ngql-guide/1.nGQL-overview/keywords-and-reserved-words.md)。 +- Tag 或 Edge type 的名称是否为关键字，如果是关键字，请使用反引号（\`）将它们括起来。详情请参见[关键字](../3.ngql-guide/1.nGQL-overview/keywords-and-reserved-words.md)。 ## 关于运维 @@ -296,7 +296,7 @@ nebula-graphd version 2.5.0, Git: c397299c, Build Time: Aug 19 2021 11:20:18 ### 如何扩缩容 -用户可以使用 Dashboard（企业版），在可视化页面对 graphd 和 storaged 进行快速扩缩容，详情参见 [集群操作-扩缩容](../nebula-dashboard-ent/4.cluster-operator/4.manage.md)。 +用户可以使用 Dashboard（企业版），在可视化页面对 graphd 和 storaged 进行快速扩缩容，详情参见[集群操作-扩缩容](../nebula-dashboard-ent/4.cluster-operator/4.manage.md)。 Nebula Graph {{ nebula.release }} 未提供运维命令以实现自动扩缩容，参考以下步骤： @@ -304,13 +304,13 @@ Nebula Graph {{ nebula.release }} 未提供运维命令以实现自动扩缩容 !!! note - 用户可以使用 [脚本工具](https://github.com/vesoft-inc/nebula/blob/master/scripts/meta-transfer-tools.sh) 迁移 meta 服务，但是需要自行修改 Graph 服务和 Storage 服务的配置文件中的 Meta 设置。 + 用户可以使用[脚本工具](https://github.com/vesoft-inc/nebula/blob/master/scripts/meta-transfer-tools.sh) 迁移 meta 服务，但是需要自行修改 Graph 服务和 Storage 服务的配置文件中的 Meta 设置。 - graphd 的缩容： 将该 graphd 的 ip 从 client 的代码中移除，关闭该 graphd 进程。 - graphd 的扩容： 在新机器上准备 graphd 二进制文件和配置文件，在配置文件中修改或增加已在运行的 metad 地址，启动 graphd 进程。 -- storaged 的缩容：（副本数都必须大于 1），参考 [缩容命令](../8.service-tuning/load-balance.md#storage_1)。完成后关闭 storaged 进程。 +- storaged 的缩容：（副本数都必须大于 1），参考[缩容命令](../8.service-tuning/load-balance.md#storage_1)。完成后关闭 storaged 进程。 - storaged 的扩容：（副本数都必须大于 1） 在新机器上准备 storaged 二进制文件和配置文件，在配置文件中修改或增加已在运行的 metad 地址，启动 storaged 进程。 @@ -324,7 +324,7 @@ storaged 扩缩容之后，还需要运行 [Balance Data 和 Balance Leader 命 ### 防火墙中需要开放哪些端口 -如果没有修改过 [配置文件](../5.configurations-and-logs/1.configurations/1.configurations.md) 中预设的端口，请在防火墙中开放如下端口： +如果没有修改过[配置文件](../5.configurations-and-logs/1.configurations/1.configurations.md) 中预设的端口，请在防火墙中开放如下端口： |服务类型|端口| |-|-| 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 c77b37940b..08704601c2 100644 --- a/docs-2.0/20.appendix/6.eco-tool-version.md +++ b/docs-2.0/20.appendix/6.eco-tool-version.md @@ -28,7 +28,7 @@ ## Nebula Graph Studio -Nebula Graph Studio（简称 Studio）是一款可以通过 Web 访问的图数据库可视化工具，搭配 Nebula Graph DBMS 使用，提供构图、数据导入、编写 nGQL 查询、图探索等一站式服务。详情请参见 [什么是 Nebula Graph Studio](../nebula-studio/about-studio/st-ug-what-is-graph-studio.md)。 +Nebula Graph Studio（简称 Studio）是一款可以通过 Web 访问的图数据库可视化工具，搭配 Nebula Graph DBMS 使用，提供构图、数据导入、编写 nGQL 查询、图探索等一站式服务。详情请参见[什么是 Nebula Graph Studio](../nebula-studio/about-studio/st-ug-what-is-graph-studio.md)。 !!! Note @@ -40,7 +40,7 @@ Nebula Graph Studio（简称 Studio）是一款可以通过 Web 访问的图数 ## Nebula Dashboard（社区版） -Nebula Dashboard（简称 Dashboard）是一款用于监控 Nebula Graph 集群中机器和服务状态的可视化工具。详情参见 [什么是 Nebula Dashboard](../nebula-dashboard/1.what-is-dashboard.md)。 +Nebula Dashboard（简称 Dashboard）是一款用于监控 Nebula Graph 集群中机器和服务状态的可视化工具。详情参见[什么是 Nebula Dashboard](../nebula-dashboard/1.what-is-dashboard.md)。 |Nebula Graph 版本|Dashboard 版本（commit id）| |:---|:---| @@ -48,7 +48,7 @@ Nebula Dashboard（简称 Dashboard）是一款用于监控 Nebula Graph 集群 ## Nebula Dashboard（企业版） -Nebula Dashboard（简称 Dashboard）是一款用于监控和管理 Nebula Graph 多集群中机器和服务状态的可视化工具，支持在可视化界面进行集群创建、集群导入、数据平衡、扩容缩容等操作。详情参见 [什么是 Nebula Dashboard](../nebula-dashboard-ent/1.what-is-dashboard-ent.md)。 +Nebula Dashboard（简称 Dashboard）是一款用于监控和管理 Nebula Graph 多集群中机器和服务状态的可视化工具，支持在可视化界面进行集群创建、集群导入、数据平衡、扩容缩容等操作。详情参见[什么是 Nebula Dashboard](../nebula-dashboard-ent/1.what-is-dashboard-ent.md)。 |Nebula Graph 版本|Dashboard 企业版本（commit id）| |:---|:---| @@ -56,7 +56,7 @@ Nebula Dashboard（简称 Dashboard）是一款用于监控和管理 Nebula Grap ## Nebula Explorer -Nebula Explorer（简称 Explorer）是一款可以通过 Web 访问的图探索可视化工具，搭配 Nebula Graph 内核使用，用于与图数据进行可视化交互。即使没有图数据操作经验，用户也可以快速成为图专家。详情参见 [什么是 Nebula Explorer](../nebula-explorer/about-explorer/ex-ug-what-is-explorer.md)。 +Nebula Explorer（简称 Explorer）是一款可以通过 Web 访问的图探索可视化工具，搭配 Nebula Graph 内核使用，用于与图数据进行可视化交互。即使没有图数据操作经验，用户也可以快速成为图专家。详情参见[什么是 Nebula Explorer](../nebula-explorer/about-explorer/ex-ug-what-is-explorer.md)。 |Nebula Graph 版本|Explorer 版本（commit id）| |:---|:---| @@ -64,7 +64,7 @@ Nebula Explorer（简称 Explorer）是一款可以通过 Web 访问的图探索 ## Nebula Exchange -Nebula Exchange（简称 Exchange）是一款 Apache Spark™ 应用，用于在分布式环境中将集群中的数据批量迁移到 Nebula Graph 中，能支持多种不同格式的批式数据和流式数据的迁移。详情请参见 [什么是 Nebula Exchange](../nebula-exchange/about-exchange/ex-ug-what-is-exchange.md)。 +Nebula Exchange（简称 Exchange）是一款 Apache Spark™ 应用，用于在分布式环境中将集群中的数据批量迁移到 Nebula Graph 中，能支持多种不同格式的批式数据和流式数据的迁移。详情请参见[什么是 Nebula Exchange](../nebula-exchange/about-exchange/ex-ug-what-is-exchange.md)。 |Nebula Graph 版本|Exchange 社区版版本（commit id）|Exchange 企业版版本（commit id）| |:---|:---|:--| @@ -72,7 +72,7 @@ Nebula Exchange（简称 Exchange）是一款 Apache Spark™ 应用，用 ## Nebula Operator -Nebula Operator（简称 Operator）是用于在 Kubernetes 系统上自动化部署和运维 Nebula Graph 集群的工具。依托于 Kubernetes 扩展机制，Nebula Graph 将其运维领域的知识全面注入至 Kubernetes 系统中，让 Nebula Graph 成为真正的云原生图数据库。详情请参考 [什么是 Nebula Operator](../nebula-operator/1.introduction-to-nebula-operator.md)。 +Nebula Operator（简称 Operator）是用于在 Kubernetes 系统上自动化部署和运维 Nebula Graph 集群的工具。依托于 Kubernetes 扩展机制，Nebula Graph 将其运维领域的知识全面注入至 Kubernetes 系统中，让 Nebula Graph 成为真正的云原生图数据库。详情请参考[什么是 Nebula Operator](../nebula-operator/1.introduction-to-nebula-operator.md)。 |Nebula Graph 版本|Operator 版本（commit id）| |:---|:---| @@ -80,7 +80,7 @@ Nebula Operator（简称 Operator）是用于在 Kubernetes 系统上自动化 ## Nebula Importer -Nebula Importer（简称 Importer）是一款 Nebula Graph 的 CSV 文件导入工具。Importer 可以读取本地的 CSV 文件，然后导入数据至 Nebula Graph 图数据库中。详情请参见 [什么是 Nebula Importer](../nebula-importer/use-importer.md)。 +Nebula Importer（简称 Importer）是一款 Nebula Graph 的 CSV 文件导入工具。Importer 可以读取本地的 CSV 文件，然后导入数据至 Nebula Graph 图数据库中。详情请参见[什么是 Nebula Importer](../nebula-importer/use-importer.md)。 |Nebula Graph 版本|[Importer](https://github.com/vesoft-inc/nebula-importer/tree/{{importer.branch}}) 版本（commit id）| |:---|:---| @@ -88,7 +88,7 @@ Nebula Importer（简称 Importer）是一款 Nebula Graph 的 CSV 文件导入 ## Nebula Spark Connector -Nebula Spark Connector 是一个 Spark 连接器，提供通过 Spark 标准形式读写 Nebula Graph 数据的能力。Nebula Spark Connector 由 Reader 和 Writer 两部分组成。详情请参见 [什么是 Nebula Spark Connector](../nebula-spark-connector.md)。 +Nebula Spark Connector 是一个 Spark 连接器，提供通过 Spark 标准形式读写 Nebula Graph 数据的能力。Nebula Spark Connector 由 Reader 和 Writer 两部分组成。详情请参见[什么是 Nebula Spark Connector](../nebula-spark-connector.md)。 |Nebula Graph 版本|Spark Connector 版本（commit id）| |:---|:---| @@ -96,7 +96,7 @@ Nebula Spark Connector 是一个 Spark 连接器，提供通过 Spark 标准形 ## Nebula Flink Connector -Nebula Flink Connector 是一款帮助 Flink 用户快速访问 Nebula Graph 的连接器，支持从 Nebula Graph 图数据库中读取数据，或者将其他外部数据源读取的数据写入 Nebula Graph 图数据库。详情请参见 [什么是 Nebula Flink Connector](../nebula-flink-connector.md)。 +Nebula Flink Connector 是一款帮助 Flink 用户快速访问 Nebula Graph 的连接器，支持从 Nebula Graph 图数据库中读取数据，或者将其他外部数据源读取的数据写入 Nebula Graph 图数据库。详情请参见[什么是 Nebula Flink Connector](../nebula-flink-connector.md)。 |Nebula Graph 版本|Flink Connector 版本（commit id）| |:---|:---| @@ -104,7 +104,7 @@ Nebula Flink Connector 是一款帮助 Flink 用户快速访问 Nebula Graph 的 ## Nebula Algorithm -Nebula Algorithm（简称 Algorithm）是一款基于 [GraphX](https://spark.apache.org/graphx/) 的 Spark 应用程序，通过提交 Spark 任务的形式使用完整的算法工具对 Nebula Graph 数据库中的数据执行图计算，也可以通过编程形式调用 lib 库下的算法针对 DataFrame 执行图计算。详情请参见 [什么是 Nebula Algorithm](../nebula-algorithm.md)。 +Nebula Algorithm（简称 Algorithm）是一款基于 [GraphX](https://spark.apache.org/graphx/) 的 Spark 应用程序，通过提交 Spark 任务的形式使用完整的算法工具对 Nebula Graph 数据库中的数据执行图计算，也可以通过编程形式调用 lib 库下的算法针对 DataFrame 执行图计算。详情请参见[什么是 Nebula Algorithm](../nebula-algorithm.md)。 |Nebula Graph 版本|Algorithm 版本（commit id）| |:---|:---| @@ -112,7 +112,7 @@ Nebula Algorithm（简称 Algorithm）是一款基于 [GraphX](https://spark.apa ## Nebula Console -Nebula Console 是 Nebula Graph 的原生 CLI 客户端。如何使用请参见 [连接 Nebula Graph](../2.quick-start/3.connect-to-nebula-graph.md)。 +Nebula Console 是 Nebula Graph 的原生 CLI 客户端。如何使用请参见[连接 Nebula Graph](../2.quick-start/3.connect-to-nebula-graph.md)。 |Nebula Graph 版本|Console 版本（commit id）| |:---|:---| diff --git a/docs-2.0/20.appendix/mind-map.md b/docs-2.0/20.appendix/mind-map.md index 6ffd967fa3..4d7b535020 100644 --- a/docs-2.0/20.appendix/mind-map.md +++ b/docs-2.0/20.appendix/mind-map.md @@ -1,9 +1,9 @@ # 思维导图 -以下给出 Nebula Graph 结构框架的思维导图，用户可以 [点击](https://www.mubucm.com/doc/34QEdbrFRwZ) 并查看大图。 +以下给出 Nebula Graph 结构框架的思维导图，用户可以[点击](https://www.mubucm.com/doc/34QEdbrFRwZ) 并查看大图。 ![nebula graph](../20.appendix/Unknown-2.png) -以下给出 nGQL 的思维导图，用户可以 [点击](https://www.mubucm.com/doc/3heEUeLwbMZ) 并查看大图。 +以下给出 nGQL 的思维导图，用户可以[点击](https://www.mubucm.com/doc/3heEUeLwbMZ) 并查看大图。 ![nebula nGQL](../20.appendix/Unknown-3.png) diff --git a/docs-2.0/20.appendix/write-tools.md b/docs-2.0/20.appendix/write-tools.md index cbb2492399..a75da5c061 100644 --- a/docs-2.0/20.appendix/write-tools.md +++ b/docs-2.0/20.appendix/write-tools.md @@ -2,7 +2,7 @@ 有多种方式可以写入 Nebula Graph {{ nebula.release }}： -- 使用 [命令行 -f 的方式](../2.quick-start/3.connect-to-nebula-graph.md) 导入：可以导入少量准备好的 nGQL 文件，适合少量手工测试数据准备； +- 使用[命令行 -f 的方式](../2.quick-start/3.connect-to-nebula-graph.md) 导入：可以导入少量准备好的 nGQL 文件，适合少量手工测试数据准备； - 使用 [studio 导入](../nebula-studio/quick-start/st-ug-import-data.md): 可以用过浏览器导入本机多个 csv 文件，单个文件不超过 100 MB，格式有限制； - 使用 [importer 导入](../nebula-importer/use-importer.md): 导入单机多个 csv 文件，大小没有限制，格式灵活； - 使用 [Exchange 导入](../nebula-exchange/about-exchange/ex-ug-what-is-exchange.md): 从 Neo4j, Hive, MySQL 等多种源分布式导入，需要有 Spark 集群； 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 835c200d0a..4ea2605b33 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,6 +1,6 @@ # 什么是 nGQL -nGQL（Nebula Graph Query Language）是 Nebula Graph 使用的的声明式图查询语言，支持灵活高效的 [图模式](3.graph-patterns.md)，而且 nGQL 是为开发和运维人员设计的类 SQL 查询语言，易于学习。 +nGQL（Nebula Graph Query Language）是 Nebula Graph 使用的的声明式图查询语言，支持灵活高效的[图模式](3.graph-patterns.md)，而且 nGQL 是为开发和运维人员设计的类 SQL 查询语言，易于学习。 nGQL 是一个进行中的项目，会持续发布新特性和优化，因此可能会出现语法和实际操作不一致的问题，如果遇到此类问题，请提交 [issue](https://github.com/vesoft-inc/nebula/issues) 通知 Nebula Graph 团队。Nebula Graph 2.0 及更新版本正在支持 [openCypher 9](https://www.opencypher.org/resources)。 @@ -183,7 +183,7 @@ Feature: Comparison of where clause |`And`|描述执行`When`内语句的副作用或执行计划。| | `@skip` | 跳过这个示例。通常表示测试代码还没有准备好。 | -欢迎 [增加更多 tck case](https://github.com/vesoft-inc/nebula/tree/master/tests)，在 CI/CD 中自动回归所使用的语句。 +欢迎[增加更多 tck case](https://github.com/vesoft-inc/nebula/tree/master/tests)，在 CI/CD 中自动回归所使用的语句。 ### 是否支持 TinkerPop Gremlin？ 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 269f51b91d..cfd9cc0db9 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 @@ -11,7 +11,7 @@ nGQL 中的 Tag 和 openCypher 中的 Label 相似，但又有所不同，例如 ## 前提条件 -执行`CREATE TAG`语句需要当前登录的用户拥有指定图空间的 [创建 Tag 权限](../../7.data-security/1.authentication/3.role-list.md)，否则会报错。 +执行`CREATE TAG`语句需要当前登录的用户拥有指定图空间的[创建 Tag 权限](../../7.data-security/1.authentication/3.role-list.md)，否则会报错。 ## 语法 @@ -31,9 +31,9 @@ CREATE TAG [IF NOT EXISTS] |参数|说明| |:---|:---| |`IF NOT EXISTS`|检测待创建的 Tag 是否存在，只有不存在时，才会创建 Tag。仅检测 Tag 的名称，不会检测具体属性。| -|``|每个图空间内的 Tag 必须是唯一的。Tag 名称设置后无法修改。Tag 名称由大小写英文字母、数字或下划线组成，区分大写小，且不可使用 [关键字和保留字](../../3.ngql-guide/1.nGQL-overview/keywords-and-reserved-words.md)。| +|``|每个图空间内的 Tag 必须是唯一的。Tag 名称设置后无法修改。Tag 名称由大小写英文字母、数字或下划线组成，区分大写小，且不可使用[关键字和保留字](../../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)。| +|``|属性的数据类型，目前支持[数值](../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`。| |`DEFAULT`|指定属性的默认值。默认值可以是一个文字值或 Nebula Graph 支持的表达式。如果插入点时没有指定某个属性的值，则使用默认值。| |`COMMENT`|对单个属性或 Tag 的描述。最大为 256 字节。默认无描述。| @@ -67,4 +67,4 @@ Nebula Graph 将在下一个心跳周期内完成 Tag 的创建，为了确保 - 等待两个心跳周期，例如 20 秒。 -如果需要修改心跳间隔，请为 [所有配置文件](../../5.configurations-and-logs/1.configurations/1.configurations.md) 修改参数`heartbeat_interval_secs`。 +如果需要修改心跳间隔，请为[所有配置文件](../../5.configurations-and-logs/1.configurations/1.configurations.md) 修改参数`heartbeat_interval_secs`。 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 85e789f827..824038b159 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 @@ ## 前提条件 -- 登录的用户必须拥有对应权限才能执行`DROP TAG`语句。详情请参见 [内置角色权限](../../7.data-security/1.authentication/3.role-list.md)。 +- 登录的用户必须拥有对应权限才能执行`DROP TAG`语句。详情请参见[内置角色权限](../../7.data-security/1.authentication/3.role-list.md)。 - 确保 Tag 不包含任何索引，否则`DROP TAG`时会报冲突错误`[ERROR (-8)]: Conflict!`。删除索引请参见 [drop index](../14.native-index-statements/6.drop-native-index.md)。 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 ea4b8b4171..008a17ef1e 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 @@ -4,7 +4,7 @@ ## 前提条件 -- 登录的用户必须拥有对应权限才能执行`ALTER TAG`语句。详情请参见 [内置角色权限](../../7.data-security/1.authentication/3.role-list.md)。 +- 登录的用户必须拥有对应权限才能执行`ALTER TAG`语句。详情请参见[内置角色权限](../../7.data-security/1.authentication/3.role-list.md)。 - 确保要修改的属性不包含索引，否则`ALTER TAG`时会报冲突错误`[ERROR (-8)]: Conflict!`。删除索引请参见 [drop index](../14.native-index-statements/6.drop-native-index.md)。 @@ -48,4 +48,4 @@ Nebula Graph 将在下一个心跳周期内完成 Tag 的修改，为了确保 - 等待两个心跳周期，例如 20 秒。 -如果需要修改心跳间隔，请为 [所有配置文件](../../5.configurations-and-logs/1.configurations/1.configurations.md) 修改参数`heartbeat_interval_secs`。 +如果需要修改心跳间隔，请为[所有配置文件](../../5.configurations-and-logs/1.configurations/1.configurations.md) 修改参数`heartbeat_interval_secs`。 diff --git a/docs-2.0/3.ngql-guide/10.tag-statements/4.show-tags.md b/docs-2.0/3.ngql-guide/10.tag-statements/4.show-tags.md index 5ab22d637e..0629bd42fd 100644 --- a/docs-2.0/3.ngql-guide/10.tag-statements/4.show-tags.md +++ b/docs-2.0/3.ngql-guide/10.tag-statements/4.show-tags.md @@ -2,7 +2,7 @@ `SHOW TAGS`语句显示当前图空间内的所有 Tag 名称。 -执行`SHOW TAGS`语句不需要任何权限，但是返回结果由登录的用户 [权限](../../7.data-security/1.authentication/3.role-list.md) 决定。 +执行`SHOW TAGS`语句不需要任何权限，但是返回结果由登录的用户[权限](../../7.data-security/1.authentication/3.role-list.md) 决定。 ## 语法 diff --git a/docs-2.0/3.ngql-guide/10.tag-statements/5.describe-tag.md b/docs-2.0/3.ngql-guide/10.tag-statements/5.describe-tag.md index 9bc7cb96f4..8a7c189347 100644 --- a/docs-2.0/3.ngql-guide/10.tag-statements/5.describe-tag.md +++ b/docs-2.0/3.ngql-guide/10.tag-statements/5.describe-tag.md @@ -4,7 +4,7 @@ ## 前提条件 -登录的用户必须拥有对应权限才能执行`DESCRIBE TAG`语句。详情请参见 [内置角色权限](../../7.data-security/1.authentication/3.role-list.md)。 +登录的用户必须拥有对应权限才能执行`DESCRIBE TAG`语句。详情请参见[内置角色权限](../../7.data-security/1.authentication/3.role-list.md)。 ## 语法 diff --git a/docs-2.0/3.ngql-guide/10.tag-statements/6.delete-tag.md b/docs-2.0/3.ngql-guide/10.tag-statements/6.delete-tag.md index b67e7d3414..546ab020a2 100644 --- a/docs-2.0/3.ngql-guide/10.tag-statements/6.delete-tag.md +++ b/docs-2.0/3.ngql-guide/10.tag-statements/6.delete-tag.md @@ -10,7 +10,7 @@ ## 前提条件 -登录的用户必须拥有对应权限才能执行`DELETE TAG`语句。详情请参见 [内置角色权限](../../7.data-security/1.authentication/3.role-list.md)。 +登录的用户必须拥有对应权限才能执行`DELETE TAG`语句。详情请参见[内置角色权限](../../7.data-security/1.authentication/3.role-list.md)。 ## 语法 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 006de93716..b8a948f572 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 @@ -11,7 +11,7 @@ nGQL 中的 Edge type 和 openCypher 中的关系类型相似，但又有所不 ## 前提条件 -执行`CREATE EDGE`语句需要当前登录的用户拥有指定图空间的 [创建 Edge type 权限](../../7.data-security/1.authentication/3.role-list.md)，否则会报错。 +执行`CREATE EDGE`语句需要当前登录的用户拥有指定图空间的[创建 Edge type 权限](../../7.data-security/1.authentication/3.role-list.md)，否则会报错。 ## 语法 @@ -31,9 +31,9 @@ CREATE EDGE [IF NOT EXISTS] |参数|说明| |:---|:---| |`IF NOT EXISTS`|检测待创建的 Edge type 是否存在，只有不存在时，才会创建 Edge type。仅检测 Edge type 的名称，不会检测具体属性。| -|``|每个图空间内的 Edge type 必须是唯一的。Edge type 名称设置后无法修改。Edge type 名称由大小写英文字母、数字或下划线组成，区分大写小，且不可使用 [关键字和保留字](../../3.ngql-guide/1.nGQL-overview/keywords-and-reserved-words.md)。| +|``|每个图空间内的 Edge type 必须是唯一的。Edge type 名称设置后无法修改。Edge type 名称由大小写英文字母、数字或下划线组成，区分大写小，且不可使用[关键字和保留字](../../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)。| +|``|属性的数据类型，目前支持[数值](../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`。| |`DEFAULT`|指定属性的默认值。默认值可以是一个文字值或 Nebula Graph 支持的表达式。如果插入边时没有指定某个属性的值，则使用默认值。| |`COMMENT`|对单个属性或 Edge type 的描述。最大为 256 字节。默认无描述。| diff --git a/docs-2.0/3.ngql-guide/11.edge-type-statements/2.drop-edge.md b/docs-2.0/3.ngql-guide/11.edge-type-statements/2.drop-edge.md index 2e40567190..8fe1814ae9 100644 --- a/docs-2.0/3.ngql-guide/11.edge-type-statements/2.drop-edge.md +++ b/docs-2.0/3.ngql-guide/11.edge-type-statements/2.drop-edge.md @@ -8,7 +8,7 @@ ## 前提条件 -- 登录的用户必须拥有对应权限才能执行`DROP EDGE`语句。详情请参见 [内置角色权限](../../7.data-security/1.authentication/3.role-list.md)。 +- 登录的用户必须拥有对应权限才能执行`DROP EDGE`语句。详情请参见[内置角色权限](../../7.data-security/1.authentication/3.role-list.md)。 - 确保 Edge type 不包含任何索引，否则`DROP EDGE`时会报冲突错误`[ERROR (-8)]: Conflict!`。删除索引请参见 [drop index](../14.native-index-statements/6.drop-native-index.md)。 diff --git a/docs-2.0/3.ngql-guide/11.edge-type-statements/3.alter-edge.md b/docs-2.0/3.ngql-guide/11.edge-type-statements/3.alter-edge.md index af1161a4ac..46738d541f 100644 --- a/docs-2.0/3.ngql-guide/11.edge-type-statements/3.alter-edge.md +++ b/docs-2.0/3.ngql-guide/11.edge-type-statements/3.alter-edge.md @@ -4,7 +4,7 @@ ## 前提条件 -- 登录的用户必须拥有对应权限才能执行`ALTER EDGE`语句。详情请参见 [内置角色权限](../../7.data-security/1.authentication/3.role-list.md)。 +- 登录的用户必须拥有对应权限才能执行`ALTER EDGE`语句。详情请参见[内置角色权限](../../7.data-security/1.authentication/3.role-list.md)。 - 确保要修改的属性不包含索引，否则`ALTER EDGE`时会报冲突错误`[ERROR (-8)]: Conflict!`。删除索引请参见 [drop index](../14.native-index-statements/6.drop-native-index.md)。 @@ -48,4 +48,4 @@ Nebula Graph 将在下一个心跳周期内完成 Edge type 的修改，为了 - 等待两个心跳周期，例如 20 秒。 -如果需要修改心跳间隔，请为 [所有配置文件](../../5.configurations-and-logs/1.configurations/1.configurations.md) 修改参数`heartbeat_interval_secs`。 \ No newline at end of file +如果需要修改心跳间隔，请为[所有配置文件](../../5.configurations-and-logs/1.configurations/1.configurations.md) 修改参数`heartbeat_interval_secs`。 \ No newline at end of file diff --git a/docs-2.0/3.ngql-guide/11.edge-type-statements/4.show-edges.md b/docs-2.0/3.ngql-guide/11.edge-type-statements/4.show-edges.md index 767ea5842e..421ca46dce 100644 --- a/docs-2.0/3.ngql-guide/11.edge-type-statements/4.show-edges.md +++ b/docs-2.0/3.ngql-guide/11.edge-type-statements/4.show-edges.md @@ -2,7 +2,7 @@ `SHOW EDGES`语句显示当前图空间内的所有 Edge type 名称。 -执行`SHOW EDGES`语句不需要任何权限，但是返回结果由登录的用户 [权限](../../7.data-security/1.authentication/3.role-list.md) 决定。 +执行`SHOW EDGES`语句不需要任何权限，但是返回结果由登录的用户[权限](../../7.data-security/1.authentication/3.role-list.md) 决定。 ## 语法 diff --git a/docs-2.0/3.ngql-guide/11.edge-type-statements/5.describe-edge.md b/docs-2.0/3.ngql-guide/11.edge-type-statements/5.describe-edge.md index c5580dd40a..e982657126 100644 --- a/docs-2.0/3.ngql-guide/11.edge-type-statements/5.describe-edge.md +++ b/docs-2.0/3.ngql-guide/11.edge-type-statements/5.describe-edge.md @@ -4,7 +4,7 @@ ## 前提条件 -登录的用户必须拥有对应权限才能执行`DESCRIBE EDGE`语句。详情请参见 [内置角色权限](../../7.data-security/1.authentication/3.role-list.md)。 +登录的用户必须拥有对应权限才能执行`DESCRIBE EDGE`语句。详情请参见[内置角色权限](../../7.data-security/1.authentication/3.role-list.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 e92086195c..b6ad732c32 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 @@ -4,7 +4,7 @@ ## 前提条件 -执行`INSERT VERTEX`语句需要当前登录的用户拥有指定图空间的 [插入点权限](../../7.data-security/1.authentication/3.role-list.md)，否则会报错。 +执行`INSERT VERTEX`语句需要当前登录的用户拥有指定图空间的[插入点权限](../../7.data-security/1.authentication/3.role-list.md)，否则会报错。 ## 语法 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 cb5b127855..b831f80461 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 @@ -2,7 +2,7 @@ `DELETE VERTEX`语句可以删除点，以及点关联的出边和入边。 -`DELETE VERTEX`语句一次可以删除一个或多个点。用户可以结合管道符一起使用，详情请参见 [管道符](../5.operators/4.pipe.md)。 +`DELETE VERTEX`语句一次可以删除一个或多个点。用户可以结合管道符一起使用，详情请参见[管道符](../5.operators/4.pipe.md)。 !!! note diff --git a/docs-2.0/3.ngql-guide/13.edge-statements/4.delete-edge.md b/docs-2.0/3.ngql-guide/13.edge-statements/4.delete-edge.md index bca0e1a81d..aa3764a3d4 100644 --- a/docs-2.0/3.ngql-guide/13.edge-statements/4.delete-edge.md +++ b/docs-2.0/3.ngql-guide/13.edge-statements/4.delete-edge.md @@ -1,6 +1,6 @@ # DELETE EDGE -`DELETE EDGE`语句可以删除边。一次可以删除一条或多条边。用户可以结合管道符一起使用，详情请参见 [管道符](../5.operators/4.pipe.md)。 +`DELETE EDGE`语句可以删除边。一次可以删除一条或多条边。用户可以结合管道符一起使用，详情请参见[管道符](../5.operators/4.pipe.md)。 如果需要删除一个点的所有出边，请删除这个点。详情请参见 [DELETE VERTEX](../12.vertex-statements/4.delete-vertex.md)。 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 232fb53038..72a259b7df 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 @@ -4,7 +4,7 @@ 创建索引之前，请确保相关的 Tag 或 Edge type 已经创建。如何创建 Tag 和 Edge type，请参见 [CREATE TAG](../10.tag-statements/1.create-tag.md) 和 [CREATE EDGE](../11.edge-type-statements/1.create-edge.md)。 -如何创建全文索引，请参见 [部署全文索引](../../4.deployment-and-installation/6.deploy-text-based-index/2.deploy-es.md)。 +如何创建全文索引，请参见[部署全文索引](../../4.deployment-and-installation/6.deploy-text-based-index/2.deploy-es.md)。 ## 使用索引必读 @@ -58,7 +58,7 @@ - 在 [`SHOW TAG/EDGE INDEXES`](2.show-native-indexes.md) 语句的结果中查找到新的索引。或者， - - 等待两个心跳周期，例如 20 秒。如果需要修改心跳间隔，请为 [所有配置文件](../../5.configurations-and-logs/1.configurations/1.configurations.md) 修改参数`heartbeat_interval_secs`。 + - 等待两个心跳周期，例如 20 秒。如果需要修改心跳间隔，请为[所有配置文件](../../5.configurations-and-logs/1.configurations/1.configurations.md) 修改参数`heartbeat_interval_secs`。 !!! danger @@ -74,7 +74,7 @@ CREATE {TAG | EDGE} INDEX [IF NOT EXISTS] ON { | `|索引名。索引名在一个图空间中必须是唯一的。推荐的命名方式为`i_tagName_propName`。索引名称由大小写英文字母、数字或下划线组成，区分大写小，且不可使用 [关键字和保留字](../../3.ngql-guide/1.nGQL-overview/keywords-and-reserved-words.md)。| +|``|索引名。索引名在一个图空间中必须是唯一的。推荐的命名方式为`i_tagName_propName`。索引名称由大小写英文字母、数字或下划线组成，区分大写小，且不可使用[关键字和保留字](../../3.ngql-guide/1.nGQL-overview/keywords-and-reserved-words.md)。| |` \| `|指定索引关联的 Tag 或 Edge 名称。| |``|为**变长**字符串属性创建索引时，必须用`prop_name(length)`指定索引长度；为 Tag 或 Edge type 本身创建索引时，忽略``。| |`COMMENT`|索引的描述。最大为 256 字节。默认无描述。| 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 37abf432ae..8ead9a9e9d 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 @@ -48,11 +48,11 @@ Nebula Graph 支持两种类型索引：原生索引和全文索引。 ### 全文索引操作 -在对全文索引执行任何操作之前，请确保已经部署全文索引。详情请参见 [部署全文索引](../../4.deployment-and-installation/6.deploy-text-based-index/2.deploy-es.md) 和 [部署 listener](../../4.deployment-and-installation/6.deploy-text-based-index/3.deploy-listener.md)。 +在对全文索引执行任何操作之前，请确保已经部署全文索引。详情请参见[部署全文索引](../../4.deployment-and-installation/6.deploy-text-based-index/2.deploy-es.md) 和[部署 listener](../../4.deployment-and-installation/6.deploy-text-based-index/3.deploy-listener.md)。 部署完成后，Elasticsearch 集群上会自动创建全文索引。不支持重建或修改全文索引。如果需要删除全文索引，请在 Elasticsearch 集群上手动删除。 -使用全文索引请参见 [使用全文索引查询](../15.full-text-index-statements/1.search-with-text-based-index.md)。 +使用全文索引请参见[使用全文索引查询](../15.full-text-index-statements/1.search-with-text-based-index.md)。 ## NULL 值说明 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 7b1b973301..1c05c31367 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 @@ -6,11 +6,11 @@ ## 前提条件 -请确保已经部署全文索引。详情请参见 [部署全文索引](../../4.deployment-and-installation/6.deploy-text-based-index/2.deploy-es.md) 和 [部署 listener](../../4.deployment-and-installation/6.deploy-text-based-index/3.deploy-listener.md)。 +请确保已经部署全文索引。详情请参见[部署全文索引](../../4.deployment-and-installation/6.deploy-text-based-index/2.deploy-es.md) 和[部署 listener](../../4.deployment-and-installation/6.deploy-text-based-index/3.deploy-listener.md)。 ## 注意事项 -使用全文索引前，请确认已经了解全文索引的 [使用限制](../../4.deployment-and-installation/6.deploy-text-based-index/1.text-based-index-restrictions.md)。 +使用全文索引前，请确认已经了解全文索引的[使用限制](../../4.deployment-and-installation/6.deploy-text-based-index/1.text-based-index-restrictions.md)。 ## 自然语言全文搜索 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 4b9338c191..f55c083281 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 @@ -22,7 +22,7 @@ GET SUBGRAPH [WITH PROP] [ STEPS] FROM {, ...} !!! note - `GET SUBGRAPH`语句检索的路径类型为`trail`，即检索的路径只有点可以重复，边不可以重复。详情请参见 [路径](../../1.introduction/2.1.path.md)。 + `GET SUBGRAPH`语句检索的路径类型为`trail`，即检索的路径只有点可以重复，边不可以重复。详情请参见[路径](../../1.introduction/2.1.path.md)。 ## 示例 diff --git a/docs-2.0/3.ngql-guide/16.subgraph-and-path/2.find-path.md b/docs-2.0/3.ngql-guide/16.subgraph-and-path/2.find-path.md index 28b30aad97..2ad7f7bd0e 100644 --- a/docs-2.0/3.ngql-guide/16.subgraph-and-path/2.find-path.md +++ b/docs-2.0/3.ngql-guide/16.subgraph-and-path/2.find-path.md @@ -34,7 +34,7 @@ OVER [REVERSELY | BIDIRECT] [] [UPTO STEPS] [ !!! note - `FIND PATH`语句检索的路径类型为`trail`，即检索的路径只有点可以重复，边不可以重复。详情请参见 [路径](../../1.introduction/2.1.path.md)。 + `FIND PATH`语句检索的路径类型为`trail`，即检索的路径只有点可以重复，边不可以重复。详情请参见[路径](../../1.introduction/2.1.path.md)。 ## 限制 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 7e399b148a..327e8923db 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 @@ -4,13 +4,13 @@ !!! Note - 根据过往实践，建议让 Nebula Graph 从本地文件获取配置。详情请参见 [配置简介](../../5.configurations-and-logs/1.configurations/1.configurations.md#修改配置)。 + 根据过往实践，建议让 Nebula Graph 从本地文件获取配置。详情请参见[配置简介](../../5.configurations-and-logs/1.configurations/1.configurations.md#修改配置)。 ## SHOW CONFIGS `SHOW CONFIGS`语句可以显示服务的配置信息。没有指定服务时，会返回所有服务的配置信息。 -执行`SHOW CONFIGS`语句不需要任何权限，但是返回结果由登录的用户 [权限](../../7.data-security/1.authentication/3.role-list.md) 决定。 +执行`SHOW CONFIGS`语句不需要任何权限，但是返回结果由登录的用户[权限](../../7.data-security/1.authentication/3.role-list.md) 决定。 ### 语法 diff --git a/docs-2.0/3.ngql-guide/18.operation-and-maintenance-statements/4.job-statements.md b/docs-2.0/3.ngql-guide/18.operation-and-maintenance-statements/4.job-statements.md index f345ec9f37..29ed1f0c19 100644 --- a/docs-2.0/3.ngql-guide/18.operation-and-maintenance-statements/4.job-statements.md +++ b/docs-2.0/3.ngql-guide/18.operation-and-maintenance-statements/4.job-statements.md @@ -79,7 +79,7 @@ nebula> SHOW JOB 34; |:---|:---| |Job Id(TaskId)|第一行显示作业 ID，其他行显示作业相关的任务 ID。| |Command(Dest)|第一行显示执行的作业命令名称，其他行显示任务对应的 nebula-storaged 进程。| -|Status|显示作业或任务的状态。详情请参见 [作业状态](#_6)。| +|Status|显示作业或任务的状态。详情请参见[作业状态](#_6)。| |Start Time|显示作业或任务开始执行的时间。| |Stop Time|显示作业或任务结束执行的时间，结束后的状态包括`FINISHED`、`FAILED`或`STOPPED`。| 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 850c083add..375d18574f 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）是由经纬度构成的表示地理空间信息的数据类型。Nebula Graph 当前支持 [简单地理要素](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 Graph 当前支持[简单地理要素](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/3.data-types/4.date-and-time.md b/docs-2.0/3.ngql-guide/3.data-types/4.date-and-time.md index cb836709c8..3a612bf262 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 @@ -2,7 +2,7 @@ 本文介绍日期和时间的类型，包括`DATE`、`TIME`、`DATETIME`和`TIMESTAMP`。 -在插入时间类型的属性值时，Nebula Graph 会根据 [配置文件](../../5.configurations-and-logs/1.configurations/1.configurations.md) 中`timezone_name`参数指定的时区，将该时间值（`TIMESTAMP`类型例外）转换成相应的世界协调时间（UTC）时间。在查询中返回的时间类型值为 UTC 时间。 +在插入时间类型的属性值时，Nebula Graph 会根据[配置文件](../../5.configurations-and-logs/1.configurations/1.configurations.md) 中`timezone_name`参数指定的时区，将该时间值（`TIMESTAMP`类型例外）转换成相应的世界协调时间（UTC）时间。在查询中返回的时间类型值为 UTC 时间。 !!! Note diff --git a/docs-2.0/3.ngql-guide/3.data-types/6.list.md b/docs-2.0/3.ngql-guide/3.data-types/6.list.md index 62ca00f18a..8de0357721 100644 --- a/docs-2.0/3.ngql-guide/3.data-types/6.list.md +++ b/docs-2.0/3.ngql-guide/3.data-types/6.list.md @@ -6,7 +6,7 @@ ## 列表操作 -对列表进行操作可以使用预设的 [列表函数](../6.functions-and-expressions/6.list.md)，也可以使用下标表达式过滤列表内的元素。 +对列表进行操作可以使用预设的[列表函数](../6.functions-and-expressions/6.list.md)，也可以使用下标表达式过滤列表内的元素。 ### 下标表达式语法 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 e01cc5d6d8..fb9f6eccac 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 @@ -23,7 +23,7 @@ nGQL 扩展的自定义变量可以表示为`$var_name`，`var_name`由字母、 自定义变量仅在当前执行（本复合查询中）有效，执行结束后变量也会释放，**不能**在其他客户端、执行、session 中使用之前的自定义变量。 -用户可以在复合查询中使用自定义变量。复合查询的详细信息请参见 [复合查询](1.composite-queries.md)。 +用户可以在复合查询中使用自定义变量。复合查询的详细信息请参见[复合查询](1.composite-queries.md)。 !!! Note 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 d406ada6e0..1b6168eaf9 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 @@ -9,7 +9,7 @@ Nebula Graph 支持的布尔符如下。 | NOT | 逻辑非 | | XOR | 逻辑异或 | -对于以上运算的优先级，请参见 [运算优先级](9.precedence.md)。 +对于以上运算的优先级，请参见[运算优先级](9.precedence.md)。 对于带有`NULL`的逻辑运算，请参见 [NULL](../3.data-types/5.null.md)。 diff --git a/docs-2.0/3.ngql-guide/5.operators/5.property-reference.md b/docs-2.0/3.ngql-guide/5.operators/5.property-reference.md index 4f1d98e12f..dac8474e92 100644 --- a/docs-2.0/3.ngql-guide/5.operators/5.property-reference.md +++ b/docs-2.0/3.ngql-guide/5.operators/5.property-reference.md @@ -10,9 +10,9 @@ nGQL 提供引用符来表示`WHERE`和`YIELD`子句中的属性，或者复合 |引用符|说明| |:---|:---| -|`$^`|引用起始点。更多信息请参见 [引用属性](../4.variable-and-composite-queries/3.property-reference.md)。| -|`$$`|引用目的点。更多信息请参见 [引用属性](../4.variable-and-composite-queries/3.property-reference.md)。| -|`$-`|引用复合查询中管道符之前的语句输出结果。更多信息请参见 [管道符](4.pipe.md)。| +|`$^`|引用起始点。更多信息请参见[引用属性](../4.variable-and-composite-queries/3.property-reference.md)。| +|`$$`|引用目的点。更多信息请参见[引用属性](../4.variable-and-composite-queries/3.property-reference.md)。| +|`$-`|引用复合查询中管道符之前的语句输出结果。更多信息请参见[管道符](4.pipe.md)。| ## 示例 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 af6b8d9bd2..338428bcad 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 @@ -18,7 +18,7 @@ - 运算符`UNION ALL`返回两个集合 A 和 B 的并集，包含重复的元素。 -- `left`和`right`必须有相同数量的列和数据类型。如果需要转换数据类型，请参见 [类型转换](../3.data-types/9.type-conversion.md)。 +- `left`和`right`必须有相同数量的列和数据类型。如果需要转换数据类型，请参见[类型转换](../3.data-types/9.type-conversion.md)。 ### 示例 @@ -71,7 +71,7 @@ nebula> GO FROM "player102" OVER follow \ - 运算符`INTERSECT`返回两个集合 A 和 B 的交集。 -- `left`和`right`必须有相同数量的列和数据类型。如果需要转换数据类型，请参见 [类型转换](../3.data-types/9.type-conversion.md)。 +- `left`和`right`必须有相同数量的列和数据类型。如果需要转换数据类型，请参见[类型转换](../3.data-types/9.type-conversion.md)。 ### 示例 diff --git a/docs-2.0/3.ngql-guide/6.functions-and-expressions/14.geo.md b/docs-2.0/3.ngql-guide/6.functions-and-expressions/14.geo.md index 0e50adb7f9..0c8ea9191a 100644 --- a/docs-2.0/3.ngql-guide/6.functions-and-expressions/14.geo.md +++ b/docs-2.0/3.ngql-guide/6.functions-and-expressions/14.geo.md @@ -2,7 +2,7 @@ geo 函数用于生成地理位置（GEOGRAPHY）数据类型的值或对其执行操作。 -关于地理位置数据类型说明请参见 [地理位置](../3.data-types/10.geography.md)。 +关于地理位置数据类型说明请参见[地理位置](../3.data-types/10.geography.md)。 ## 函数说明 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 22a835a214..63f200a61e 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 @@ -47,7 +47,7 @@ Nebula Graph 支持以下内置字符串函数。 - 如果`count`为 0，则返回空字符串。 -- 使用`NULL`作为任何参数会出现 [错误](https://github.com/vesoft-inc/nebula-graph/issues/878)。 +- 使用`NULL`作为任何参数会出现[错误](https://github.com/vesoft-inc/nebula-graph/issues/878)。 !!! compatibility "openCypher 兼容性" 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 0a0d58ff37..d4890d8dac 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`语句定义了一个 [搜索模式](../1.nGQL-overview/3.graph-patterns.md)，用该模式匹配存储在 Nebula Graph 中的数据，然后用`RETURN`子句检索数据。 +一个`MATCH`语句定义了一个[搜索模式](../1.nGQL-overview/3.graph-patterns.md)，用该模式匹配存储在 Nebula Graph 中的数据，然后用`RETURN`子句检索数据。 本文示例使用测试数据集 [basketballplayer](../1.nGQL-overview/1.overview.md#basketballplayer) 进行演示。 @@ -16,13 +16,13 @@ MATCH [] RETURN ; ## MATCH 工作流程 -1. `MATCH`语句使用原生索引查找起始点或边，起始点或边可以在模式的任何位置。即一个有效的`MATCH`语句，**必须有一个属性、Tag 或 Edge type 已经创建索引，或者在`WHERE`子句中用 id() 函数指定了特定点的 VID**。如何创建索引，请参见 [创建原生索引](../14.native-index-statements/1.create-native-index.md)。 +1. `MATCH`语句使用原生索引查找起始点或边，起始点或边可以在模式的任何位置。即一个有效的`MATCH`语句，**必须有一个属性、Tag 或 Edge type 已经创建索引，或者在`WHERE`子句中用 id() 函数指定了特定点的 VID**。如何创建索引，请参见[创建原生索引](../14.native-index-statements/1.create-native-index.md)。 2. `MATCH`语句在模式中搜索，寻找匹配的边或点。 !!! note - `MATCH`语句采用的路径类型是`trail`，即遍历时只有点可以重复，边不可以重复。详情请参见 [路径](../../1.introduction/2.1.path.md)。 + `MATCH`语句采用的路径类型是`trail`，即遍历时只有点可以重复，边不可以重复。详情请参见[路径](../../1.introduction/2.1.path.md)。 3. `MATCH`语句根据`RETURN`子句检索数据。 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 7550bbf2f0..94eab57fa9 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 @@ -33,11 +33,11 @@ OVER [{REVERSELY | BIDIRECT}] !!! note - `GO`语句采用的路径类型是`walk`，即遍历时点和边可以重复。详情参见 [路径](../../1.introduction/2.1.path.md)。 + `GO`语句采用的路径类型是`walk`，即遍历时点和边可以重复。详情参见[路径](../../1.introduction/2.1.path.md)。 - `M TO N STEPS`：遍历`M~N`跳的边。如果`M`为`0`，输出结果和`M`为`1`相同，即`GO 0 TO 2`和`GO 1 TO 2`是相同的。 -- ``：用逗号分隔的点 ID 列表，或特殊的引用符`$-.id`。详情参见 [管道符](../5.operators/4.pipe.md)。 +- ``：用逗号分隔的点 ID 列表，或特殊的引用符`$-.id`。详情参见[管道符](../5.operators/4.pipe.md)。 - ``：遍历的 Edge type 列表。 diff --git a/docs-2.0/3.ngql-guide/7.general-query-statements/4.fetch.md b/docs-2.0/3.ngql-guide/7.general-query-statements/4.fetch.md index 2a38839774..73240230be 100644 --- a/docs-2.0/3.ngql-guide/7.general-query-statements/4.fetch.md +++ b/docs-2.0/3.ngql-guide/7.general-query-statements/4.fetch.md @@ -236,4 +236,4 @@ nebula> $var = GO FROM "player101" OVER follow \ +-------------+-------------+--------------+-------------------------+ ``` -更多复合语句的详情，请参见 [复合查询（子句结构）](../4.variable-and-composite-queries/1.composite-queries.md)。 +更多复合语句的详情，请参见[复合查询（子句结构）](../4.variable-and-composite-queries/1.composite-queries.md)。 diff --git a/docs-2.0/3.ngql-guide/7.general-query-statements/5.lookup.md b/docs-2.0/3.ngql-guide/7.general-query-statements/5.lookup.md index f2b261763a..4f612809ae 100644 --- a/docs-2.0/3.ngql-guide/7.general-query-statements/5.lookup.md +++ b/docs-2.0/3.ngql-guide/7.general-query-statements/5.lookup.md @@ -30,7 +30,7 @@ ## 前提条件 -请确保`LOOKUP`语句有至少一个索引可用。如果需要创建索引，但是已经有相关的点、边或属性，用户必须在创建索引后 [重建索引](../14.native-index-statements/4.rebuild-native-index.md)，才能使其生效。 +请确保`LOOKUP`语句有至少一个索引可用。如果需要创建索引，但是已经有相关的点、边或属性，用户必须在创建索引后[重建索引](../14.native-index-statements/4.rebuild-native-index.md)，才能使其生效。 ## 语法 diff --git a/docs-2.0/3.ngql-guide/7.general-query-statements/6.show/10.show-roles.md b/docs-2.0/3.ngql-guide/7.general-query-statements/6.show/10.show-roles.md index 862a37eae3..55624fc9f7 100644 --- a/docs-2.0/3.ngql-guide/7.general-query-statements/6.show/10.show-roles.md +++ b/docs-2.0/3.ngql-guide/7.general-query-statements/6.show/10.show-roles.md @@ -10,7 +10,7 @@ - 如果登录的用户角色没有权限访问该图空间，则返回权限错误。 -关于角色的详情请参见 [内置角色权限](../../../7.data-security/1.authentication/3.role-list.md)。 +关于角色的详情请参见[内置角色权限](../../../7.data-security/1.authentication/3.role-list.md)。 ## 语法 diff --git a/docs-2.0/3.ngql-guide/7.general-query-statements/6.show/11.show-snapshots.md b/docs-2.0/3.ngql-guide/7.general-query-statements/6.show/11.show-snapshots.md index 6fc60082ab..9c055dc4c7 100644 --- a/docs-2.0/3.ngql-guide/7.general-query-statements/6.show/11.show-snapshots.md +++ b/docs-2.0/3.ngql-guide/7.general-query-statements/6.show/11.show-snapshots.md @@ -2,7 +2,7 @@ `SHOW SNAPSHOTS`语句显示所有快照信息。 -快照的使用方式请参见 [管理快照](../../../7.data-security/3.manage-snapshot.md)。 +快照的使用方式请参见[管理快照](../../../7.data-security/3.manage-snapshot.md)。 ## 角色要求 diff --git a/docs-2.0/3.ngql-guide/7.general-query-statements/6.show/18.show-queries.md b/docs-2.0/3.ngql-guide/7.general-query-statements/6.show/18.show-queries.md index 4a357aae77..3b6374e44f 100644 --- a/docs-2.0/3.ngql-guide/7.general-query-statements/6.show/18.show-queries.md +++ b/docs-2.0/3.ngql-guide/7.general-query-statements/6.show/18.show-queries.md @@ -4,7 +4,7 @@ !!! note - 如果需要终止查询，请参见 [终止查询](../../18.operation-and-maintenance-statements/6.kill-query.md)。 + 如果需要终止查询，请参见[终止查询](../../18.operation-and-maintenance-statements/6.kill-query.md)。 ## 注意事项 diff --git a/docs-2.0/3.ngql-guide/8.clauses-and-options/group-by.md b/docs-2.0/3.ngql-guide/8.clauses-and-options/group-by.md index d8b41afe4d..39544807ae 100644 --- a/docs-2.0/3.ngql-guide/8.clauses-and-options/group-by.md +++ b/docs-2.0/3.ngql-guide/8.clauses-and-options/group-by.md @@ -72,4 +72,4 @@ nebula> GO FROM "player100" OVER follow \ +----------------+ ``` -`sum()`函数详情请参见 [内置数学函数](../6.functions-and-expressions/1.math.md)。 +`sum()`函数详情请参见[内置数学函数](../6.functions-and-expressions/1.math.md)。 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 26663968cf..153cf34531 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 @@ -38,7 +38,7 @@ Nebula Graph 自动删除过期数据后，会在下一次 [Compaction](../../8. !!! Note - 如果 [关闭 TTL 选项](#ttl_1)，上一次 Compaction 之后的过期数据将可以被查询到。 + 如果[关闭 TTL 选项](#ttl_1)，上一次 Compaction 之后的过期数据将可以被查询到。 ## TTL 选项 diff --git a/docs-2.0/3.ngql-guide/8.clauses-and-options/where.md b/docs-2.0/3.ngql-guide/8.clauses-and-options/where.md index 73c3d55d41..555b1162c6 100644 --- a/docs-2.0/3.ngql-guide/8.clauses-and-options/where.md +++ b/docs-2.0/3.ngql-guide/8.clauses-and-options/where.md @@ -17,11 +17,11 @@ ## 基础用法 !!! note - 下文示例中的`$$`、`$^`等是引用符号，详情请参见 [引用符](../5.operators/5.property-reference.md)。 + 下文示例中的`$$`、`$^`等是引用符号，详情请参见[引用符](../5.operators/5.property-reference.md)。 ### 用布尔运算符定义条件 -在`WHERE`子句中使用布尔运算符`NOT`、`AND`、`OR`和`XOR`定义条件。关于运算符的优先级，请参见 [运算符优先级](../5.operators/9.precedence.md)。 +在`WHERE`子句中使用布尔运算符`NOT`、`AND`、`OR`和`XOR`定义条件。关于运算符的优先级，请参见[运算符优先级](../5.operators/9.precedence.md)。 ```ngql nebula> MATCH (v:player) \ diff --git a/docs-2.0/3.ngql-guide/8.clauses-and-options/with.md b/docs-2.0/3.ngql-guide/8.clauses-and-options/with.md index 65de0dfcd4..cc9f36fc29 100644 --- a/docs-2.0/3.ngql-guide/8.clauses-and-options/with.md +++ b/docs-2.0/3.ngql-guide/8.clauses-and-options/with.md @@ -8,7 +8,7 @@ !!! Note - 在原生 nGQL 中，有与`WITH`类似的 [管道符](../5.operators/4.pipe.md)，但它们的工作方式不同。不要在 openCypher 方式中使用管道符，也不要在原生 nGQL 中使用`WITH`子句。 + 在原生 nGQL 中，有与`WITH`类似的[管道符](../5.operators/4.pipe.md)，但它们的工作方式不同。不要在 openCypher 方式中使用管道符，也不要在原生 nGQL 中使用`WITH`子句。 ## 组成复合查询 diff --git a/docs-2.0/3.ngql-guide/8.clauses-and-options/yield.md b/docs-2.0/3.ngql-guide/8.clauses-and-options/yield.md index 42cce2d250..41b6fea717 100644 --- a/docs-2.0/3.ngql-guide/8.clauses-and-options/yield.md +++ b/docs-2.0/3.ngql-guide/8.clauses-and-options/yield.md @@ -23,7 +23,7 @@ - 在 nGQL 中，`YIELD`和 openCypher 中的`RETURN`类似。 !!! note - 下文示例中的`$$`、`$-`等是引用符号，详情请参见 [引用符](../5.operators/5.property-reference.md)。 + 下文示例中的`$$`、`$-`等是引用符号，详情请参见[引用符](../5.operators/5.property-reference.md)。 ## YIELD 子句 @@ -96,7 +96,7 @@ YIELD [DISTINCT] [AS ] [, [AS ] ...] ### 复合查询中使用 YIELD 语句 -在 [复合查询](../4.variable-and-composite-queries/1.composite-queries.md) 中，`YIELD`语句可以接收、过滤、修改之前语句的结果集，然后输出。 +在[复合查询](../4.variable-and-composite-queries/1.composite-queries.md) 中，`YIELD`语句可以接收、过滤、修改之前语句的结果集，然后输出。 ```ngql # 查找 player100 关注的 player，并计算他们的平均年龄。 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 bf81be5899..892444753a 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 @@ -4,7 +4,7 @@ ## 前提条件 -只有 God 角色的用户可以执行`CREATE SPACE`语句。详情请参见 [身份验证](../../7.data-security/1.authentication/1.authentication.md)。 +只有 God 角色的用户可以执行`CREATE SPACE`语句。详情请参见[身份验证](../../7.data-security/1.authentication/1.authentication.md)。 ## 语法 @@ -23,7 +23,7 @@ CREATE SPACE [IF NOT EXISTS] ( |参数|说明| |:---|:---| |`IF NOT EXISTS`|检测待创建的图空间是否存在，只有不存在时，才会创建图空间。仅检测图空间的名称，不会检测具体属性。| -|``|在 Nebula Graph 实例中唯一标识一个图空间。图空间名称由大小写英文字母、数字或下划线组成，区分大写小，且不可使用 [关键字和保留字](../../3.ngql-guide/1.nGQL-overview/keywords-and-reserved-words.md)。| +|``|在 Nebula Graph 实例中唯一标识一个图空间。图空间名称由大小写英文字母、数字或下划线组成，区分大写小，且不可使用[关键字和保留字](../../3.ngql-guide/1.nGQL-overview/keywords-and-reserved-words.md)。| |`partition_num`|指定图空间的分片数量。建议设置为 5 倍的集群硬盘数量。例如集群中有 3 个硬盘，建议设置 15 个分片。默认值为 100。| |`replica_factor`|指定每个分片的副本数量。建议在生产环境中设置为 3，在测试环境中设置为 1。由于需要基于多数表决，副本数量必须是**奇数**。默认值为 1。| |`vid_type`|必选参数。指定点 ID 的数据类型。可选值为`FIXED_STRING()`和`INT64`。`INT`等同于`INT64`。`FIXED_STRING()`表示数据类型为字符串，最大长度为`N`，超出长度会报错；`INT64`表示数据类型为整数。| @@ -58,7 +58,7 @@ CREATE SPACE AS ; |参数|说明| |:---|:---| -|``|目标图空间名称。该图空间必须未创建。图空间名称由大小写英文字母、数字或下划线组成，区分大写小，且不可使用 [关键字和保留字](../../3.ngql-guide/1.nGQL-overview/keywords-and-reserved-words.md)。创建时会克隆``图空间的 Schema，包括图空间本身参数（分片数量、副本数量等），以及 Tag、Edge type 和原生索引。| +|``|目标图空间名称。该图空间必须未创建。图空间名称由大小写英文字母、数字或下划线组成，区分大写小，且不可使用[关键字和保留字](../../3.ngql-guide/1.nGQL-overview/keywords-and-reserved-words.md)。创建时会克隆``图空间的 Schema，包括图空间本身参数（分片数量、副本数量等），以及 Tag、Edge type 和原生索引。| |``|原始图空间名称。该图空间必须已存在。| ## 示例 @@ -95,7 +95,7 @@ Nebula Graph 将在下一个心跳周期内完成图空间的创建，为了确 - 等待两个心跳周期，例如 20 秒。 -如果需要修改心跳间隔，请为 [所有配置文件](../../5.configurations-and-logs/1.configurations/1.configurations.md) 修改参数`heartbeat_interval_secs`。但过短的心跳周期（<5 秒）可能会导致分布式系统中的机器误判对端失联。 +如果需要修改心跳间隔，请为[所有配置文件](../../5.configurations-and-logs/1.configurations/1.configurations.md) 修改参数`heartbeat_interval_secs`。但过短的心跳周期（<5 秒）可能会导致分布式系统中的机器误判对端失联。 ## 检查分片分布情况 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 a13a87bc27..d2b40725f0 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 @@ -4,7 +4,7 @@ ## 前提条件 -执行`USE`语句指定图空间时，需要当前登录的用户拥有指定图空间的 [权限](../../7.data-security/1.authentication/1.authentication.md)，否则会报错。 +执行`USE`语句指定图空间时，需要当前登录的用户拥有指定图空间的[权限](../../7.data-security/1.authentication/1.authentication.md)，否则会报错。 ## 语法 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 1299736e90..89fee8f9b7 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 @@ -4,7 +4,7 @@ ## 前提条件 -只有 God 角色的用户可以执行`DROP SPACE`语句。详情请参见 [身份验证](../../7.data-security/1.authentication/1.authentication.md)。 +只有 God 角色的用户可以执行`DROP SPACE`语句。详情请参见[身份验证](../../7.data-security/1.authentication/1.authentication.md)。 ## 语法 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 9dc5f7d23d..920822cb25 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 @@ -30,7 +30,7 @@ ### 软件要求 -软件版本需要如下表所示，如果它们不符合要求，或者也不确定它们的版本，请按照 [安装编译所需软件](#_5) 中的步骤进行操作。 +软件版本需要如下表所示，如果它们不符合要求，或者也不确定它们的版本，请按照[安装编译所需软件](#_5) 中的步骤进行操作。 | 软件名称 | 版本 | 备注 | | ---------------- | ---------- | ----------------------------------------| @@ -105,7 +105,7 @@ gettext ``` -2. 检查主机上的 GCC 和 CMake 版本是否正确。版本信息请参见 [软件要求](#_4)。 +2. 检查主机上的 GCC 和 CMake 版本是否正确。版本信息请参见[软件要求](#_4)。 ```bash $ g++ --version @@ -205,7 +205,7 @@ 当前仅支持在 Linux 系统中安装 Nebula Graph，建议在生产环境中使用内核版本为`3.9`及以上版本的 Linux 系统。 -用户可以通过调整一些内核参数来提高 Nebula Graph 性能，详情请参见 [内核配置](../5.configurations-and-logs/1.configurations/6.kernel-config.md)。 +用户可以通过调整一些内核参数来提高 Nebula Graph 性能，详情请参见[内核配置](../5.configurations-and-logs/1.configurations/6.kernel-config.md)。 ### 服务架构建议 @@ -239,7 +239,7 @@ storaged 进程的数量不会影响图空间副本的数量。 | 资源 |单位 | 计算公式 |说明| |:--- |:---|:--- |:---| -| 硬盘空间 |Bytes| `点和边的总数` * `属性的平均字节大小` * 6 * 120% |由于边存在存储放大现象，所以需要`点和边的总数` * `属性的平均字节大小` * 6 的空间，详情请参见 [切边与存储放大](../1.introduction/3.nebula-graph-architecture/4.storage-service.md)。| +| 硬盘空间 |Bytes| `点和边的总数` * `属性的平均字节大小` * 6 * 120% |由于边存在存储放大现象，所以需要`点和边的总数` * `属性的平均字节大小` * 6 的空间，详情请参见[切边与存储放大](../1.introduction/3.nebula-graph-architecture/4.storage-service.md)。| | 内存 |Bytes| [`点和边的总数` * 15 + `RocksDB 实例数量` * (`write_buffer_size` * `max_write_buffer_number` + `块缓存大小`)] * 120% |`点和边的总数` * 15 是 [BloomFilter](https://zh.wikipedia.org/wiki/%E5%B8%83%E9%9A%86%E8%BF%87%E6%BB%A4%E5%99%A8) 需要占用的内存空间，`write_buffer_size`和`max_write_buffer_number`是 RocksDB 内存相关参数，详情请参见 [MemTable](https://github.com/facebook/rocksdb/wiki/MemTable)。块缓存大小请参见 [Memory usage in RocksDB](https://github.com/facebook/rocksdb/wiki/Memory-usage-in-RocksDB#block-cache)。| | 分区数量 |-| `集群硬盘数量` * `disk_partition_num_multiplier` |`disk_partition_num_multiplier`是取值为 2~10 的一个整数，用于衡量硬盘性能。HDD 使用 2。| @@ -273,4 +273,4 @@ Nebula Graph 是针对 NVMe SSD 进行设计和实现的，所有默认参数都 !!! enterpriseonly - Nebula Graph {{ nebula.release }} 不支持直接在 ARM 架构上运行。访问官网获取 [商业支持](https://nebula-graph.com.cn/pricing/)。 + Nebula Graph {{ nebula.release }} 不支持直接在 ARM 架构上运行。访问官网获取[商业支持](https://nebula-graph.com.cn/pricing/)。 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 f2fdf36c81..0d1c5445c8 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 @@ -4,7 +4,7 @@ ## 前提条件 -- 准备正确的编译环境。参见 [软硬件要求和安装三方库依赖包](../1.resource-preparations.md)。 +- 准备正确的编译环境。参见[软硬件要求和安装三方库依赖包](../1.resource-preparations.md)。 !!! note @@ -60,7 +60,7 @@ !!! Note - 检查 [软硬件要求和安装三方库依赖包](../1.resource-preparations.md)。 + 检查[软硬件要求和安装三方库依赖包](../1.resource-preparations.md)。 为了适当地加快编译速度，可以使用选项`-j`并行编译。并行数量`N`建议为$\min(\text{CPU}核数，\frac{内存 (GB)}{2})$。 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 bd1937e691..803a79b698 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 @@ -57,7 +57,7 @@ !!! Note - 上述服务的更多信息，请参见 [架构总览](../../1.introduction/3.nebula-graph-architecture/1.architecture-overview.md)。 + 上述服务的更多信息，请参见[架构总览](../../1.introduction/3.nebula-graph-architecture/1.architecture-overview.md)。 4. 连接 Nebula Graph。 @@ -88,7 +88,7 @@ !!! Note - 默认情况下，身份认证功能是关闭的，只能使用已存在的用户名（默认为`root`）和任意密码登录。如果想使用身份认证，请参见 [身份认证](../../7.data-security/1.authentication/1.authentication.md)。 + 默认情况下，身份认证功能是关闭的，只能使用已存在的用户名（默认为`root`）和任意密码登录。如果想使用身份认证，请参见[身份认证](../../7.data-security/1.authentication/1.authentication.md)。 3. 执行如下命令检查`nebula-storaged`进程状态。 @@ -204,7 +204,7 @@ Removing network nebula-docker-compose_nebula-net Docker Compose 部署的 Nebula Graph，配置文件位置为`nebula-docker-compose/docker-compose.yaml`，修改该文件内的配置并重启服务即可使新配置生效。 -具体的配置说明请参见 [配置管理](../../5.configurations-and-logs/1.configurations/1.configurations.md)。 +具体的配置说明请参见[配置管理](../../5.configurations-and-logs/1.configurations/1.configurations.md)。 ## 常见问题 @@ -259,7 +259,7 @@ docker pull vesoft/nebula-console:{{console.branch}} ### 为什么更新 nebula-docker-compose 仓库后，无法访问数据？（2021 年 01 月 04 日） -如果在 2021 年 01 月 04 日后更新过 nebula-docker-compose 仓库，而且之前已经有数据，请修改文件`docker-compose.yaml`，将端口修改为之前使用的端口。详情请参见 [修改默认端口](https://github.com/vesoft-inc/nebula-docker-compose/commit/2a612f1c4f0e2c31515e971b24b355b3be69420a)。 +如果在 2021 年 01 月 04 日后更新过 nebula-docker-compose 仓库，而且之前已经有数据，请修改文件`docker-compose.yaml`，将端口修改为之前使用的端口。详情请参见[修改默认端口](https://github.com/vesoft-inc/nebula-docker-compose/commit/2a612f1c4f0e2c31515e971b24b355b3be69420a)。 ### 为什么更新 nebula-docker-compose 仓库后，无法访问数据？（2021 年 01 月 27 日） diff --git a/docs-2.0/4.deployment-and-installation/2.compile-and-install-nebula-graph/4.install-nebula-graph-from-tar.md b/docs-2.0/4.deployment-and-installation/2.compile-and-install-nebula-graph/4.install-nebula-graph-from-tar.md index 2d08ff9b4b..d66fc47656 100644 --- a/docs-2.0/4.deployment-and-installation/2.compile-and-install-nebula-graph/4.install-nebula-graph-from-tar.md +++ b/docs-2.0/4.deployment-and-installation/2.compile-and-install-nebula-graph/4.install-nebula-graph-from-tar.md @@ -62,7 +62,7 @@ 3. 修改配置文件名以应用配置。 - 进入解压出的目录，将子目录`etc`中的文件`nebula-graphd.conf.default`、`nebula-metad.conf.default`和`nebula-storaged.conf.default`重命名，删除`.default`，即可应用 Nebula Graph 的默认配置。如需修改配置，参见 [配置管理](../../5.configurations-and-logs/1.configurations/1.configurations.md)。 + 进入解压出的目录，将子目录`etc`中的文件`nebula-graphd.conf.default`、`nebula-metad.conf.default`和`nebula-storaged.conf.default`重命名，删除`.default`，即可应用 Nebula Graph 的默认配置。如需修改配置，参见[配置管理](../../5.configurations-and-logs/1.configurations/1.configurations.md)。 至此，Nebula Graph 安装完毕。 diff --git a/docs-2.0/4.deployment-and-installation/2.compile-and-install-nebula-graph/deploy-nebula-graph-cluster.md b/docs-2.0/4.deployment-and-installation/2.compile-and-install-nebula-graph/deploy-nebula-graph-cluster.md index 5a79946138..daba642615 100644 --- a/docs-2.0/4.deployment-and-installation/2.compile-and-install-nebula-graph/deploy-nebula-graph-cluster.md +++ b/docs-2.0/4.deployment-and-installation/2.compile-and-install-nebula-graph/deploy-nebula-graph-cluster.md @@ -278,7 +278,7 @@ sudo /usr/local/nebula/scripts/nebula.service start - 当需都启动 graphd、storaged 和 metad 时，可以用 all 代替。 - - `/usr/local/nebula`是 Nebula Graph 的默认安装路径，如果修改过安装路径，请使用实际路径。更多启停服务的内容，请参见 [管理 Nebula Graph 服务](../../2.quick-start/5.start-stop-service.md)。 + - `/usr/local/nebula`是 Nebula Graph 的默认安装路径，如果修改过安装路径，请使用实际路径。更多启停服务的内容，请参见[管理 Nebula Graph 服务](../../2.quick-start/5.start-stop-service.md)。 ### 4. 检查集群 diff --git a/docs-2.0/4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-from-200-to-latest.md b/docs-2.0/4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-from-200-to-latest.md index 1544617414..b5952f4c24 100644 --- a/docs-2.0/4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-from-200-to-latest.md +++ b/docs-2.0/4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-from-200-to-latest.md @@ -1,16 +1,16 @@ # 升级 Nebula Graph v2.0.x 至 v{{nebula.release}} -Nebula Graph v2.0.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) 之后重新安装。 +Nebula Graph v2.0.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) 之后重新安装。 !!! note - Nebula Graph v2.0.x 指 v2.0.0-GA 和 v2.0.1 版本。如果 Nebula Graph 版本过低（v2.0.0-RC、v2.0.0-beta、v1.x），请参见 [升级 Nebula Graph 历史版本至 v{{nebula.release}}](upgrade-nebula-graph-to-latest.md)。 + Nebula Graph v2.0.x 指 v2.0.0-GA 和 v2.0.1 版本。如果 Nebula Graph 版本过低（v2.0.0-RC、v2.0.0-beta、v1.x），请参见[升级 Nebula Graph 历史版本至 v{{nebula.release}}](upgrade-nebula-graph-to-latest.md)。 ## RPM/DEB 包升级步骤 1. 下载 [RPM/DEB 包](https://github.com/vesoft-inc/nebula-graph/releases/tag/v{{nebula.release}})。 -2. 停止所有 Nebula Graph 服务。详情请参见 [管理 Nebula Graph 服务](../../2.quick-start/5.start-stop-service.md)。建议更新前备份配置文件。 +2. 停止所有 Nebula Graph 服务。详情请参见[管理 Nebula Graph 服务](../../2.quick-start/5.start-stop-service.md)。建议更新前备份配置文件。 3. 执行如下命令升级： @@ -31,13 +31,13 @@ Nebula Graph v2.0.x 升级至 v{{nebula.release}}，只需要使用 v{{nebula.re $ sudo dpkg -i ``` -4. 在每台服务器上启动所需的服务。详情请参见 [管理 Nebula Graph 服务](../../2.quick-start/5.start-stop-service.md#_1)。 +4. 在每台服务器上启动所需的服务。详情请参见[管理 Nebula Graph 服务](../../2.quick-start/5.start-stop-service.md#_1)。 ## 编译新版本源码升级步骤 1. 备份旧版本的配置文件。配置文件保存在 Nebula Graph 安装路径的`etc`目录内。 -2. 更新仓库并编译源码。详情请参见 [使用源码安装 Nebula Graph](../2.compile-and-install-nebula-graph/1.install-nebula-graph-by-compiling-the-source-code.md)。 +2. 更新仓库并编译源码。详情请参见[使用源码安装 Nebula Graph](../2.compile-and-install-nebula-graph/1.install-nebula-graph-by-compiling-the-source-code.md)。 !!! 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 df44afa4c1..7c88c30126 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 @@ -89,9 +89,9 @@ Nebula Graph 历史版本指低于 Nebula Graph v2.0.0-GA 的版本，本文介 # sudo dpkg -i --instdir==${nebula-new} ${nebula-package-name.deb} # for ubuntu ``` - 具体步骤请参见 [从 RPM/DEB 安装](../2.compile-and-install-nebula-graph/2.install-nebula-graph-by-rpm-or-deb.md)。 + 具体步骤请参见[从 RPM/DEB 安装](../2.compile-and-install-nebula-graph/2.install-nebula-graph-by-rpm-or-deb.md)。 - - 如果从源代码安装。具体步骤请参见 [从源代码安装](../2.compile-and-install-nebula-graph/1.install-nebula-graph-by-compiling-the-source-code.md)。这里列出几个关键命令： + - 如果从源代码安装。具体步骤请参见[从源代码安装](../2.compile-and-install-nebula-graph/1.install-nebula-graph-by-compiling-the-source-code.md)。这里列出几个关键命令： - clone 源代码 @@ -138,7 +138,7 @@ Nebula Graph 历史版本指低于 Nebula Graph v2.0.0-GA 的版本，本文介 `--null_type=false`: 升级后的 Schema 的属性是否要支持 [`NULL`](../../3.ngql-guide/3.data-types/5.null.md)，**默认为 true**。不希望支持 NULL 的话，设置为 false。此时，升级后的 Schema 如果要增加属性（ALTER TAG/EDGE）必须指定 [default 值](../../3.ngql-guide/10.tag-statements/1.create-tag.md)，否则会读不出数据。 - `--string_index_limit=32`: 升级后 string 对应的 [索引的长度](../../3.ngql-guide/14.native-index-statements/1.create-native-index.md)，不加的话系统默认为 64。 + `--string_index_limit=32`: 升级后 string 对应的[索引的长度](../../3.ngql-guide/14.native-index-statements/1.create-native-index.md)，不加的话系统默认为 64。 !!! Note @@ -255,7 +255,7 @@ Nebula Graph 历史版本指低于 Nebula Graph v2.0.0-GA 的版本，本文介 如果有 graphd 未正常启动，请将日志`${nebula-new}/logs/`在论坛提交问题。**放弃本次升级，关闭所有已经启动的 metad,storaged,graphd. 在原目录正常启动 nebula 服务。** -10. 使用 [新版本 Nebula Console](https://github.com/vesoft-inc/nebula-console) 连接新的 Nebula Graph，验证服务是否可用、数据是否正常。命令行参数，如 graphd 的 IP、端口都不变。 +10. 使用[新版本 Nebula Console](https://github.com/vesoft-inc/nebula-console) 连接新的 Nebula Graph，验证服务是否可用、数据是否正常。命令行参数，如 graphd 的 IP、端口都不变。 ```ngql nebula> SHOW HOSTS; 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 bd641eadcb..2bbab7228c 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 @@ -8,7 +8,7 @@ ## 前提条件 -停止 Nebula Graph 服务。详情参见 [管理 Nebula Graph 服务](../2.quick-start/5.start-stop-service.md)。 +停止 Nebula Graph 服务。详情参见[管理 Nebula Graph 服务](../2.quick-start/5.start-stop-service.md)。 ## 步骤 1：删除数据和元数据文件 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 24598f4c30..594fbc40f0 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 @@ -4,11 +4,11 @@ Nebula Graph 的全文索引是基于 [Elasticsearch](https://en.wikipedia.org/w ## 注意事项 -使用全文索引前，请确认已经了解全文索引的 [使用限制](../../4.deployment-and-installation/6.deploy-text-based-index/1.text-based-index-restrictions.md)。 +使用全文索引前，请确认已经了解全文索引的[使用限制](../../4.deployment-and-installation/6.deploy-text-based-index/1.text-based-index-restrictions.md)。 ## 部署 Elasticsearch 集群 -部署 Elasticsearch 集群请参见 [Kubernetes 安装 Elasticsearch](https://www.elastic.co/guide/en/cloud-on-k8s/current/k8s-deploy-elasticsearch.html) 或 [单机安装 Elasticsearch](https://www.elastic.co/guide/en/elasticsearch/reference/7.15/targz.html)。 +部署 Elasticsearch 集群请参见 [Kubernetes 安装 Elasticsearch](https://www.elastic.co/guide/en/cloud-on-k8s/current/k8s-deploy-elasticsearch.html) 或[单机安装 Elasticsearch](https://www.elastic.co/guide/en/elasticsearch/reference/7.15/targz.html)。 当 Elasticsearch 集群启动时，请添加 Nebula Graph 全文索引的模板文件。关于索引模板的说明请参见 [Elasticsearch 官方文档](https://www.elastic.co/guide/en/elasticsearch/reference/current/index-templates.html)。 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 a49a2b0bda..4d77ae8773 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 @@ -4,11 +4,11 @@ ## 前提条件 -- 已经了解全文索引的 [使用限制](../../4.deployment-and-installation/6.deploy-text-based-index/1.text-based-index-restrictions.md)。 +- 已经了解全文索引的[使用限制](../../4.deployment-and-installation/6.deploy-text-based-index/1.text-based-index-restrictions.md)。 -- 已经 [部署 Nebula Graph 集群](../2.compile-and-install-nebula-graph/deploy-nebula-graph-cluster.md)。 +- 已经[部署 Nebula Graph 集群](../2.compile-and-install-nebula-graph/deploy-nebula-graph-cluster.md)。 -- 完成 [部署 Elasticsearch 集群](./2.deploy-es.md)。 +- 完成[部署 Elasticsearch 集群](./2.deploy-es.md)。 - 准备一台或者多台额外的服务器，来部署 Raft listener。 @@ -22,11 +22,11 @@ ### 第一步：安装 Storage 服务 -listener 进程与 storaged 进程使用相同的二进制文件，但是二者配置文件不同，进程使用端口也不同，可以在所有需要部署 listener 的服务器上都安装 Nebula Graph，但是仅使用 Storage 服务。详情请参见 [使用 RPM 或 DEB 安装包安装 Nebula Graph](../2.compile-and-install-nebula-graph/2.install-nebula-graph-by-rpm-or-deb.md)。 +listener 进程与 storaged 进程使用相同的二进制文件，但是二者配置文件不同，进程使用端口也不同，可以在所有需要部署 listener 的服务器上都安装 Nebula Graph，但是仅使用 Storage 服务。详情请参见[使用 RPM 或 DEB 安装包安装 Nebula Graph](../2.compile-and-install-nebula-graph/2.install-nebula-graph-by-rpm-or-deb.md)。 ### 第二步：准备 listener 的配置文件 -用户必须在需要部署 listener 的机器上准备对应的配置文件，文件名称必须为`nebula-storaged-listener.conf`，并保存在安装路径下的`etc`目录内。用户可以参考提供的 [模板](https://github.com/vesoft-inc/nebula/blob/master/conf/nebula-storaged-listener.conf.production)。注意去掉文件后缀`.production`。 +用户必须在需要部署 listener 的机器上准备对应的配置文件，文件名称必须为`nebula-storaged-listener.conf`，并保存在安装路径下的`etc`目录内。用户可以参考提供的[模板](https://github.com/vesoft-inc/nebula/blob/master/conf/nebula-storaged-listener.conf.production)。注意去掉文件后缀`.production`。 大部分配置与 [Storage 服务](../../5.configurations-and-logs/1.configurations/4.storage-config.md) 的配置文件相同，本文仅介绍差异部分。 @@ -111,4 +111,4 @@ nebula> REMOVE LISTENER ELASTICSEARCH; ## 下一步 -部署 [全文索引](2.deploy-es.md) 和 listener 后，全文索引会在 Elasticsearch 集群中自动创建，用户可以开始进行全文搜索。详情请参见 [全文搜索](../../3.ngql-guide/15.full-text-index-statements/1.search-with-text-based-index.md)。 +部署[全文索引](2.deploy-es.md) 和 listener 后，全文索引会在 Elasticsearch 集群中自动创建，用户可以开始进行全文搜索。详情请参见[全文搜索](../../3.ngql-guide/15.full-text-index-statements/1.search-with-text-based-index.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 bba60080fe..8c1455e049 100644 --- a/docs-2.0/4.deployment-and-installation/deploy-license.md +++ b/docs-2.0/4.deployment-and-installation/deploy-license.md @@ -60,7 +60,7 @@ License 文件包含生效时间、过期时间等信息。说明如下。 1. 发送邮件至`inquiry@vesoft.com`申请 Nebula Graph 企业版安装包。 -2. 安装 Nebula Graph 企业版。安装方式与社区版相同，请参见 [使用 RPM 或 DEB 包安装 Nebula Graph](2.compile-and-install-nebula-graph/2.install-nebula-graph-by-rpm-or-deb.md)。 +2. 安装 Nebula Graph 企业版。安装方式与社区版相同，请参见[使用 RPM 或 DEB 包安装 Nebula Graph](2.compile-and-install-nebula-graph/2.install-nebula-graph-by-rpm-or-deb.md)。 3. 发送邮件至`inquiry@vesoft.com`申请 License 文件`nebula.license`。 @@ -68,4 +68,4 @@ License 文件包含生效时间、过期时间等信息。说明如下。 !!! note - 周边工具的 License 文件上传位置，请参见 [具体周边工具](../20.appendix/6.eco-tool-version.md) 的说明文档。 + 周边工具的 License 文件上传位置，请参见[具体周边工具](../20.appendix/6.eco-tool-version.md) 的说明文档。 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 0ecc458244..16e4102539 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 @@ # 配置管理 -Nebula Graph 基于 [gflags](https://gflags.github.io/gflags/) 库打造了系统配置，多数配置项都是其中的 flags。Nebula Graph 服务启动时，默认会从 [配置文件](#_4) 中获取配置信息，文件中没有的配置项应用默认值。 +Nebula Graph 基于 [gflags](https://gflags.github.io/gflags/) 库打造了系统配置，多数配置项都是其中的 flags。Nebula Graph 服务启动时，默认会从[配置文件](#_4) 中获取配置信息，文件中没有的配置项应用默认值。 !!! enterpriseonly 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 9c0d33dc90..0a4fb25b95 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,7 +15,7 @@ Meta 服务提供了两份初始配置文件`nebula-metad.conf.default`和`nebul 配置文件内没有设置某个参数表示参数使用的是默认值。文件内只预设了部分参数的值，而且两份初始配置文件内的参数值也略有不同，本文的预设值以`nebula-metad.conf.default`为准。 -如需查看所有的参数及其当前值，参见 [配置管理](1.configurations.md)。 +如需查看所有的参数及其当前值，参见[配置管理](1.configurations.md)。 ## basics 配置 @@ -27,7 +27,7 @@ Meta 服务提供了两份初始配置文件`nebula-metad.conf.default`和`nebul !!! Note - * 在插入 [时间类型](../../3.ngql-guide/3.data-types/4.date-and-time.md) 的属性值时，Nebula Graph 会根据`timezone_name`设置的时区将该时间值（TIMESTAMP 类型例外）转换成相应的 UTC 时间，因此在查询中返回的时间类型属性值为 UTC 时间。 + * 在插入[时间类型](../../3.ngql-guide/3.data-types/4.date-and-time.md) 的属性值时，Nebula Graph 会根据`timezone_name`设置的时区将该时间值（TIMESTAMP 类型例外）转换成相应的 UTC 时间，因此在查询中返回的时间类型属性值为 UTC 时间。 * `timezone_name`参数只用于转换 Nebula Graph 中存储的数据，Nebula Graph 进程中其它时区相关数据，例如日志打印的时间等，仍然使用主机系统默认的时区。 ## logging 配置 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 715434cce4..e62918eb61 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,7 +15,7 @@ Graph 服务提供了两份初始配置文件`nebula-graphd.conf.default`和`neb 配置文件内没有设置某个参数表示参数使用的是默认值。文件内只预设了部分参数的值，而且两份初始配置文件内的参数值也略有不同，本文的预设值以`nebula-metad.conf.default`为准。 -如需查看所有的参数及其当前值，参见 [配置管理](1.configurations.md)。 +如需查看所有的参数及其当前值，参见[配置管理](1.configurations.md)。 ## basics 配置 @@ -29,7 +29,7 @@ Graph 服务提供了两份初始配置文件`nebula-graphd.conf.default`和`neb !!! Note - * 在插入 [时间类型](../../3.ngql-guide/3.data-types/4.date-and-time.md) 的属性值时，Nebula Graph 会根据`timezone_name`设置的时区将该时间值（TIMESTAMP 类型例外）转换成相应的 UTC 时间，因此在查询中返回的时间类型属性值为 UTC 时间。 + * 在插入[时间类型](../../3.ngql-guide/3.data-types/4.date-and-time.md) 的属性值时，Nebula Graph 会根据`timezone_name`设置的时区将该时间值（TIMESTAMP 类型例外）转换成相应的 UTC 时间，因此在查询中返回的时间类型属性值为 UTC 时间。 * `timezone_name`参数只用于转换 Nebula Graph 中存储的数据，Nebula Graph 进程中其它时区相关数据，例如日志打印的时间等，仍然使用主机系统默认的时区。 ## logging 配置 @@ -90,7 +90,7 @@ Graph 服务提供了两份初始配置文件`nebula-graphd.conf.default`和`neb | 名称 | 预设值 | 说明 | | ------------------- | ---------------- | ------------------------------------------ | -|`enable_authorize` |`false` |用户登录时是否进行身份验证。身份验证详情请参见 [身份验证](../../7.data-security/1.authentication/1.authentication.md)。| +|`enable_authorize` |`false` |用户登录时是否进行身份验证。身份验证详情请参见[身份验证](../../7.data-security/1.authentication/1.authentication.md)。| |`auth_type` |`password` |用户登录的身份验证方式。取值为`password`、`ldap`、`cloud`。| ## memory 配置 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 c88708a312..a5c1557c5f 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 @@ -17,9 +17,9 @@ Storage 服务提供了两份初始配置文件`nebula-storaged.conf.default`和 !!! Note - Raft Listener 的配置和 Storage 服务配置不同，详情请参见 [部署 Raft listener](../../4.deployment-and-installation/6.deploy-text-based-index/3.deploy-listener.md)。 + Raft Listener 的配置和 Storage 服务配置不同，详情请参见[部署 Raft listener](../../4.deployment-and-installation/6.deploy-text-based-index/3.deploy-listener.md)。 -如需查看所有的参数及其当前值，参见 [配置管理](1.configurations.md)。 +如需查看所有的参数及其当前值，参见[配置管理](1.configurations.md)。 ## basics 配置 @@ -32,7 +32,7 @@ Storage 服务提供了两份初始配置文件`nebula-storaged.conf.default`和 !!! Note - * 在插入 [时间类型](../../3.ngql-guide/3.data-types/4.date-and-time.md) 的属性值时，Nebula Graph 会根据`timezone_name`设置的时区将该时间值（TIMESTAMP 类型例外）转换成相应的 UTC 时间，因此在查询中返回的时间类型属性值为 UTC 时间。 + * 在插入[时间类型](../../3.ngql-guide/3.data-types/4.date-and-time.md) 的属性值时，Nebula Graph 会根据`timezone_name`设置的时区将该时间值（TIMESTAMP 类型例外）转换成相应的 UTC 时间，因此在查询中返回的时间类型属性值为 UTC 时间。 * `timezone_name`参数只用于转换 Nebula Graph 中存储的数据，Nebula Graph 进程中其它时区相关数据，例如日志打印的时间等，仍然使用主机系统默认的时区。 ## logging 配置 diff --git a/docs-2.0/5.configurations-and-logs/2.log-management/logs.md b/docs-2.0/5.configurations-and-logs/2.log-management/logs.md index 7f81e57684..85d6f3dee3 100644 --- a/docs-2.0/5.configurations-and-logs/2.log-management/logs.md +++ b/docs-2.0/5.configurations-and-logs/2.log-management/logs.md @@ -53,8 +53,8 @@ $ curl -X PUT -H "Content-Type: application/json" -d '{"":[,"": |参数|说明| |:---|:---| -|`key`|待修改的日志类型，可选值请参见 [配置说明](#_3)。| -|`value`|日志级别，可选值请参见 [配置说明](#_3)。| +|`key`|待修改的日志类型，可选值请参见[配置说明](#_3)。| +|`value`|日志级别，可选值请参见[配置说明](#_3)。| |`ws_ip`|HTTP 服务的 IP 地址，可以在配置文件中查看。默认值为`127.0.0.1`。| |`ws_port`|HTTP 服务的端口，可以在配置文件中查看。默认值分别为`19559`（Meta）、`19669`（Graph）`19779`（Storage）。| @@ -67,7 +67,7 @@ $ curl -X PUT -H "Content-Type: application/json" -d '{"minloglevel":0,"v":3}' " ``` -如果在 Nebula Graph 运行时修改了日志级别，重启服务后会恢复为配置文件中设置的级别，如果需要永久修改，请修改 [配置文件](../1.configurations/1.configurations.md)。 +如果在 Nebula Graph 运行时修改了日志级别，重启服务后会恢复为配置文件中设置的级别，如果需要永久修改，请修改[配置文件](../1.configurations/1.configurations.md)。 ## RocksDB 日志 diff --git a/docs-2.0/7.data-security/1.authentication/1.authentication.md b/docs-2.0/7.data-security/1.authentication/1.authentication.md index e97eeaed45..0c0865b998 100644 --- a/docs-2.0/7.data-security/1.authentication/1.authentication.md +++ b/docs-2.0/7.data-security/1.authentication/1.authentication.md @@ -22,7 +22,7 @@ Nebula Graph 支持两种身份验证方式：本地身份验证和 LDAP 验证 !!! Note - 开启身份验证后，默认的 God 角色账号为`root`，密码为`nebula`。角色详情请参见 [内置角色权限](3.role-list.md)。 + 开启身份验证后，默认的 God 角色账号为`root`，密码为`nebula`。角色详情请参见[内置角色权限](3.role-list.md)。 ## OpenLDAP 验证 @@ -32,4 +32,4 @@ OpenLDAP 是轻型目录访问协议（LDAP）的开源实现，可以实现账 !!! Enterpriseonly - 当前仅企业版支持集成 OpenLDAP 进行身份验证，详情请参见 [使用 OpenLDAP 进行身份验证](4.ldap.md)。 + 当前仅企业版支持集成 OpenLDAP 进行身份验证，详情请参见[使用 OpenLDAP 进行身份验证](4.ldap.md)。 diff --git a/docs-2.0/7.data-security/1.authentication/2.management-user.md b/docs-2.0/7.data-security/1.authentication/2.management-user.md index 83a95bc43b..a68ebd6a44 100644 --- a/docs-2.0/7.data-security/1.authentication/2.management-user.md +++ b/docs-2.0/7.data-security/1.authentication/2.management-user.md @@ -2,7 +2,7 @@ 用户管理是 Nebula Graph 访问控制中不可或缺的组成部分，本文将介绍用户管理的相关语法。 -开启 [身份验证](1.authentication.md) 后，用户需要使用已创建的用户才能连接 Nebula Graph，而且连接后可以进行的操作也取决于该用户拥有的 [角色权限](3.role-list.md)。 +开启[身份验证](1.authentication.md) 后，用户需要使用已创建的用户才能连接 Nebula Graph，而且连接后可以进行的操作也取决于该用户拥有的[角色权限](3.role-list.md)。 !!! Note @@ -27,7 +27,7 @@ ## 授权用户（`GRANT ROLE`） -执行`GRANT ROLE`语句可以将指定图空间的内置角色权限授予用户。当前仅** God **角色用户和** Admin **角色用户能够执行`GRANT ROLE`语句。角色权限的说明，请参见 [内置角色权限](3.role-list.md)。 +执行`GRANT ROLE`语句可以将指定图空间的内置角色权限授予用户。当前仅** God **角色用户和** Admin **角色用户能够执行`GRANT ROLE`语句。角色权限的说明，请参见[内置角色权限](3.role-list.md)。 - 语法 @@ -43,7 +43,7 @@ ## 撤销用户权限（`REVOKE ROLE`） -执行`REVOKE ROLE`语句可以撤销用户的指定图空间的内置角色权限。当前仅** God **角色用户和** Admin **角色用户能够执行`REVOKE ROLE`语句。角色权限的说明，请参见 [内置角色权限](3.role-list.md)。 +执行`REVOKE ROLE`语句可以撤销用户的指定图空间的内置角色权限。当前仅** God **角色用户和** Admin **角色用户能够执行`REVOKE ROLE`语句。角色权限的说明，请参见[内置角色权限](3.role-list.md)。 - 语法 diff --git a/docs-2.0/7.data-security/1.authentication/3.role-list.md b/docs-2.0/7.data-security/1.authentication/3.role-list.md index d07beb46ec..7a40151744 100644 --- a/docs-2.0/7.data-security/1.authentication/3.role-list.md +++ b/docs-2.0/7.data-security/1.authentication/3.role-list.md @@ -1,6 +1,6 @@ # 内置角色权限 -所谓角色，就是一组相关权限的集合。用户可以把角色分配给 [创建的用户](2.management-user.md)，从而实现访问控制。 +所谓角色，就是一组相关权限的集合。用户可以把角色分配给[创建的用户](2.management-user.md)，从而实现访问控制。 ## 内置角色 @@ -49,7 +49,7 @@ Nebula Graph 内置了多种角色，说明如下： !!! Note * 不支持自行创建角色，只能使用默认的内置角色。 - * 一个用户在一个图空间内只能拥有一个角色权限。授权用户请参见 [用户管理](2.management-user.md)。 + * 一个用户在一个图空间内只能拥有一个角色权限。授权用户请参见[用户管理](2.management-user.md)。 ## 角色权限 各角色的执行权限如下。 diff --git a/docs-2.0/7.data-security/2.backup-restore/3.br-backup-data.md b/docs-2.0/7.data-security/2.backup-restore/3.br-backup-data.md index d02bcf9169..6bad9f2e07 100644 --- a/docs-2.0/7.data-security/2.backup-restore/3.br-backup-data.md +++ b/docs-2.0/7.data-security/2.backup-restore/3.br-backup-data.md @@ -4,7 +4,7 @@ BR 编译成功后，可以备份整个图空间的数据，本文介绍如何 ## 准备工作 -- BR 编译完成。如何编译 BR，请参见 [编译 BR](2.compile-br.md)。 +- BR 编译完成。如何编译 BR，请参见[编译 BR](2.compile-br.md)。 - 确认 Nebula Graph 服务正在运行中。 @@ -20,7 +20,7 @@ BR 编译成功后，可以备份整个图空间的数据，本文介绍如何 !!! Note - 在生产环境中，我们建议用户将 NFS (Network File System）存储设备挂载到 Meta 服务器、Storage 服务器和 BR 机器上进行本地备份，或者使用 Alibaba Cloud OSS、Amazon S3 进行远程备份。否则当需要通过本地文件恢复数据时，必须手动将这些备份文件移动到指定目录，会导致数据冗余和某些问题。更多信息，请参见 [使用 BR 恢复数据](4.br-restore-data.md)。 + 在生产环境中，我们建议用户将 NFS (Network File System）存储设备挂载到 Meta 服务器、Storage 服务器和 BR 机器上进行本地备份，或者使用 Alibaba Cloud OSS、Amazon S3 进行远程备份。否则当需要通过本地文件恢复数据时，必须手动将这些备份文件移动到指定目录，会导致数据冗余和某些问题。更多信息，请参见[使用 BR 恢复数据](4.br-restore-data.md)。 ## 操作步骤 @@ -55,4 +55,4 @@ $ ./bin/br backup full --meta --storage --user CREATE SNAPSHOT; diff --git a/docs-2.0/7.data-security/4.ssl.md b/docs-2.0/7.data-security/4.ssl.md index 7f14a9f554..b8e2b08f26 100644 --- a/docs-2.0/7.data-security/4.ssl.md +++ b/docs-2.0/7.data-security/4.ssl.md @@ -32,7 +32,7 @@ Nebula Graph 支持在客户端、Graph 服务、Meta 服务和 Storage 服务 ## 加密策略 -Nebula Graph 支持三种加密策略。加密涉及的具体进程请参见 [详细说明](https://github.com/vesoft-inc/nebula/blob/a67d166b284cae1b534bf8d19c936ee38bf12e29/docs/rfcs/0001-ssl-transportation.md#usage-explanation)。 +Nebula Graph 支持三种加密策略。加密涉及的具体进程请参见[详细说明](https://github.com/vesoft-inc/nebula/blob/a67d166b284cae1b534bf8d19c936ee38bf12e29/docs/rfcs/0001-ssl-transportation.md#usage-explanation)。 - 对客户端、Graph 服务、Meta 服务和 Storage 服务之间的传输数据加密。 diff --git a/docs-2.0/8.service-tuning/2.graph-modeling.md b/docs-2.0/8.service-tuning/2.graph-modeling.md index 11443369d1..d68ccf9063 100644 --- a/docs-2.0/8.service-tuning/2.graph-modeling.md +++ b/docs-2.0/8.service-tuning/2.graph-modeling.md @@ -62,11 +62,11 @@ ### 合理设计 VID -参考 [点 VID 一节](../1.introduction/3.vid.md)。 +参考[点 VID 一节](../1.introduction/3.vid.md)。 ### 长文本 -为边创建属性时请勿使用长文本：这些属性会被 [存储 2 份](../1.introduction/3.nebula-graph-architecture/4.storage-service.md)，导致写入放大问题（write amplification）。此时建议将长文本放在 HBase/ES 中，将其地址存放在 Nebula Graph 中。 +为边创建属性时请勿使用长文本：这些属性会被[存储 2 份](../1.introduction/3.nebula-graph-architecture/4.storage-service.md)，导致写入放大问题（write amplification）。此时建议将长文本放在 HBase/ES 中，将其地址存放在 Nebula Graph 中。 ## 不能支持动态图（时序图） 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 ac64313115..72a97ac933 100644 --- a/docs-2.0/8.service-tuning/3.system-design.md +++ b/docs-2.0/8.service-tuning/3.system-design.md @@ -4,7 +4,7 @@ - Nebula Graph {{ nebula.release }} 更擅长处理（互联网式的）有大量并发的小请求。也即：虽然全图很大（万亿点边），但是每个请求要访问到的子图本身并不大（几百万个点边）——单个请求时延不大；但这类请求的并发数量特别多——QPS 大。 -- 但对于一些交互分析型的场景，并发请求的数量不多，而每个请求要访问的子图本身特别大（亿以上）。为降低时延，可以在应用程序中将一个大的请求，拆分为多个小请求，并发发送给多个 graphd。这样可以降低单个大请求的时延，降低单个 graphd 的内存占用。另外，也可以使用 [图计算功能 Nebula Algorithm](../nebula-algorithm.md)。 +- 但对于一些交互分析型的场景，并发请求的数量不多，而每个请求要访问的子图本身特别大（亿以上）。为降低时延，可以在应用程序中将一个大的请求，拆分为多个小请求，并发发送给多个 graphd。这样可以降低单个大请求的时延，降低单个 graphd 的内存占用。另外，也可以使用[图计算功能 Nebula Algorithm](../nebula-algorithm.md)。 ## 水平扩展或垂直扩展 diff --git a/docs-2.0/8.service-tuning/compaction.md b/docs-2.0/8.service-tuning/compaction.md index c9980c1196..aec848fa10 100644 --- a/docs-2.0/8.service-tuning/compaction.md +++ b/docs-2.0/8.service-tuning/compaction.md @@ -77,7 +77,7 @@ nebula> SHOW JOB ; 为保证 Nebula Graph 的性能，请参考如下操作建议： - 数据导入完成后，请执行`SUBMIT JOB COMPACT`。 diff --git a/docs-2.0/8.service-tuning/load-balance.md b/docs-2.0/8.service-tuning/load-balance.md index fe217bc8e8..a2e720f81d 100644 --- a/docs-2.0/8.service-tuning/load-balance.md +++ b/docs-2.0/8.service-tuning/load-balance.md @@ -60,7 +60,7 @@ !!! Note - `BALANCE DATA`不会均衡 leader 的分布。均衡 leader 请参见 [均衡 leader 分布](#leader)。 + `BALANCE DATA`不会均衡 leader 的分布。均衡 leader 请参见[均衡 leader 分布](#leader)。 ```ngql nebula> SHOW HOSTS; diff --git a/docs-2.0/8.service-tuning/practice.md b/docs-2.0/8.service-tuning/practice.md index 35c88e9cbe..a9cea623c7 100644 --- a/docs-2.0/8.service-tuning/practice.md +++ b/docs-2.0/8.service-tuning/practice.md @@ -1,6 +1,6 @@ # 实践案例 -Nebula Graph 在各行各业都有应用，本文介绍部分实践案例。更多实践分享内容请参见 [博客](https://nebula-graph.com.cn/posts/)。 +Nebula Graph 在各行各业都有应用，本文介绍部分实践案例。更多实践分享内容请参见[博客](https://nebula-graph.com.cn/posts/)。 ## 业务场景 diff --git a/docs-2.0/8.service-tuning/super-node.md b/docs-2.0/8.service-tuning/super-node.md index 85a4907c39..f1ed334888 100644 --- a/docs-2.0/8.service-tuning/super-node.md +++ b/docs-2.0/8.service-tuning/super-node.md @@ -7,7 +7,7 @@ 由于幂律分布的特点，超级顶点现象非常普遍。 例如社交网络中的影响力领袖（网红大 V）、证券市场中的热门股票、银行系统中的四大行、交通网络中的枢纽站、互联网中的高流量网站等、电商网络中的爆款产品。 -在 Nebula Graph {{ nebula.release }} 中，一个`点` 和其`属性`是一个 `Key-Value`（以该点的 `VID` 以及其他元信息作为 `Key`），其 `Out-Edge Key-Value` 和 `In-Edge Key-Value` 都存储在同一个 partition 中（具体原理详见 [存储架构](../1.introduction/3.nebula-graph-architecture/4.storage-service.md)，并且以 LSM-tree 的形式组织存放在硬盘（和缓存）中。 +在 Nebula Graph {{ nebula.release }} 中，一个`点` 和其`属性`是一个 `Key-Value`（以该点的 `VID` 以及其他元信息作为 `Key`），其 `Out-Edge Key-Value` 和 `In-Edge Key-Value` 都存储在同一个 partition 中（具体原理详见[存储架构](../1.introduction/3.nebula-graph-architecture/4.storage-service.md)，并且以 LSM-tree 的形式组织存放在硬盘（和缓存）中。 因此不论是`从该点出发的有向遍历`，或者`以该点为终点的有向遍历`，都会涉及到大量的`顺序 IO 扫描`（最理想情况，当完成 [Compact](../8.service-tuning/compaction.md) 操作之后），或者大量的`随机 IO`（有关于`该点`和其`出入边`频繁的写入）。 @@ -23,7 +23,7 @@ Nebula Graph {{ nebula.release }} 属性索引的设计复用了存储模块 RocksDB 的功能，这种情况下的索引会被建模为`前缀相同的 Key`。对于该属性的查找，（如果未能命中缓存，）会对应为硬盘上的“一次随机查找 + 一次前缀顺序扫描”，以找到对应的`点 VID`（此后，通常会从该顶点开始图遍历，这样又会发生该点对应 Key-Value 的一次随机读+顺序扫描）。当重复率越高，扫描范围就越大。 -关于属性索引的原理详细介绍在 [博客《分布式图数据库 Nebula Graph 的 Index 实践》](https://nebula-graph.com.cn/posts/how-indexing-works-in-nebula-graph/)。 +关于属性索引的原理详细介绍在[博客《分布式图数据库 Nebula Graph 的 Index 实践》](https://nebula-graph.com.cn/posts/how-indexing-works-in-nebula-graph/)。 经验上说，当重复属性值超过 1 万时，也需要特殊的设计和处理。 diff --git a/docs-2.0/nebula-algorithm.md b/docs-2.0/nebula-algorithm.md index 5ac041d21a..8ebce3e739 100644 --- a/docs-2.0/nebula-algorithm.md +++ b/docs-2.0/nebula-algorithm.md @@ -94,7 +94,7 @@ Nebula Algorithm 实现图计算的流程如下： ``` -2. 传入参数调用算法（以 PageRank 为例）。更多算法请参见 [测试用例](https://github.com/vesoft-inc/nebula-algorithm/tree/master/nebula-algorithm/src/test/scala/com/vesoft/nebula/algorithm/lib)。 +2. 传入参数调用算法（以 PageRank 为例）。更多算法请参见[测试用例](https://github.com/vesoft-inc/nebula-algorithm/tree/master/nebula-algorithm/src/test/scala/com/vesoft/nebula/algorithm/lib)。 !!! note @@ -110,7 +110,7 @@ Nebula Algorithm 实现图计算的流程如下： !!! note 使用封装好的算法包有一定的局限性，例如落库到 Nebula Graph 时，落库的图空间中创建的 Tag 的属性名称必须和代码内预设的名称保持一致。如果用户有开发能力，推荐使用第一种方法。 -1. 设置 [配置文件](https://github.com/vesoft-inc/nebula-algorithm/blob/{{algorithm.branch}}/nebula-algorithm/src/main/resources/application.conf)。 +1. 设置[配置文件](https://github.com/vesoft-inc/nebula-algorithm/blob/{{algorithm.branch}}/nebula-algorithm/src/main/resources/application.conf)。 ```bash { 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 9a48c88d6b..53b8adef08 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,6 +1,6 @@ # 什么是 Nebula Dashboard（企业版） -Nebula Dashboard（简称 Dashboard）是一款用于监控和管理 Nebula Graph 多集群中机器和服务状态的可视化工具。本文主要介绍企业版 Dashboard，社区版详情参见 [什么是 Nebula Dashboard（社区版）](../nebula-dashboard/1.what-is-dashboard.md)。 +Nebula Dashboard（简称 Dashboard）是一款用于监控和管理 Nebula Graph 多集群中机器和服务状态的可视化工具。本文主要介绍企业版 Dashboard，社区版详情参见[什么是 Nebula Dashboard（社区版）](../nebula-dashboard/1.what-is-dashboard.md)。 ## 产品功能 diff --git a/docs-2.0/nebula-dashboard-ent/2.deploy-connect-dashboard-ent.md b/docs-2.0/nebula-dashboard-ent/2.deploy-connect-dashboard-ent.md index e4af3ab916..ce726746c2 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 @@ -34,7 +34,7 @@ !!! enterpriseonly - Dashboard 仅在企业版提供，点击 [定价](https://nebula-graph.com.cn/pricing/) 查看更多。 + Dashboard 仅在企业版提供，点击[定价](https://nebula-graph.com.cn/pricing/) 查看更多。 2. 使用`tar -xzvf`解压 tar 包。 @@ -138,6 +138,6 @@ $ sudo /dashboard/scripts/dashboard.service status all #查看 Dashboard 所有 启动成功后，在浏览器地址栏输入`http://:7005`。 -在浏览器窗口中看到以下登录界面表示已经成功部署并启动了 Dashboard，用户可以通过默认用户名`nebula`和密码`nebula`登陆 Dashboard 的 GOD 用户。可以在 [系统设置](../nebula-dashboard-ent/6.system-settings.md) 中修改密码，也可以在 [权限管理](../nebula-dashboard-ent/5.account-management.md) 页面创建权限为 ADMIN 的账号用来登陆 Dashboard。 +在浏览器窗口中看到以下登录界面表示已经成功部署并启动了 Dashboard，用户可以通过默认用户名`nebula`和密码`nebula`登陆 Dashboard 的 GOD 用户。可以在[系统设置](../nebula-dashboard-ent/6.system-settings.md) 中修改密码，也可以在[权限管理](../nebula-dashboard-ent/5.account-management.md) 页面创建权限为 ADMIN 的账号用来登陆 Dashboard。 ![start-page](../nebula-dashboard-ent/figs/ds-028.png) 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 5e236bfe2e..960dbd1ba9 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 @@ -39,4 +39,4 @@ ## 后续操作 -成功创建集群后，用户可以对集群进行操作，详情见 [总览](../4.cluster-operator/1.overview.md)。 +成功创建集群后，用户可以对集群进行操作，详情见[总览](../4.cluster-operator/1.overview.md)。 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 c3a18c40c3..736e8d8ddc 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 @@ -34,4 +34,4 @@ ## 后续操作 -成功导入集群后，用户可以对集群进行操作，详情见 [总览](../4.cluster-operator/1.overview.md)。 +成功导入集群后，用户可以对集群进行操作，详情见[总览](../4.cluster-operator/1.overview.md)。 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 34972ad44a..97d9456df1 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 @@ -12,7 +12,7 @@ - 如果需要查看某一项更详细的监控指标，可以单击模块右上角的！[watch](../figs/watch.png) 按钮，在示例中选择`Load`查看详情信息，如下图。 ![load](../figs/ds-003.png) - 默认最多可选择 14 天的监控数据进行查看，也可以快捷选择 1 小时、6 小时、12 小时、1 天、3 天、7 天和 14 天，支持修改查看时间。 - - 可以选择需要查看的机器和监控指标。监控指标详情请参见 [监控指标说明](../7.monitor-parameter.md)。 + - 可以选择需要查看的机器和监控指标。监控指标详情请参见[监控指标说明](../7.monitor-parameter.md)。 - 可以设置基线，作为参考标准线。 ## 服务监控 @@ -28,6 +28,6 @@ - 如果需要查看某一项更详细的监控指标，可以单击模块右上角的！[watch](../figs/watch.png) 按钮，在示例中选择 `Graph` 查看详情信息，如下图。 ![service](../figs/ds-005.png) - 默认最多可选择 14 天的监控数据进行查看，也可以快捷选择 1 小时、6 小时、12 小时、1 天、3 天、7 天和 14 天，支持修改查看时间。 - - 可以选择需要查看的机器和监控指标。监控指标详情请参见 [监控指标说明](../7.monitor-parameter.md)。 + - 可以选择需要查看的机器和监控指标。监控指标详情请参见[监控指标说明](../7.monitor-parameter.md)。 - 可以设置基线，作为参考标准线。 - 可以查看当前服务的状态。 \ No newline at end of file diff --git a/docs-2.0/nebula-dashboard-ent/4.cluster-operator/3.cluster-information.md b/docs-2.0/nebula-dashboard-ent/4.cluster-operator/3.cluster-information.md index 985f7381c7..0ba3c2ad04 100644 --- a/docs-2.0/nebula-dashboard-ent/4.cluster-operator/3.cluster-information.md +++ b/docs-2.0/nebula-dashboard-ent/4.cluster-operator/3.cluster-information.md @@ -70,12 +70,12 @@ ![长时任务](../figs/ds-009.png) -展示所有作业的信息。查看作业信息之前，用户需要在右上角选择图空间。暂不支持在线管理作业，详情请参见 [作业管理](../../3.ngql-guide/18.operation-and-maintenance-statements/4.job-statements.md)。参数说明如下： +展示所有作业的信息。查看作业信息之前，用户需要在右上角选择图空间。暂不支持在线管理作业，详情请参见[作业管理](../../3.ngql-guide/18.operation-and-maintenance-statements/4.job-statements.md)。参数说明如下： | 参数 | 说明 | | :--- | :--- | | `Job ID` | 显示作业 ID。 | | `Command` | 显示命令类型。 | -| `Status` | 显示作业或任务的状态。状态说明参见 [作业状态](../../3.ngql-guide/18.operation-and-maintenance-statements/4.job-statements.md#_6)。 | +| `Status` | 显示作业或任务的状态。状态说明参见[作业状态](../../3.ngql-guide/18.operation-and-maintenance-statements/4.job-statements.md#_6)。 | |`Start Time`|显示作业或任务开始执行的时间。| | `Stop Time` | 显示作业或任务结束执行的时间，结束后的状态包括`FINISHED`、`FAILED`或`STOPPED`。 | \ No newline at end of file diff --git a/docs-2.0/nebula-dashboard-ent/4.cluster-operator/4.manage.md b/docs-2.0/nebula-dashboard-ent/4.cluster-operator/4.manage.md index d74ad72b13..9d6b7120f9 100644 --- a/docs-2.0/nebula-dashboard-ent/4.cluster-operator/4.manage.md +++ b/docs-2.0/nebula-dashboard-ent/4.cluster-operator/4.manage.md @@ -15,7 +15,7 @@ - 点击 ![plus](../figs/Plus.png) 按钮，查看对应节点服务名、服务类型、服务状态、运行路径等信息。 - - 点击 **节点监控** 可快速跳转至节点监控页面，详情信息见 [集群监控](../4.cluster-operator/2.monitor.md)。 + - 点击 **节点监控** 可快速跳转至节点监控页面，详情信息见[集群监控](../4.cluster-operator/2.monitor.md)。 - 点击 **编辑节点** 可修改 SSH 端口号、用户名、密码。 @@ -26,7 +26,7 @@ - 在服务管理页面，用户可以选择服务类型、服务状态、Host 对展示的数据进行筛选，快速选中一个或多个服务，一键启动/停止/重启服务。 -- 点击 ![nav](../figs/nav-dashboard.png) 图标，可快速查看 [服务监控](../4.cluster-operator/2.monitor.md)。 +- 点击 ![nav](../figs/nav-dashboard.png) 图标，可快速查看[服务监控](../4.cluster-operator/2.monitor.md)。 !!! danger @@ -41,7 +41,7 @@ !!! caution - 目前仅支持对 graphd 和 storaged 进行扩缩容，不支持移除或添加 metad 服务。扩缩容集群时，建议提前备份数据，以便故障发生时回滚数据。关于扩缩容，详情参见 [如何扩缩容](../../20.appendix/0.FAQ.md#_11)。 + 目前仅支持对 graphd 和 storaged 进行扩缩容，不支持移除或添加 metad 服务。扩缩容集群时，建议提前备份数据，以便故障发生时回滚数据。关于扩缩容，详情参见[如何扩缩容](../../20.appendix/0.FAQ.md#_11)。 在该示例中，新增了节点为`192.168.8.143`和`192.168.8.167`的 Storage 服务，删除了节点为`192.168.8.169`的 Graph 服务。虚线框并置灰服务名表示移除的服务，实线框表示添加的服务。 diff --git a/docs-2.0/nebula-dashboard-ent/8.faq.md b/docs-2.0/nebula-dashboard-ent/8.faq.md index d985a178e1..bd64033d7f 100644 --- a/docs-2.0/nebula-dashboard-ent/8.faq.md +++ b/docs-2.0/nebula-dashboard-ent/8.faq.md @@ -43,4 +43,4 @@ Meta 服务主要存储 Nebula Graph 数据库中的元数据。一旦 Meta 服 ## 是否可以手动添加 Nebula Graph 安装包？ -Dashboard 支持手动添加安装包，可以点击 [如何获取 Nebula Graph](https://nebula-graph.com.cn/download/) 下载所需系统和版本的 RPM 包或 DEB 包，添加到`dashboard/download/nebula-graph`路径下。在创建、扩容集群时，可选择添加的包进行部署。 +Dashboard 支持手动添加安装包，可以点击[如何获取 Nebula Graph](https://nebula-graph.com.cn/download/) 下载所需系统和版本的 RPM 包或 DEB 包，添加到`dashboard/download/nebula-graph`路径下。在创建、扩容集群时，可选择添加的包进行部署。 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 18a125d3f1..224591d8c3 100644 --- a/docs-2.0/nebula-dashboard/1.what-is-dashboard.md +++ b/docs-2.0/nebula-dashboard/1.what-is-dashboard.md @@ -1,10 +1,10 @@ # 什么是 Nebula Dashboard（社区版） -Nebula Dashboard（简称 Dashboard）是一款用于监控 Nebula Graph 集群中机器和服务状态的可视化工具。本文主要介绍社区版 Dashboard，企业版详情参见 [什么是 Nebula Dashboard（企业版）](../nebula-dashboard-ent/what-is-dashboard-ent.md)。 +Nebula Dashboard（简称 Dashboard）是一款用于监控 Nebula Graph 集群中机器和服务状态的可视化工具。本文主要介绍社区版 Dashboard，企业版详情参见[什么是 Nebula Dashboard（企业版）](../nebula-dashboard-ent/what-is-dashboard-ent.md)。 !!! enterpriseonly - 企业版增加了可视化创建集群、批量导入集群、快速扩缩容等功能，点击 [定价](https://nebula-graph.com.cn/pricing/) 查看更多。 + 企业版增加了可视化创建集群、批量导入集群、快速扩缩容等功能，点击[定价](https://nebula-graph.com.cn/pricing/) 查看更多。 ## 产品功能 diff --git a/docs-2.0/nebula-dashboard/3.connect-dashboard.md b/docs-2.0/nebula-dashboard/3.connect-dashboard.md index 486f3ac1b2..ca20f94d0e 100644 --- a/docs-2.0/nebula-dashboard/3.connect-dashboard.md +++ b/docs-2.0/nebula-dashboard/3.connect-dashboard.md @@ -4,7 +4,7 @@ Dashboard 部署完成后，可以通过浏览器登录使用 Dashboard。 ## 前提条件 -- Dashboard 相关服务已经启动。详情请参见 [部署 Dashboard](2.deploy-dashboard.md)。 +- Dashboard 相关服务已经启动。详情请参见[部署 Dashboard](2.deploy-dashboard.md)。 - 建议使用 Chrome 58 及以上的版本的 Chrome 浏览器，否则可能有兼容问题。 @@ -18,6 +18,6 @@ Dashboard 部署完成后，可以通过浏览器登录使用 Dashboard。 - 如果 Nebula Graph 未启用身份验证，用户只能使用默认用户`root`和任意密码连接 Dashboard。 - 如何启用身份验证请参见 [身份验证](../7.data-security/1.authentication/1.authentication.md)。 + 如何启用身份验证请参见[身份验证](../7.data-security/1.authentication/1.authentication.md)。 ![登录页面](login.png) diff --git a/docs-2.0/nebula-dashboard/4.use-dashboard.md b/docs-2.0/nebula-dashboard/4.use-dashboard.md index d71e29497a..cc7a5394e9 100644 --- a/docs-2.0/nebula-dashboard/4.use-dashboard.md +++ b/docs-2.0/nebula-dashboard/4.use-dashboard.md @@ -22,7 +22,7 @@ Dashboard 页面主要分为机器、服务、管理三个部分，本文将详 - 默认可以选择最多 14 天的监控数据进行查看，也可以快捷选择 1 小时、6 小时、12 小时、1 天、3 天、7 天和 14 天。 - - 可以选择需要查看的机器和监控指标。监控指标详情请参见 [监控指标说明](6.monitor-parameter.md)。 + - 可以选择需要查看的机器和监控指标。监控指标详情请参见[监控指标说明](6.monitor-parameter.md)。 - 可以设置基线，作为参考标准线。 @@ -48,7 +48,7 @@ Dashboard 页面主要分为机器、服务、管理三个部分，本文将详 - 默认可以选择最多 14 天的监控数据进行查看，也可以快捷选择 1 小时、6 小时、12 小时、1 天、3 天、7 天和 14 天。 - - 可以选择需要查看监控数据的机器、监控指标、聚合方式和周期。监控指标详情请参见 [监控指标说明](6.monitor-parameter.md)。 + - 可以选择需要查看监控数据的机器、监控指标、聚合方式和周期。监控指标详情请参见[监控指标说明](6.monitor-parameter.md)。 - 可以设置基线，作为参考标准线。 @@ -81,11 +81,11 @@ Dashboard 页面主要分为机器、服务、管理三个部分，本文将详 - 配置 - 展示 Graph 和 Storage 服务的配置信息。暂不支持在线修改配置，详情请参见 [配置管理](../5.configurations-and-logs/1.configurations/1.configurations.md)。 + 展示 Graph 和 Storage 服务的配置信息。暂不支持在线修改配置，详情请参见[配置管理](../5.configurations-and-logs/1.configurations/1.configurations.md)。 - 长时任务 - 展示所有作业的信息。暂不支持在线管理作业，详情请参见 [作业管理](../3.ngql-guide/18.operation-and-maintenance-statements/4.job-statements.md)。 + 展示所有作业的信息。暂不支持在线管理作业，详情请参见[作业管理](../3.ngql-guide/18.operation-and-maintenance-statements/4.job-statements.md)。 ## 其他 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 f93147604e..5b637cfa64 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 @@ -8,7 +8,7 @@ Exchange 由 Reader、Processor 和 Writer 三部分组成。Reader 读取不同 ## 版本系列 -Exchange 有社区版和企业版两个系列。社区版在 [GitHub](https://github.com/vesoft-inc/nebula-exchange) 开源开发，企业版除了支持社区版的功能，还增加了额外的特性，详情参见 [版本对比](https://nebula-graph.com.cn/pricing/)。 +Exchange 有社区版和企业版两个系列。社区版在 [GitHub](https://github.com/vesoft-inc/nebula-exchange) 开源开发，企业版除了支持社区版的功能，还增加了额外的特性，详情参见[版本对比](https://nebula-graph.com.cn/pricing/)。 ## 适用场景 @@ -78,7 +78,7 @@ Exchange {{exchange.release}} 支持将以下格式或来源的数据转换为 N 除了用 nGQL 语句的形式导入数据，Exchange 还支持将数据源的数据生成 SST 文件，然后通过 Console[导入 SST 文件](../use-exchange/ex-ug-import-from-sst.md)。 -此外，企业版 Exchange 还支持以 Nebula Graph 为源，将数据 [导出到 CSV 文件](../use-exchange/ex-ug-export-from-nebula.md)。 +此外，企业版 Exchange 还支持以 Nebula Graph 为源，将数据[导出到 CSV 文件](../use-exchange/ex-ug-export-from-nebula.md)。 ## 更新说明 diff --git a/docs-2.0/nebula-exchange/ex-ug-FAQ.md b/docs-2.0/nebula-exchange/ex-ug-FAQ.md index 05d8c9bd62..df8f2bc4f1 100644 --- a/docs-2.0/nebula-exchange/ex-ug-FAQ.md +++ b/docs-2.0/nebula-exchange/ex-ug-FAQ.md @@ -80,7 +80,7 @@ nebula-exchange-2.0.0.jar \ ### Q：运行时报错`Exception in thread "main" com.facebook.thrift.protocol.TProtocolException: The field 'code' has been assigned the invalid value -4` -检查 Exchange 版本与 Nebula Graph 版本是否匹配，详细信息可参考 [使用限制](../nebula-exchange/about-exchange/ex-ug-limitations.md)。 +检查 Exchange 版本与 Nebula Graph 版本是否匹配，详细信息可参考[使用限制](../nebula-exchange/about-exchange/ex-ug-limitations.md)。 ### Q：将 Hive 中的数据导入 Nebula Graph 时出现乱码如何解决？ @@ -136,7 +136,7 @@ nebula-exchange-2.0.0.jar \ ### Q：Exchange 支持哪些版本的 Nebula Graph？ -请参见 Exchange 的 [使用限制](about-exchange/ex-ug-limitations.md)。 +请参见 Exchange 的[使用限制](about-exchange/ex-ug-limitations.md)。 ### Q：Exchange 与 Spark Writer 有什么关系？ diff --git a/docs-2.0/nebula-exchange/ex-ug-compile.md b/docs-2.0/nebula-exchange/ex-ug-compile.md index 5d07f6cbc5..81580c75cd 100644 --- a/docs-2.0/nebula-exchange/ex-ug-compile.md +++ b/docs-2.0/nebula-exchange/ex-ug-compile.md @@ -4,9 +4,9 @@ ## 直接下载 JAR 文件 -社区版 Exchange 的 JAR 文件可以直接 [下载](https://repo1.maven.org/maven2/com/vesoft/nebula-exchange/)。 +社区版 Exchange 的 JAR 文件可以直接[下载](https://repo1.maven.org/maven2/com/vesoft/nebula-exchange/)。 -要下载企业版 Exchange，需先 [获取 Nebula Graph 企业版套餐](https://nebula-graph.com.cn/pricing/)。 +要下载企业版 Exchange，需先[获取 Nebula Graph 企业版套餐](https://nebula-graph.com.cn/pricing/)。 ## 编译源代码获取 JAR 文件 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 98ffa1c2c6..14d5efe434 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 @@ -18,7 +18,7 @@ ## Spark 相关配置 -本文只列出部分 Spark 参数，更多参数请参见 [官方文档](https://spark.apache.org/docs/latest/configuration.html#application-properties)。 +本文只列出部分 Spark 参数，更多参数请参见[官方文档](https://spark.apache.org/docs/latest/configuration.html#application-properties)。 |参数|数据类型|默认值|是否必须|说明| |:---|:---|:---|:---|:---| @@ -111,8 +111,8 @@ |:---|:---|:---|:---|:---| |`tags.table`|string|-|是|MaxCompute 的表名。| |`tags.project`|string|-|是|MaxCompute 的项目名。| -|`tags.odpsUrl`|string|-|是|MaxCompute 服务的 odpsUrl。地址可根据 [阿里云文档](https://help.aliyun.com/document_detail/34951.html) 查看。| -|`tags.tunnelUrl`|string|-|是|MaxCompute 服务的 tunnelUrl。地址可根据 [阿里云文档](https://help.aliyun.com/document_detail/34951.html) 查看。| +|`tags.odpsUrl`|string|-|是|MaxCompute 服务的 odpsUrl。地址可根据[阿里云文档](https://help.aliyun.com/document_detail/34951.html) 查看。| +|`tags.tunnelUrl`|string|-|是|MaxCompute 服务的 tunnelUrl。地址可根据[阿里云文档](https://help.aliyun.com/document_detail/34951.html) 查看。| |`tags.accessKeyId`|string|-|是|MaxCompute 服务的 accessKeyId。| |`tags.accessKeySecret`|string|-|是|MaxCompute 服务的 accessKeySecret。| |`tags.partitionSpec`|string|-|否|MaxCompute 表的分区描述。| 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 3768537b00..83e3597605 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 @@ -26,13 +26,13 @@ 开始导入数据之前，用户需要确认以下信息： -- 已经 [安装部署 Nebula Graph](../../4.deployment-and-installation/2.compile-and-install-nebula-graph/2.install-nebula-graph-by-rpm-or-deb.md) 并获取如下信息： +- 已经[安装部署 Nebula Graph](../../4.deployment-and-installation/2.compile-and-install-nebula-graph/2.install-nebula-graph-by-rpm-or-deb.md) 并获取如下信息： - Graph 服务和 Meta 服务的的 IP 地址和端口。 - 拥有 Nebula Graph 写权限的用户名和密码。 -- 已经编译 Exchange。详情请参见 [编译 Exchange](../ex-ug-compile.md)。本示例中使用 Exchange {{exchange.release}}。 +- 已经编译 Exchange。详情请参见[编译 Exchange](../ex-ug-compile.md)。本示例中使用 Exchange {{exchange.release}}。 - 已经安装 Spark。 @@ -80,11 +80,11 @@ nebula> CREATE EDGE serve(start_year int, end_year int); ``` -更多信息，请参见 [快速开始](../../2.quick-start/1.quick-start-workflow.md)。 +更多信息，请参见[快速开始](../../2.quick-start/1.quick-start-workflow.md)。 ### 步骤 2：修改配置文件 -编译 Exchange 后，复制`target/classes/application.conf`文件设置 ClickHouse 数据源相关的配置。在本示例中，复制的文件名为`clickhouse_application.conf`。各个配置项的详细说明请参见 [配置说明](../parameter-reference/ex-ug-parameter.md)。 +编译 Exchange 后，复制`target/classes/application.conf`文件设置 ClickHouse 数据源相关的配置。在本示例中，复制的文件名为`clickhouse_application.conf`。各个配置项的详细说明请参见[配置说明](../parameter-reference/ex-ug-parameter.md)。 ```conf { @@ -275,7 +275,7 @@ ### 步骤 3：向 Nebula Graph 导入数据 -运行如下命令将 ClickHouse 数据导入到 Nebula Graph 中。关于参数的说明，请参见 [导入命令参数](../parameter-reference/ex-ug-para-import-command.md)。 +运行如下命令将 ClickHouse 数据导入到 Nebula Graph 中。关于参数的说明，请参见[导入命令参数](../parameter-reference/ex-ug-para-import-command.md)。 ```bash ${SPARK_HOME}/bin/spark-submit --master "local" --class com.vesoft.nebula.exchange.Exchange -c @@ -305,4 +305,4 @@ GO FROM "player100" OVER follow; ### 步骤 5：（如有）在 Nebula Graph 中重建索引 -导入数据后，用户可以在 Nebula Graph 中重新创建并重建索引。详情请参见 [索引介绍](../../3.ngql-guide/14.native-index-statements/README.md)。 +导入数据后，用户可以在 Nebula Graph 中重新创建并重建索引。详情请参见[索引介绍](../../3.ngql-guide/14.native-index-statements/README.md)。 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 1b88b983ff..1d52df0b67 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 @@ -26,13 +26,13 @@ 开始导入数据之前，用户需要确认以下信息： -- 已经 [安装部署 Nebula Graph](../../4.deployment-and-installation/2.compile-and-install-nebula-graph/2.install-nebula-graph-by-rpm-or-deb.md) 并获取如下信息： +- 已经[安装部署 Nebula Graph](../../4.deployment-and-installation/2.compile-and-install-nebula-graph/2.install-nebula-graph-by-rpm-or-deb.md) 并获取如下信息： - Graph 服务和 Meta 服务的的 IP 地址和端口。 - 拥有 Nebula Graph 写权限的用户名和密码。 -- 已经编译 Exchange。详情请参见 [编译 Exchange](../ex-ug-compile.md)。本示例中使用 Exchange {{exchange.release}}。 +- 已经编译 Exchange。详情请参见[编译 Exchange](../ex-ug-compile.md)。本示例中使用 Exchange {{exchange.release}}。 - 已经安装 Spark。 @@ -82,7 +82,7 @@ nebula> CREATE EDGE serve(start_year int, end_year int); ``` -更多信息，请参见 [快速开始](../../2.quick-start/1.quick-start-workflow.md)。 +更多信息，请参见[快速开始](../../2.quick-start/1.quick-start-workflow.md)。 ### 步骤 2：处理 CSV 文件 @@ -98,7 +98,7 @@ ### 步骤 3：修改配置文件 -编译 Exchange 后，复制`target/classes/application.conf`文件设置 CSV 数据源相关的配置。在本示例中，复制的文件名为`csv_application.conf`。各个配置项的详细说明请参见 [配置说明](../parameter-reference/ex-ug-parameter.md)。 +编译 Exchange 后，复制`target/classes/application.conf`文件设置 CSV 数据源相关的配置。在本示例中，复制的文件名为`csv_application.conf`。各个配置项的详细说明请参见[配置说明](../parameter-reference/ex-ug-parameter.md)。 ```conf { @@ -365,7 +365,7 @@ ### 步骤 4：向 Nebula Graph 导入数据 -运行如下命令将 CSV 文件数据导入到 Nebula Graph 中。关于参数的说明，请参见 [导入命令参数](../parameter-reference/ex-ug-para-import-command.md)。 +运行如下命令将 CSV 文件数据导入到 Nebula Graph 中。关于参数的说明，请参见[导入命令参数](../parameter-reference/ex-ug-para-import-command.md)。 ```bash ${SPARK_HOME}/bin/spark-submit --master "local" --class com.vesoft.nebula.exchange.Exchange -c @@ -395,4 +395,4 @@ GO FROM "player100" OVER follow; ### 步骤 6：（如有）在 Nebula Graph 中重建索引 -导入数据后，用户可以在 Nebula Graph 中重新创建并重建索引。详情请参见 [索引介绍](../../3.ngql-guide/14.native-index-statements/README.md)。 +导入数据后，用户可以在 Nebula Graph 中重新创建并重建索引。详情请参见[索引介绍](../../3.ngql-guide/14.native-index-statements/README.md)。 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 3732e9d78d..dbc6b066b6 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 @@ -63,13 +63,13 @@ ROW COLUMN+CELL 开始导入数据之前，用户需要确认以下信息： -- 已经 [安装部署 Nebula Graph](../../4.deployment-and-installation/2.compile-and-install-nebula-graph/2.install-nebula-graph-by-rpm-or-deb.md) 并获取如下信息： +- 已经[安装部署 Nebula Graph](../../4.deployment-and-installation/2.compile-and-install-nebula-graph/2.install-nebula-graph-by-rpm-or-deb.md) 并获取如下信息： - Graph 服务和 Meta 服务的的 IP 地址和端口。 - 拥有 Nebula Graph 写权限的用户名和密码。 -- 已经编译 Exchange。详情请参见 [编译 Exchange](../ex-ug-compile.md)。本示例中使用 Exchange {{exchange.release}}。 +- 已经编译 Exchange。详情请参见[编译 Exchange](../ex-ug-compile.md)。本示例中使用 Exchange {{exchange.release}}。 - 已经安装 Spark。 @@ -117,11 +117,11 @@ ROW COLUMN+CELL nebula> CREATE EDGE serve(start_year int, end_year int); ``` -更多信息，请参见 [快速开始](../../2.quick-start/1.quick-start-workflow.md)。 +更多信息，请参见[快速开始](../../2.quick-start/1.quick-start-workflow.md)。 ### 步骤 2：修改配置文件 -编译 Exchange 后，复制`target/classes/application.conf`文件设置 HBase 数据源相关的配置。在本示例中，复制的文件名为`hbase_application.conf`。各个配置项的详细说明请参见 [配置说明](../parameter-reference/ex-ug-parameter.md)。 +编译 Exchange 后，复制`target/classes/application.conf`文件设置 HBase 数据源相关的配置。在本示例中，复制的文件名为`hbase_application.conf`。各个配置项的详细说明请参见[配置说明](../parameter-reference/ex-ug-parameter.md)。 ```conf { @@ -302,7 +302,7 @@ ROW COLUMN+CELL ### 步骤 3：向 Nebula Graph 导入数据 -运行如下命令将 HBase 数据导入到 Nebula Graph 中。关于参数的说明，请参见 [导入命令参数](../parameter-reference/ex-ug-para-import-command.md)。 +运行如下命令将 HBase 数据导入到 Nebula Graph 中。关于参数的说明，请参见[导入命令参数](../parameter-reference/ex-ug-para-import-command.md)。 ```bash ${SPARK_HOME}/bin/spark-submit --master "local" --class com.vesoft.nebula.exchange.Exchange -c @@ -332,4 +332,4 @@ GO FROM "player100" OVER follow; ### 步骤 5：（如有）在 Nebula Graph 中重建索引 -导入数据后，用户可以在 Nebula Graph 中重新创建并重建索引。详情请参见 [索引介绍](../../3.ngql-guide/14.native-index-statements/README.md)。 \ No newline at end of file +导入数据后，用户可以在 Nebula Graph 中重新创建并重建索引。详情请参见[索引介绍](../../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-hive.md b/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-hive.md index 97b2fb5fcc..70b0d2a149 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 @@ -68,13 +68,13 @@ scala> spark.sql("describe basketball.serve").show 开始导入数据之前，用户需要确认以下信息： -- 已经 [安装部署 Nebula Graph](../../4.deployment-and-installation/2.compile-and-install-nebula-graph/2.install-nebula-graph-by-rpm-or-deb.md) 并获取如下信息： +- 已经[安装部署 Nebula Graph](../../4.deployment-and-installation/2.compile-and-install-nebula-graph/2.install-nebula-graph-by-rpm-or-deb.md) 并获取如下信息： - Graph 服务和 Meta 服务的的 IP 地址和端口。 - 拥有 Nebula Graph 写权限的用户名和密码。 -- 已经编译 Exchange。详情请参见 [编译 Exchange](../ex-ug-compile.md)。本示例中使用 Exchange {{exchange.release}}。 +- 已经编译 Exchange。详情请参见[编译 Exchange](../ex-ug-compile.md)。本示例中使用 Exchange {{exchange.release}}。 - 已经安装 Spark。 @@ -122,7 +122,7 @@ scala> spark.sql("describe basketball.serve").show nebula> CREATE EDGE serve(start_year int, end_year int); ``` -更多信息，请参见 [快速开始](../../2.quick-start/1.quick-start-workflow.md)。 +更多信息，请参见[快速开始](../../2.quick-start/1.quick-start-workflow.md)。 ### 步骤 2：使用 Spark SQL 确认 Hive SQL 语句 @@ -152,7 +152,7 @@ scala> sql("select playerid, teamid, start_year, end_year from basketball.serve" ### 步骤 3：修改配置文件 -编译 Exchange 后，复制`target/classes/application.conf`文件设置 Hive 数据源相关的配置。在本示例中，复制的文件名为`hive_application.conf`。各个配置项的详细说明请参见 [配置说明](../parameter-reference/ex-ug-parameter.md)。 +编译 Exchange 后，复制`target/classes/application.conf`文件设置 Hive 数据源相关的配置。在本示例中，复制的文件名为`hive_application.conf`。各个配置项的详细说明请参见[配置说明](../parameter-reference/ex-ug-parameter.md)。 ```conf { @@ -328,7 +328,7 @@ scala> sql("select playerid, teamid, start_year, end_year from basketball.serve" ### 步骤 4：向 Nebula Graph 导入数据 -运行如下命令将 Hive 数据导入到 Nebula Graph 中。关于参数的说明，请参见 [导入命令参数](../parameter-reference/ex-ug-para-import-command.md)。 +运行如下命令将 Hive 数据导入到 Nebula Graph 中。关于参数的说明，请参见[导入命令参数](../parameter-reference/ex-ug-para-import-command.md)。 ```bash ${SPARK_HOME}/bin/spark-submit --master "local" --class com.vesoft.nebula.exchange.Exchange -c -h @@ -358,4 +358,4 @@ GO FROM "player100" OVER follow; ### 步骤 6：（如有）在 Nebula Graph 中重建索引 -导入数据后，用户可以在 Nebula Graph 中重新创建并重建索引。详情请参见 [索引介绍](../../3.ngql-guide/14.native-index-statements/README.md)。 \ No newline at end of file +导入数据后，用户可以在 Nebula Graph 中重新创建并重建索引。详情请参见[索引介绍](../../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-json.md b/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-json.md index a83d3aa948..42fb4c90e7 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 @@ -58,13 +58,13 @@ 开始导入数据之前，用户需要确认以下信息： -- 已经 [安装部署 Nebula Graph](../../4.deployment-and-installation/2.compile-and-install-nebula-graph/2.install-nebula-graph-by-rpm-or-deb.md) 并获取如下信息： +- 已经[安装部署 Nebula Graph](../../4.deployment-and-installation/2.compile-and-install-nebula-graph/2.install-nebula-graph-by-rpm-or-deb.md) 并获取如下信息： - Graph 服务和 Meta 服务的的 IP 地址和端口。 - 拥有 Nebula Graph 写权限的用户名和密码。 -- 已经编译 Exchange。详情请参见 [编译 Exchange](../ex-ug-compile.md)。本示例中使用 Exchange {{exchange.release}}。 +- 已经编译 Exchange。详情请参见[编译 Exchange](../ex-ug-compile.md)。本示例中使用 Exchange {{exchange.release}}。 - 已经安装 Spark。 @@ -114,7 +114,7 @@ nebula> CREATE EDGE serve(start_year int, end_year int); ``` -更多信息，请参见 [快速开始](../../2.quick-start/1.quick-start-workflow.md)。 +更多信息，请参见[快速开始](../../2.quick-start/1.quick-start-workflow.md)。 ### 步骤 2：处理 JSON 文件 @@ -126,7 +126,7 @@ ### 步骤 3. 修改配置文件 -编译 Exchange 后，复制`target/classes/application.conf`文件设置 JSON 数据源相关的配置。在本示例中，复制的文件名为`json_application.conf`。各个配置项的详细说明请参见 [配置说明](../parameter-reference/ex-ug-parameter.md)。 +编译 Exchange 后，复制`target/classes/application.conf`文件设置 JSON 数据源相关的配置。在本示例中，复制的文件名为`json_application.conf`。各个配置项的详细说明请参见[配置说明](../parameter-reference/ex-ug-parameter.md)。 ```conf { @@ -362,7 +362,7 @@ ### 步骤 4：向 Nebula Graph 导入数据 -运行如下命令将 JSON 文件数据导入到 Nebula Graph 中。关于参数的说明，请参见 [导入命令参数](../parameter-reference/ex-ug-para-import-command.md)。 +运行如下命令将 JSON 文件数据导入到 Nebula Graph 中。关于参数的说明，请参见[导入命令参数](../parameter-reference/ex-ug-para-import-command.md)。 ```bash ${SPARK_HOME}/bin/spark-submit --master "local" --class com.vesoft.nebula.exchange.Exchange -c @@ -392,4 +392,4 @@ GO FROM "player100" OVER follow; ### 步骤 6：（如有）在 Nebula Graph 中重建索引 -导入数据后，用户可以在 Nebula Graph 中重新创建并重建索引。详情请参见 [索引介绍](../../3.ngql-guide/14.native-index-statements/README.md)。 +导入数据后，用户可以在 Nebula Graph 中重新创建并重建索引。详情请参见[索引介绍](../../3.ngql-guide/14.native-index-statements/README.md)。 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 5118e32cd2..986a269d0c 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 @@ -18,13 +18,13 @@ 开始导入数据之前，用户需要确认以下信息： -- 已经 [安装部署 Nebula Graph](../../4.deployment-and-installation/2.compile-and-install-nebula-graph/2.install-nebula-graph-by-rpm-or-deb.md) 并获取如下信息： +- 已经[安装部署 Nebula Graph](../../4.deployment-and-installation/2.compile-and-install-nebula-graph/2.install-nebula-graph-by-rpm-or-deb.md) 并获取如下信息： - Graph 服务和 Meta 服务的的 IP 地址和端口。 - 拥有 Nebula Graph 写权限的用户名和密码。 -- 已经编译 Exchange。详情请参见 [编译 Exchange](../ex-ug-compile.md)。本示例中使用 Exchange {{exchange.release}}。 +- 已经编译 Exchange。详情请参见[编译 Exchange](../ex-ug-compile.md)。本示例中使用 Exchange {{exchange.release}}。 - 已经安装 Spark。 @@ -72,7 +72,7 @@ nebula> CREATE EDGE serve(start_year int, end_year int); ``` -更多信息，请参见 [快速开始](../../2.quick-start/1.quick-start-workflow.md)。 +更多信息，请参见[快速开始](../../2.quick-start/1.quick-start-workflow.md)。 ### 步骤 2：修改配置文件 @@ -80,7 +80,7 @@ 如果部分数据存储在 Kafka 的 value 域内，需要自行修改源码，从 Kafka 中获取 value 域，将 value 通过 from_json 函数解析，然后作为 Dataframe 返回。 -编译 Exchange 后，复制`target/classes/application.conf`文件设置 Kafka 数据源相关的配置。在本示例中，复制的文件名为`kafka_application.conf`。各个配置项的详细说明请参见 [配置说明](../parameter-reference/ex-ug-parameter.md)。 +编译 Exchange 后，复制`target/classes/application.conf`文件设置 Kafka 数据源相关的配置。在本示例中，复制的文件名为`kafka_application.conf`。各个配置项的详细说明请参见[配置说明](../parameter-reference/ex-ug-parameter.md)。 ```conf { @@ -263,7 +263,7 @@ ### 步骤 3：向 Nebula Graph 导入数据 -运行如下命令将 Kafka 数据导入到 Nebula Graph 中。关于参数的说明，请参见 [导入命令参数](../parameter-reference/ex-ug-para-import-command.md)。 +运行如下命令将 Kafka 数据导入到 Nebula Graph 中。关于参数的说明，请参见[导入命令参数](../parameter-reference/ex-ug-para-import-command.md)。 ```bash ${SPARK_HOME}/bin/spark-submit --master "local" --class com.vesoft.nebula.exchange.Exchange -c @@ -293,4 +293,4 @@ GO FROM "player100" OVER follow; ### 步骤 5：（如有）在 Nebula Graph 中重建索引 -导入数据后，用户可以在 Nebula Graph 中重新创建并重建索引。详情请参见 [索引介绍](../../3.ngql-guide/14.native-index-statements/README.md)。 +导入数据后，用户可以在 Nebula Graph 中重新创建并重建索引。详情请参见[索引介绍](../../3.ngql-guide/14.native-index-statements/README.md)。 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 c431e0682a..47bc400747 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 @@ -26,13 +26,13 @@ 开始导入数据之前，用户需要确认以下信息： -- 已经 [安装部署 Nebula Graph](../../4.deployment-and-installation/2.compile-and-install-nebula-graph/2.install-nebula-graph-by-rpm-or-deb.md) 并获取如下信息： +- 已经[安装部署 Nebula Graph](../../4.deployment-and-installation/2.compile-and-install-nebula-graph/2.install-nebula-graph-by-rpm-or-deb.md) 并获取如下信息： - Graph 服务和 Meta 服务的的 IP 地址和端口。 - 拥有 Nebula Graph 写权限的用户名和密码。 -- 已经编译 Exchange。详情请参见 [编译 Exchange](../ex-ug-compile.md)。本示例中使用 Exchange {{exchange.release}}。 +- 已经编译 Exchange。详情请参见[编译 Exchange](../ex-ug-compile.md)。本示例中使用 Exchange {{exchange.release}}。 - 已经安装 Spark。 @@ -80,11 +80,11 @@ nebula> CREATE EDGE serve(start_year int, end_year int); ``` -更多信息，请参见 [快速开始](../../2.quick-start/1.quick-start-workflow.md)。 +更多信息，请参见[快速开始](../../2.quick-start/1.quick-start-workflow.md)。 ### 步骤 2：修改配置文件 -编译 Exchange 后，复制`target/classes/application.conf`文件设置 MaxCompute 数据源相关的配置。在本示例中，复制的文件名为`maxcompute_application.conf`。各个配置项的详细说明请参见 [配置说明](../parameter-reference/ex-ug-parameter.md)。 +编译 Exchange 后，复制`target/classes/application.conf`文件设置 MaxCompute 数据源相关的配置。在本示例中，复制的文件名为`maxcompute_application.conf`。各个配置项的详细说明请参见[配置说明](../parameter-reference/ex-ug-parameter.md)。 ```conf { @@ -300,7 +300,7 @@ ### 步骤 3：向 Nebula Graph 导入数据 -运行如下命令将 MaxCompute 数据导入到 Nebula Graph 中。关于参数的说明，请参见 [导入命令参数](../parameter-reference/ex-ug-para-import-command.md)。 +运行如下命令将 MaxCompute 数据导入到 Nebula Graph 中。关于参数的说明，请参见[导入命令参数](../parameter-reference/ex-ug-para-import-command.md)。 ```bash ${SPARK_HOME}/bin/spark-submit --master "local" --class com.vesoft.nebula.exchange.Exchange -c @@ -330,4 +330,4 @@ GO FROM "player100" OVER follow; ### 步骤 5：（如有）在 Nebula Graph 中重建索引 -导入数据后，用户可以在 Nebula Graph 中重新创建并重建索引。详情请参见 [索引介绍](../../3.ngql-guide/14.native-index-statements/README.md)。 +导入数据后，用户可以在 Nebula Graph 中重新创建并重建索引。详情请参见[索引介绍](../../3.ngql-guide/14.native-index-statements/README.md)。 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 72aec05250..25442174c4 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 @@ -66,13 +66,13 @@ mysql> desc serve; 开始导入数据之前，用户需要确认以下信息： -- 已经 [安装部署 Nebula Graph](../../4.deployment-and-installation/2.compile-and-install-nebula-graph/2.install-nebula-graph-by-rpm-or-deb.md) 并获取如下信息： +- 已经[安装部署 Nebula Graph](../../4.deployment-and-installation/2.compile-and-install-nebula-graph/2.install-nebula-graph-by-rpm-or-deb.md) 并获取如下信息： - Graph 服务和 Meta 服务的的 IP 地址和端口。 - 拥有 Nebula Graph 写权限的用户名和密码。 -- 已经编译 Exchange。详情请参见 [编译 Exchange](../ex-ug-compile.md)。本示例中使用 Exchange {{exchange.release}}。 +- 已经编译 Exchange。详情请参见[编译 Exchange](../ex-ug-compile.md)。本示例中使用 Exchange {{exchange.release}}。 - 已经安装 Spark。 @@ -120,11 +120,11 @@ mysql> desc serve; nebula> CREATE EDGE serve(start_year int, end_year int); ``` -更多信息，请参见 [快速开始](../../2.quick-start/1.quick-start-workflow.md)。 +更多信息，请参见[快速开始](../../2.quick-start/1.quick-start-workflow.md)。 ### 步骤 2：修改配置文件 -编译 Exchange 后，复制`target/classes/application.conf`文件设置 MySQL 数据源相关的配置。在本示例中，复制的文件名为`mysql_application.conf`。各个配置项的详细说明请参见 [配置说明](../parameter-reference/ex-ug-parameter.md)。 +编译 Exchange 后，复制`target/classes/application.conf`文件设置 MySQL 数据源相关的配置。在本示例中，复制的文件名为`mysql_application.conf`。各个配置项的详细说明请参见[配置说明](../parameter-reference/ex-ug-parameter.md)。 ```conf { @@ -316,7 +316,7 @@ mysql> desc serve; ### 步骤 3：向 Nebula Graph 导入数据 -运行如下命令将 MySQL 数据导入到 Nebula Graph 中。关于参数的说明，请参见 [导入命令参数](../parameter-reference/ex-ug-para-import-command.md)。 +运行如下命令将 MySQL 数据导入到 Nebula Graph 中。关于参数的说明，请参见[导入命令参数](../parameter-reference/ex-ug-para-import-command.md)。 ```bash ${SPARK_HOME}/bin/spark-submit --master "local" --class com.vesoft.nebula.exchange.Exchange -c @@ -346,4 +346,4 @@ GO FROM "player100" OVER follow; ### 步骤 5：（如有）在 Nebula Graph 中重建索引 -导入数据后，用户可以在 Nebula Graph 中重新创建并重建索引。详情请参见 [索引介绍](../../3.ngql-guide/14.native-index-statements/README.md)。 +导入数据后，用户可以在 Nebula Graph 中重新创建并重建索引。详情请参见[索引介绍](../../3.ngql-guide/14.native-index-statements/README.md)。 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 08e121652c..3777b39b76 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 @@ -47,13 +47,13 @@ Exchange 读取 Neo4j 数据时需要完成以下工作： 开始导入数据之前，用户需要确认以下信息： -- 已经 [安装部署 Nebula Graph](../../4.deployment-and-installation/2.compile-and-install-nebula-graph/2.install-nebula-graph-by-rpm-or-deb.md) 并获取如下信息： +- 已经[安装部署 Nebula Graph](../../4.deployment-and-installation/2.compile-and-install-nebula-graph/2.install-nebula-graph-by-rpm-or-deb.md) 并获取如下信息： - Graph 服务和 Meta 服务的的 IP 地址和端口。 - 拥有 Nebula Graph 写权限的用户名和密码。 -- 已经编译 Exchange。详情请参见 [编译 Exchange](../ex-ug-compile.md)。本示例中使用 Exchange {{exchange.release}}。 +- 已经编译 Exchange。详情请参见[编译 Exchange](../ex-ug-compile.md)。本示例中使用 Exchange {{exchange.release}}。 - 已经安装 Spark。 @@ -99,7 +99,7 @@ Exchange 读取 Neo4j 数据时需要完成以下工作： nebula> CREATE EDGE serve(start_year int, end_year int); ``` -更多信息，请参见 [快速开始](../../2.quick-start/1.quick-start-workflow.md)。 +更多信息，请参见[快速开始](../../2.quick-start/1.quick-start-workflow.md)。 ### 步骤 2：配置源数据 @@ -107,7 +107,7 @@ Exchange 读取 Neo4j 数据时需要完成以下工作： ### 步骤 3：修改配置文件 -编译 Exchange 后，复制`target/classes/application.conf`文件设置数据源相关的配置。在本示例中，复制的文件名为`neo4j_application.conf`。各个配置项的详细说明请参见 [配置说明](../parameter-reference/ex-ug-parameter.md)。 +编译 Exchange 后，复制`target/classes/application.conf`文件设置数据源相关的配置。在本示例中，复制的文件名为`neo4j_application.conf`。各个配置项的详细说明请参见[配置说明](../parameter-reference/ex-ug-parameter.md)。 ```conf { @@ -282,7 +282,7 @@ Nebula Graph 在创建点和边时会将 ID 作为唯一主键，如果主键已 ### 步骤 4：向 Nebula Graph 导入数据 -运行如下命令将文件数据导入到 Nebula Graph 中。关于参数的说明，请参见 [导入命令参数](../parameter-reference/ex-ug-para-import-command.md)。 +运行如下命令将文件数据导入到 Nebula Graph 中。关于参数的说明，请参见[导入命令参数](../parameter-reference/ex-ug-para-import-command.md)。 ```bash ${SPARK_HOME}/bin/spark-submit --master "local" --class com.vesoft.nebula.exchange.Exchange -c @@ -312,4 +312,4 @@ GO FROM "player100" OVER follow; ### 步骤 6：（如有）在 Nebula Graph 中重建索引 -导入数据后，用户可以在 Nebula Graph 中重新创建并重建索引。详情请参见 [索引介绍](../../3.ngql-guide/14.native-index-statements/README.md)。 +导入数据后，用户可以在 Nebula Graph 中重新创建并重建索引。详情请参见[索引介绍](../../3.ngql-guide/14.native-index-statements/README.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 86266ea396..5062dc2c23 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 @@ -26,13 +26,13 @@ 开始导入数据之前，用户需要确认以下信息： -- 已经 [安装部署 Nebula Graph](../../4.deployment-and-installation/2.compile-and-install-nebula-graph/2.install-nebula-graph-by-rpm-or-deb.md) 并获取如下信息： +- 已经[安装部署 Nebula Graph](../../4.deployment-and-installation/2.compile-and-install-nebula-graph/2.install-nebula-graph-by-rpm-or-deb.md) 并获取如下信息： - Graph 服务和 Meta 服务的的 IP 地址和端口。 - 拥有 Nebula Graph 写权限的用户名和密码。 -- 已经编译 Exchange。详情请参见 [编译 Exchange](../ex-ug-compile.md)。本示例中使用 Exchange {{exchange.release}}。 +- 已经编译 Exchange。详情请参见[编译 Exchange](../ex-ug-compile.md)。本示例中使用 Exchange {{exchange.release}}。 - 已经安装 Spark。 @@ -82,7 +82,7 @@ nebula> CREATE EDGE serve(start_year int, end_year int); ``` -更多信息，请参见 [快速开始](../../2.quick-start/1.quick-start-workflow.md)。 +更多信息，请参见[快速开始](../../2.quick-start/1.quick-start-workflow.md)。 ### 步骤 2：处理 ORC 文件 @@ -94,7 +94,7 @@ ### 步骤 3：修改配置文件 -编译 Exchange 后，复制`target/classes/application.conf`文件设置 ORC 数据源相关的配置。在本示例中，复制的文件名为`orc_application.conf`。各个配置项的详细说明请参见 [配置说明](../parameter-reference/ex-ug-parameter.md)。 +编译 Exchange 后，复制`target/classes/application.conf`文件设置 ORC 数据源相关的配置。在本示例中，复制的文件名为`orc_application.conf`。各个配置项的详细说明请参见[配置说明](../parameter-reference/ex-ug-parameter.md)。 ```conf { @@ -330,7 +330,7 @@ ### 步骤 4：向 Nebula Graph 导入数据 -运行如下命令将 ORC 文件数据导入到 Nebula Graph 中。关于参数的说明，请参见 [导入命令参数](../parameter-reference/ex-ug-para-import-command.md)。 +运行如下命令将 ORC 文件数据导入到 Nebula Graph 中。关于参数的说明，请参见[导入命令参数](../parameter-reference/ex-ug-para-import-command.md)。 ```bash ${SPARK_HOME}/bin/spark-submit --master "local" --class com.vesoft.nebula.exchange.Exchange -c @@ -360,4 +360,4 @@ GO FROM "player100" OVER follow; ### 步骤 6：（如有）在 Nebula Graph 中重建索引 -导入数据后，用户可以在 Nebula Graph 中重新创建并重建索引。详情请参见 [索引介绍](../../3.ngql-guide/14.native-index-statements/README.md)。 +导入数据后，用户可以在 Nebula Graph 中重新创建并重建索引。详情请参见[索引介绍](../../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 cff78c5cb0..167732db14 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 @@ -26,13 +26,13 @@ 开始导入数据之前，用户需要确认以下信息： -- 已经 [安装部署 Nebula Graph](../../4.deployment-and-installation/2.compile-and-install-nebula-graph/2.install-nebula-graph-by-rpm-or-deb.md) 并获取如下信息： +- 已经[安装部署 Nebula Graph](../../4.deployment-and-installation/2.compile-and-install-nebula-graph/2.install-nebula-graph-by-rpm-or-deb.md) 并获取如下信息： - Graph 服务和 Meta 服务的的 IP 地址和端口。 - 拥有 Nebula Graph 写权限的用户名和密码。 -- 已经编译 Exchange。详情请参见 [编译 Exchange](../ex-ug-compile.md)。本示例中使用 Exchange {{exchange.release}}。 +- 已经编译 Exchange。详情请参见[编译 Exchange](../ex-ug-compile.md)。本示例中使用 Exchange {{exchange.release}}。 - 已经安装 Spark。 @@ -82,7 +82,7 @@ nebula> CREATE EDGE serve(start_year int, end_year int); ``` -更多信息，请参见 [快速开始](../../2.quick-start/1.quick-start-workflow.md)。 +更多信息，请参见[快速开始](../../2.quick-start/1.quick-start-workflow.md)。 ### 步骤 2：处理 Parquet 文件 @@ -94,7 +94,7 @@ ### 步骤 3：修改配置文件 -编译 Exchange 后，复制`target/classes/application.conf`文件设置 Parquet 数据源相关的配置。在本示例中，复制的文件名为`parquet_application.conf`。各个配置项的详细说明请参见 [配置说明](../parameter-reference/ex-ug-parameter.md)。 +编译 Exchange 后，复制`target/classes/application.conf`文件设置 Parquet 数据源相关的配置。在本示例中，复制的文件名为`parquet_application.conf`。各个配置项的详细说明请参见[配置说明](../parameter-reference/ex-ug-parameter.md)。 ```conf { @@ -330,7 +330,7 @@ ### 步骤 4：向 Nebula Graph 导入数据 -运行如下命令将 Parquet 文件数据导入到 Nebula Graph 中。关于参数的说明，请参见 [导入命令参数](../parameter-reference/ex-ug-para-import-command.md)。 +运行如下命令将 Parquet 文件数据导入到 Nebula Graph 中。关于参数的说明，请参见[导入命令参数](../parameter-reference/ex-ug-para-import-command.md)。 ```bash ${SPARK_HOME}/bin/spark-submit --master "local" --class com.vesoft.nebula.exchange.Exchange -c @@ -360,4 +360,4 @@ GO FROM "player100" OVER follow; ### 步骤 6：（如有）在 Nebula Graph 中重建索引 -导入数据后，用户可以在 Nebula Graph 中重新创建并重建索引。详情请参见 [索引介绍](../../3.ngql-guide/14.native-index-statements/README.md)。 +导入数据后，用户可以在 Nebula Graph 中重新创建并重建索引。详情请参见[索引介绍](../../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 502b3a6628..86cfcff0dd 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 @@ -18,13 +18,13 @@ 开始导入数据之前，用户需要确认以下信息： -- 已经 [安装部署 Nebula Graph](../../4.deployment-and-installation/2.compile-and-install-nebula-graph/2.install-nebula-graph-by-rpm-or-deb.md) 并获取如下信息： +- 已经[安装部署 Nebula Graph](../../4.deployment-and-installation/2.compile-and-install-nebula-graph/2.install-nebula-graph-by-rpm-or-deb.md) 并获取如下信息： - Graph 服务和 Meta 服务的的 IP 地址和端口。 - 拥有 Nebula Graph 写权限的用户名和密码。 -- 已经编译 Exchange。详情请参见 [编译 Exchange](../ex-ug-compile.md)。本示例中使用 Exchange {{exchange.release}}。 +- 已经编译 Exchange。详情请参见[编译 Exchange](../ex-ug-compile.md)。本示例中使用 Exchange {{exchange.release}}。 - 已经安装 Spark。 @@ -72,11 +72,11 @@ nebula> CREATE EDGE serve(start_year int, end_year int); ``` -更多信息，请参见 [快速开始](../../2.quick-start/1.quick-start-workflow.md)。 +更多信息，请参见[快速开始](../../2.quick-start/1.quick-start-workflow.md)。 ### 步骤 2：修改配置文件 -编译 Exchange 后，复制`target/classes/application.conf`文件设置 Pulsar 数据源相关的配置。在本示例中，复制的文件名为`pulsar_application.conf`。各个配置项的详细说明请参见 [配置说明](../parameter-reference/ex-ug-parameter.md)。 +编译 Exchange 后，复制`target/classes/application.conf`文件设置 Pulsar 数据源相关的配置。在本示例中，复制的文件名为`pulsar_application.conf`。各个配置项的详细说明请参见[配置说明](../parameter-reference/ex-ug-parameter.md)。 ```conf { @@ -272,7 +272,7 @@ ### 步骤 3：向 Nebula Graph 导入数据 -运行如下命令将 Pulsar 数据导入到 Nebula Graph 中。关于参数的说明，请参见 [导入命令参数](../parameter-reference/ex-ug-para-import-command.md)。 +运行如下命令将 Pulsar 数据导入到 Nebula Graph 中。关于参数的说明，请参见[导入命令参数](../parameter-reference/ex-ug-para-import-command.md)。 ```bash ${SPARK_HOME}/bin/spark-submit --master "local" --class com.vesoft.nebula.exchange.Exchange -c @@ -302,4 +302,4 @@ GO FROM "player100" OVER follow; ### 步骤 5：（如有）在 Nebula Graph 中重建索引 -导入数据后，用户可以在 Nebula Graph 中重新创建并重建索引。详情请参见 [索引介绍](../../3.ngql-guide/14.native-index-statements/README.md)。 \ No newline at end of file +导入数据后，用户可以在 Nebula Graph 中重新创建并重建索引。详情请参见[索引介绍](../../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 c947fe3c04..6c056db307 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 @@ -38,7 +38,7 @@ SST 文件是一个内部包含了任意长度的有序键值对集合的文件 1. Reader 从数据源中读取数据。 -2. sstProcessor 根据 Nebula Graph 的 Schema 信息生成 SST 文件，然后上传至 HDFS。SST 文件的格式请参见 [数据存储格式](../../1.introduction/3.nebula-graph-architecture/4.storage-service.md)。 +2. sstProcessor 根据 Nebula Graph 的 Schema 信息生成 SST 文件，然后上传至 HDFS。SST 文件的格式请参见[数据存储格式](../../1.introduction/3.nebula-graph-architecture/4.storage-service.md)。 3. sstWriter 打开一个文件并插入数据。生成 SST 文件时，Key 必须按照顺序写入。 @@ -79,7 +79,7 @@ SST 文件是一个内部包含了任意长度的有序键值对集合的文件 开始导入数据之前，用户需要确认以下信息： -- 已经 [安装部署 Nebula Graph {{nebula.release}}](../../4.deployment-and-installation/2.compile-and-install-nebula-graph/2.install-nebula-graph-by-rpm-or-deb.md) 并获取如下信息： +- 已经[安装部署 Nebula Graph {{nebula.release}}](../../4.deployment-and-installation/2.compile-and-install-nebula-graph/2.install-nebula-graph-by-rpm-or-deb.md) 并获取如下信息： - Graph 服务和 Meta 服务的的 IP 地址和端口。 @@ -91,7 +91,7 @@ SST 文件是一个内部包含了任意长度的有序键值对集合的文件 - Schema 的信息，包括 Tag 和 Edge type 的名称、属性等。 -- 已经 [编译 Exchange](../ex-ug-compile.md)，或者直接 [下载](https://repo1.maven.org/maven2/com/vesoft/nebula-exchange/) 编译完成的。jar 文件。本示例中使用 Exchange {{exchange.release}}。 +- 已经[编译 Exchange](../ex-ug-compile.md)，或者直接[下载](https://repo1.maven.org/maven2/com/vesoft/nebula-exchange/) 编译完成的。jar 文件。本示例中使用 Exchange {{exchange.release}}。 - 已经安装 Spark。 @@ -147,7 +147,7 @@ SST 文件是一个内部包含了任意长度的有序键值对集合的文件 nebula> CREATE EDGE serve(start_year int, end_year int); ``` -更多信息，请参见 [快速开始](../../2.quick-start/1.quick-start-workflow.md)。 +更多信息，请参见[快速开始](../../2.quick-start/1.quick-start-workflow.md)。 ### 步骤 2：处理 CSV 文件 @@ -163,7 +163,7 @@ SST 文件是一个内部包含了任意长度的有序键值对集合的文件 ### 步骤 3：修改配置文件 -编译 Exchange 后，复制`target/classes/application.conf`文件设置相关配置。在本示例中，复制的文件名为`sst_application.conf`。各个配置项的详细说明请参见 [配置说明](../parameter-reference/ex-ug-parameter.md)。 +编译 Exchange 后，复制`target/classes/application.conf`文件设置相关配置。在本示例中，复制的文件名为`sst_application.conf`。各个配置项的详细说明请参见[配置说明](../parameter-reference/ex-ug-parameter.md)。 ```conf { @@ -440,7 +440,7 @@ SST 文件是一个内部包含了任意长度的有序键值对集合的文件 ### 步骤 4：生成 SST 文件 -运行如下命令将 CSV 源文件生成为 SST 文件。关于参数的说明，请参见 [命令参数](../parameter-reference/ex-ug-para-import-command.md)。 +运行如下命令将 CSV 源文件生成为 SST 文件。关于参数的说明，请参见[命令参数](../parameter-reference/ex-ug-para-import-command.md)。 ```bash ${SPARK_HOME}/bin/spark-submit --master "local" --conf spark.sql.shuffle.partition= --class com.vesoft.nebula.exchange.Exchange -c @@ -522,4 +522,4 @@ GO FROM "player100" OVER follow; ### 步骤 7：（如有）在 Nebula Graph 中重建索引 -导入数据后，用户可以在 Nebula Graph 中重新创建并重建索引。详情请参见 [索引介绍](../../3.ngql-guide/14.native-index-statements/README.md)。 +导入数据后，用户可以在 Nebula Graph 中重新创建并重建索引。详情请参见[索引介绍](../../3.ngql-guide/14.native-index-statements/README.md)。 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 c3eb6af07a..2a9366d9cb 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 @@ -6,7 +6,7 @@ 在连接 Nebula Graph 数据库前，用户需要确认以下信息： -- 已经安装部署了 Explorer。详细信息参考 [部署 Explorer](../deploy-connect/ex-ug-connect.md)。 +- 已经安装部署了 Explorer。详细信息参考[部署 Explorer](../deploy-connect/ex-ug-connect.md)。 - Nebula Graph 的 Graph 服务本机 IP 地址以及服务所用端口。默认端口为 `9669`。 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 aac9a57268..099d70fd31 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 @@ -40,7 +40,7 @@ !!! enterpriseonly - Explorer 仅在企业版提供，点击 [定价](https://nebula-graph.com.cn/pricing/) 查看更多。 + Explorer 仅在企业版提供，点击[定价](https://nebula-graph.com.cn/pricing/) 查看更多。 2. 使用`sudo rpm -i `命令安装 RPM 包。 @@ -126,7 +126,7 @@ $ sudo rpm -e nebula-explorer-.x86_64 !!! enterpriseonly - Explorer 仅在企业版提供，点击 [定价](https://nebula-graph.com.cn/pricing/) 查看更多。 + Explorer 仅在企业版提供，点击[定价](https://nebula-graph.com.cn/pricing/) 查看更多。 2. 使用 `tar -xvf` 解压 tar 包。 @@ -172,4 +172,4 @@ $ kill $(lsof -t -i :7002) ![Nebula Explorer 登录页面](../figs/ex-ug-002-1.png) -进入 Explorer 登录界面后，用户需要连接 Nebula Graph。详细信息，参考 [连接数据库](../deploy-connect/ex-ug-connect.md)。 +进入 Explorer 登录界面后，用户需要连接 Nebula Graph。详细信息，参考[连接数据库](../deploy-connect/ex-ug-connect.md)。 diff --git a/docs-2.0/nebula-explorer/operation-guide/ex-ug-canvas.md b/docs-2.0/nebula-explorer/operation-guide/ex-ug-canvas.md index 4fc9cf884d..da747c3d27 100644 --- a/docs-2.0/nebula-explorer/operation-guide/ex-ug-canvas.md +++ b/docs-2.0/nebula-explorer/operation-guide/ex-ug-canvas.md @@ -24,7 +24,7 @@ Explorer 支持批量选中多个点边，并查看选中点边的数据，详 ## 快速操作 -用户可以选择一个或多个点和边，在空白处点击右键可以进行对点进行扩展、查找两个点之间的路径、在页面中显示或隐藏其属性等操作。用户选择的点和边数据会影响到可以执行的操作，具体操作的说明参见 [图探索拓展](../operation-guide/ex-ug-graph-exploration.md)。 +用户可以选择一个或多个点和边，在空白处点击右键可以进行对点进行扩展、查找两个点之间的路径、在页面中显示或隐藏其属性等操作。用户选择的点和边数据会影响到可以执行的操作，具体操作的说明参见[图探索拓展](../operation-guide/ex-ug-graph-exploration.md)。 ![quick](../figs/ex-ug-026-1.png) 点击 **适合选中尺寸** 可以将选中的数据，移动到画布的中心，方便用户查看。 diff --git a/docs-2.0/nebula-explorer/operation-guide/ex-ug-page-overview.md b/docs-2.0/nebula-explorer/operation-guide/ex-ug-page-overview.md index 531cdc287c..5756be0bdb 100644 --- a/docs-2.0/nebula-explorer/operation-guide/ex-ug-page-overview.md +++ b/docs-2.0/nebula-explorer/operation-guide/ex-ug-page-overview.md @@ -45,7 +45,7 @@ Explorer 的主页面分为五个部分： - 拖动画布：单击！[moveCanvas](../figs/nav-moveCanvas.png) 图标，支持拖动画布的位置。 - 节点过滤：单击！[filter](../figs/nav-filter.png) 图标，支持对画布中显示的点进行过滤。 -更多详细信息参考 [画布操作](../operation-guide/ex-ug-canvas.md)。 +更多详细信息参考[画布操作](../operation-guide/ex-ug-canvas.md)。 ### 图探索扩展 @@ -54,7 +54,7 @@ Explorer 的主页面分为五个部分： - 路径查询：单击 ![findPath](../figs/rightclickmenu-findPath.png) 图标，可以查询起点到终点之间的 `all paths` 、 `Shortest path` 或者是 `Noloop path` 的路径。 - 查看属性：单击 ![propertyView](../figs/nav-propertyView.png) 图标，选择是否显画布中的点或边的属性值。 -更多详细信息参考 [图探索拓展](../operation-guide/ex-ug-graph-exploration.md)。 +更多详细信息参考[图探索拓展](../operation-guide/ex-ug-graph-exploration.md)。 ### 删除及撤销 @@ -78,7 +78,7 @@ Explorer 的主页面分为五个部分： ![review](../figs/ex-ug-027-1.png) -更多详细操作参考 [画布操作](../operation-guide/ex-ug-canvas.md)。 +更多详细操作参考[画布操作](../operation-guide/ex-ug-canvas.md)。 ## 缩略图 diff --git a/docs-2.0/nebula-importer/use-importer.md b/docs-2.0/nebula-importer/use-importer.md index 5bf93194bb..0eed7a6851 100644 --- a/docs-2.0/nebula-importer/use-importer.md +++ b/docs-2.0/nebula-importer/use-importer.md @@ -71,7 +71,7 @@ Importer 适用于将本地 CSV 文件的内容导入至 Nebula Graph 中。 ``` !!! note - yaml 配置文件说明请参见 [配置文件](#_7)。 + yaml 配置文件说明请参见[配置文件](#_7)。 ### 无网络编译方式 @@ -103,7 +103,7 @@ Importer 适用于将本地 CSV 文件的内容导入至 Nebula Graph 中。 ### Docker 方式运行 -使用 Docker 可以不必在本地安装 Go 语言环境，只需要拉取 Nebula Importer 的 [镜像](https://hub.docker.com/r/vesoft/nebula-importer)，并将本地配置文件和 CSV 数据文件挂载到容器中。命令如下： +使用 Docker 可以不必在本地安装 Go 语言环境，只需要拉取 Nebula Importer 的[镜像](https://hub.docker.com/r/vesoft/nebula-importer)，并将本地配置文件和 CSV 数据文件挂载到容器中。命令如下： ```bash $ docker run --rm -ti \ @@ -214,8 +214,8 @@ files: |`files.limit`|-|否|读取数据的行数限制。| |`files.inOrder`|-|否|是否按顺序在文件中插入数据行。如果为`false`，可以避免数据倾斜导致的导入速率降低。| |`files.type`|-|是|文件类型。| -|`files.csv.withHeader`|`false`|是|是否有表头。详情请参见 [关于 CSV 文件表头](#csvheader)。| -|`files.csv.withLabel`|`false`|是|是否有 LABEL。详情请参见 [有表头配置说明](config-with-header.md)。| +|`files.csv.withHeader`|`false`|是|是否有表头。详情请参见[关于 CSV 文件表头](#csvheader)。| +|`files.csv.withLabel`|`false`|是|是否有 LABEL。详情请参见[有表头配置说明](config-with-header.md)。| |`files.csv.delimiter`|`","`|是|指定 csv 文件的分隔符。只支持一个字符的字符串分隔符。| #### Schema 配置 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 a932b68865..dd02b5e03e 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 @@ ## 基本概念 -Nebula Operator 是用于在 [Kubernetes](https://kubernetes.io) 系统上自动化部署和运维 [Nebula Graph](https://github.com/vesoft-inc/nebula) 集群的工具。依托于 Kubernetes 扩展机制，Nebula Graph 将其运维领域的知识全面注入至 Kubernetes 系统中，让 Nebula Graph 成为真正的 [云原生图数据库](https://www.nebula-cloud.io/)。 +Nebula Operator 是用于在 [Kubernetes](https://kubernetes.io) 系统上自动化部署和运维 [Nebula Graph](https://github.com/vesoft-inc/nebula) 集群的工具。依托于 Kubernetes 扩展机制，Nebula Graph 将其运维领域的知识全面注入至 Kubernetes 系统中，让 Nebula Graph 成为真正的[云原生图数据库](https://www.nebula-cloud.io/)。 ## 工作原理 @@ -14,13 +14,13 @@ Nebula Operator 将 Nebula Graph 集群的部署管理抽象为 CRD。通过结 Nebula Operator 已具备的功能如下： -- **集群创建和卸载**：Nebula Operator 简化了用户部署和卸载集群的过程。用户只需提供对应的 CR 文件，Nebula Operator 即可快速创建或者删除一个对应的 Nebula Graph 集群。更多信息参考 [使用 Kubectl 部署 Nebula Graph 集群](3.deploy-nebula-graph-cluster/3.1create-cluster-with-kubectl.md) 或者 [使用 Helm 部署 Nebula Graph 集群](3.deploy-nebula-graph-cluster/3.2create-cluster-with-helm.md)。 +- **集群创建和卸载**：Nebula Operator 简化了用户部署和卸载集群的过程。用户只需提供对应的 CR 文件，Nebula Operator 即可快速创建或者删除一个对应的 Nebula Graph 集群。更多信息参考[使用 Kubectl 部署 Nebula Graph 集群](3.deploy-nebula-graph-cluster/3.1create-cluster-with-kubectl.md) 或者[使用 Helm 部署 Nebula Graph 集群](3.deploy-nebula-graph-cluster/3.2create-cluster-with-helm.md)。 -- **集群扩容和缩容**：通过在控制循环中调用 Nebula Graph 原生提供的扩缩容接口，Nebula Graph 封装 Nebula 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 Graph 原生提供的扩缩容接口，Nebula Graph 封装 Nebula 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)。 - **集群升级**：支持升级 2.5.x 版的 Nebula Graph 集群至 2.6.x 版。 -- **故障自愈**：Nebula Operator 调用 Nebula Graph 集群提供的接口，动态地感知服务状态。一旦发现异常，Nebula Operator 自动进行容错处理。更多信息参考 [故障自愈](5.operator-failover.md)。 +- **故障自愈**：Nebula Operator 调用 Nebula Graph 集群提供的接口，动态地感知服务状态。一旦发现异常，Nebula Operator 自动进行容错处理。更多信息参考[故障自愈](5.operator-failover.md)。 - **均衡调度**：基于调度器扩展接口，Nebula Operator 提供的调度器可以将应用 Pods 均匀地分布在 Nebula Graph 集群中。 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 f805802c73..f0d8c7af6a 100644 --- a/docs-2.0/nebula-operator/2.deploy-nebula-operator.md +++ b/docs-2.0/nebula-operator/2.deploy-nebula-operator.md @@ -30,7 +30,7 @@ - [CoreDNS](https://coredns.io/) - CoreDNS 是一个灵活的、可扩展的 DNS 服务器，被 [安装](https://github.com/coredns/deployment/tree/master/kubernetes) 在集群内作为集群内 Pods 的 DNS 服务器。 + CoreDNS 是一个灵活的、可扩展的 DNS 服务器，被[安装](https://github.com/coredns/deployment/tree/master/kubernetes) 在集群内作为集群内 Pods 的 DNS 服务器。 Nebula Graph 集群中的每个组件通过 DNS 解析类似`x.default.svc.cluster.local`这样的域名相互通信。 @@ -152,7 +152,7 @@ scheduler: | `shceduler.schedulerName` | `nebula-scheduler` | 调度器名称。 | | `shceduler.replicas` | `2` | nebula-scheduler 副本数。 | -执行`helm install [NAME] [CHART] [flags]`命令安装 Chart 时，可指定 Chart 配置。更多信息，参考 [安装前自定义 Chart](https://helm.sh/docs/intro/using_helm/#customizing-the-chart-before-installing)。 +执行`helm install [NAME] [CHART] [flags]`命令安装 Chart 时，可指定 Chart 配置。更多信息，参考[安装前自定义 Chart](https://helm.sh/docs/intro/using_helm/#customizing-the-chart-before-installing)。 以下示例为在安装 Nebula Operator 时，指定 Nebula Operator 的 AdmissionWebhook 机制为关闭状态（默认开启 AdmissionWebhook）： @@ -264,4 +264,4 @@ helm install nebula-operator nebula-operator/nebula-operator --namespace=-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 f422d82d77..3f44a29c51 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 @@ -5,6 +5,6 @@ 1. [安装 Nebula Operator](2.deploy-nebula-operator.md)。 2. 创建 Nebula Graph 集群。 - 具体步骤参考 [使用 Kubectl 部署 Nebula Graph 集群](3.deploy-nebula-graph-cluster/3.1create-cluster-with-kubectl.md) 或者 [使用 Helm 部署 Nebula Graph 集群](3.deploy-nebula-graph-cluster/3.2create-cluster-with-helm.md)。 + 具体步骤参考[使用 Kubectl 部署 Nebula Graph 集群](3.deploy-nebula-graph-cluster/3.1create-cluster-with-kubectl.md) 或者[使用 Helm 部署 Nebula Graph 集群](3.deploy-nebula-graph-cluster/3.2create-cluster-with-helm.md)。 3. [连接 Nebula Graph 服务](4.connect-to-nebula-graph-service.md)。 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 10cec10fc1..ab8cdcc037 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 @@ -14,7 +14,7 @@ Config map[string]string `json:"config,omitempty"` ## 前提条件 -已使用 K8s 创建一个集群。具体步骤，参见 [使用 Kubectl 创建 Nebula Graph 集群](../3.deploy-nebula-graph-cluster/3.1create-cluster-with-kubectl.md)。 +已使用 K8s 创建一个集群。具体步骤，参见[使用 Kubectl 创建 Nebula Graph 集群](../3.deploy-nebula-graph-cluster/3.1create-cluster-with-kubectl.md)。 ## 操作步骤 @@ -61,4 +61,4 @@ Config map[string]string `json:"config,omitempty"` ## 更多信息 -有关 Meta、Storage、Graph 服务的配置参数的详细介绍，参见 [服务配置文件](../../5.configurations-and-logs/1.configurations/1.configurations.md)。 +有关 Meta、Storage、Graph 服务的配置参数的详细介绍，参见[服务配置文件](../../5.configurations-and-logs/1.configurations/1.configurations.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 32a38c6689..64780af087 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 @@ -8,7 +8,7 @@ Nebula Operator 使用持久化卷 PV（Persistent Volume）和持久化卷声 ## 前提条件 -已使用 K8s 创建一个集群。具体步骤，参见 [使用 Kubectl 创建 Nebula Graph 集群](../3.deploy-nebula-graph-cluster/3.1create-cluster-with-kubectl.md)。 +已使用 K8s 创建一个集群。具体步骤，参见[使用 Kubectl 创建 Nebula Graph 集群](../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 863f7ea302..22e8f70b91 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 @@ -8,7 +8,7 @@ Nebula Graph 的 Storage 服务的扩容分为两个阶段，第一个阶段等 ## 前提条件 -已使用 K8s 创建一个集群。具体步骤，参见 [使用 Kubectl 创建 Nebula Graph 集群](../3.deploy-nebula-graph-cluster/3.1create-cluster-with-kubectl.md)。 +已使用 K8s 创建一个集群。具体步骤，参见[使用 Kubectl 创建 Nebula Graph 集群](../3.deploy-nebula-graph-cluster/3.1create-cluster-with-kubectl.md)。 ## 操作步骤 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 2a1df6d479..613ac0bafa 100644 --- a/docs-2.0/nebula-operator/9.upgrade-nebula-cluster.md +++ b/docs-2.0/nebula-operator/9.upgrade-nebula-cluster.md @@ -14,7 +14,7 @@ ### 前提条件 -已创建 Nebula Graph 集群。具体步骤，参见 [使用 Kubectl 创建 Nebula Graph 集群](3.deploy-nebula-graph-cluster/3.1create-cluster-with-kubectl.md)。 +已创建 Nebula Graph 集群。具体步骤，参见[使用 Kubectl 创建 Nebula Graph 集群](3.deploy-nebula-graph-cluster/3.1create-cluster-with-kubectl.md)。 本文示例中待升级的 Nebula Graph 版本为 2.5.1，其 YAML 文件名为`apps_v1alpha1_nebulacluster.yaml`。 @@ -136,7 +136,7 @@ ### 前提条件 -已创建 Nebula Graph 集群。具体步骤，参见 [使用 Helm 创建 Nebula Graph 集群](3.deploy-nebula-graph-cluster/3.2create-cluster-with-helm.md)。 +已创建 Nebula Graph 集群。具体步骤，参见[使用 Helm 创建 Nebula Graph 集群](3.deploy-nebula-graph-cluster/3.2create-cluster-with-helm.md)。 ### 操作步骤 diff --git a/docs-2.0/nebula-spark-connector.md b/docs-2.0/nebula-spark-connector.md index 14342e2da6..e526d893c8 100644 --- a/docs-2.0/nebula-spark-connector.md +++ b/docs-2.0/nebula-spark-connector.md @@ -225,7 +225,7 @@ df.write.nebula(config, nebulaWriteVertexConfig).writeVertices() |`withVidField` |是| DataFrame 中作为点 ID 的列。 | |`withVidPolicy` |否| 写入点 ID 时，采用的映射函数，Nebula Graph 2.x 仅支持 HASH。默认不做映射。 | |`withVidAsProp` |否| DataFrame 中作为点 ID 的列是否也作为属性写入。默认值为`false`。如果配置为`true`，请确保 Tag 中有和`VidField`相同的属性名。 | - |`withUser` |否| Nebula Graph 用户名。若未开启 [身份验证](7.data-security/1.authentication/1.authentication.md)，无需配置用户名和密码。 | + |`withUser` |否| Nebula Graph 用户名。若未开启[身份验证](7.data-security/1.authentication/1.authentication.md)，无需配置用户名和密码。 | |`withPasswd` |否| Nebula Graph 用户名对应的密码。 | |`withBatch` |是| 一次写入的数据行数。默认值为`1000`. | |`withWriteMode`|否|写入模式。可选值为`insert`和`update`。默认为`insert`。| @@ -244,7 +244,7 @@ df.write.nebula(config, nebulaWriteVertexConfig).writeVertices() |`withSrcAsProperty` |否| DataFrame 中作为起始点的列是否也作为属性写入。默认值为`false`。如果配置为`true`，请确保 Edge type 中有和`SrcIdField`相同的属性名。 | |`withDstAsProperty` |否| DataFrame 中作为目的点的列是否也作为属性写入。默认值为`false`。如果配置为`true`，请确保 Edge type 中有和`DstIdField`相同的属性名。 | |`withRankAsProperty` |否| DataFrame 中作为 rank 的列是否也作为属性写入。默认值为`false`。如果配置为`true`，请确保 Edge type 中有和`RankField`相同的属性名。 | - |`withUser` |否| Nebula Graph 用户名。若未开启 [身份验证](7.data-security/1.authentication/1.authentication.md)，无需配置用户名和密码。 | + |`withUser` |否| Nebula Graph 用户名。若未开启[身份验证](7.data-security/1.authentication/1.authentication.md)，无需配置用户名和密码。 | |`withPasswd` |否| Nebula Graph 用户名对应的密码。 | |`withBatch` |是| 一次写入的数据行数。默认值为`1000`. | |`withWriteMode`|否|写入模式。可选值为`insert`和`update`。默认为`insert`。| diff --git a/docs-2.0/nebula-studio/about-studio/st-ug-limitations.md b/docs-2.0/nebula-studio/about-studio/st-ug-limitations.md index 320cee2d93..a472f1247e 100644 --- a/docs-2.0/nebula-studio/about-studio/st-ug-limitations.md +++ b/docs-2.0/nebula-studio/about-studio/st-ug-limitations.md @@ -54,7 +54,7 @@ Studio 上传数据仅支持上传无表头的 CSV 文件，但是，单个文 - `GRANT ROLE` - `REVOKE ROLE` -关于语句的详细信息，参考 [用户管理](../../7.data-security/1.authentication/2.management-user.md "点击前往用户管理")。 +关于语句的详细信息，参考[用户管理](../../7.data-security/1.authentication/2.management-user.md "点击前往用户管理")。 --> ## 浏览器支持 diff --git a/docs-2.0/nebula-studio/about-studio/st-ug-what-is-graph-studio.md b/docs-2.0/nebula-studio/about-studio/st-ug-what-is-graph-studio.md index 4b87df0b58..ca88d5cd35 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 @@ -9,13 +9,13 @@ Nebula Graph Studio（简称 Studio）是一款可以通过 Web 访问的图数 - Docker 版本：用户可以使用 Docker 服务部署 Studio，并连接到 Nebula Graph 数据库。详细信息参考 [Docker 部署 Studio](../deploy-connect/st-ug-deploy.md)。 - RPM 版本：用户可以使用 RPM 服务部署 Studio，并连接到 Nebula Graph 数据库。详细信息参考 [RPM 部署 Studio](../deploy-connect/st-ug-deploy.md)。 - tar 包安装部署：用户可以使用 tar 包安装并部署 Studio，并连接到 Nebula Graph 数据库。详细信息参考 [tar 包部署 Studio](../deploy-connect/st-ug-deploy.md)。 -- 使用 Helm 安装部署：在 Kubernetes 集群里使用 Helm 安装并部署 Studio，并连接到 Nebula Graph 数据库。详细信息参考 [使用 Helm 部署 Nebula Graph Studio](../deploy-connect/st-ug-deploy-by-helm.md)。 +- 使用 Helm 安装部署：在 Kubernetes 集群里使用 Helm 安装并部署 Studio，并连接到 Nebula Graph 数据库。详细信息参考[使用 Helm 部署 Nebula Graph Studio](../deploy-connect/st-ug-deploy-by-helm.md)。 -四种部署方式功能基本相同，在使用 Studio 时可能会受到限制。详细信息，参考 [使用限制](st-ug-limitations.md)。 +四种部署方式功能基本相同，在使用 Studio 时可能会受到限制。详细信息，参考[使用限制](st-ug-limitations.md)。 ## 产品功能 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 80fb9eb746..48089228d6 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 @@ -9,7 +9,7 @@ 在连接 Nebula Graph 数据库前，用户需要确认以下信息： -- Studio 已经启动。详细信息参考 [部署 Studio](st-ug-deploy.md)。 +- Studio 已经启动。详细信息参考[部署 Studio](st-ug-deploy.md)。 - Nebula Graph 的 Graph 服务本机 IP 地址以及服务所用端口。默认端口为 `9669`。 @@ -50,5 +50,5 @@ 成功连接 Nebula Graph 数据库后，根据账号的权限，用户可以选择执行以下操作： - 如果已拥有 GOD 或者 ADMIN 权限的账号登录，可以使用 [**控制台**](../quick-start/st-ug-create-schema.md) 或者 [**Schema**](../manage-schema/st-ug-crud-space.md) 页面管理 Schema。 -- 如果已拥有 GOD、ADMIN、DBA 或者 USER 权限的账号登录，可以 [批量导入数据](../quick-start/st-ug-import-data.md) 或者在 **控制台** 页面上运行 nGQL 语句插入数据。 +- 如果已拥有 GOD、ADMIN、DBA 或者 USER 权限的账号登录，可以[批量导入数据](../quick-start/st-ug-import-data.md) 或者在 **控制台** 页面上运行 nGQL 语句插入数据。 - 如果已拥有 GOD、ADMIN、DBA、USER 或者 GUEST 权限的账号登录，可以在 **控制台** 页面上运行 nGQL 语句读取数据或者在 **图探索** 页面上进行图探索或数据分析。 diff --git a/docs-2.0/nebula-studio/deploy-connect/st-ug-deploy-by-helm.md b/docs-2.0/nebula-studio/deploy-connect/st-ug-deploy-by-helm.md index aa1c5d3fb8..c43ed06af3 100644 --- a/docs-2.0/nebula-studio/deploy-connect/st-ug-deploy-by-helm.md +++ b/docs-2.0/nebula-studio/deploy-connect/st-ug-deploy-by-helm.md @@ -44,7 +44,7 @@ $ helm uninstall my-studio ## 后续操作 -进入 Studio 登录界面后，用户需要连接 Nebula Graph。详细信息，参考 [连接数据库](st-ug-connect.md)。 +进入 Studio 登录界面后，用户需要连接 Nebula Graph。详细信息，参考[连接数据库](st-ug-connect.md)。 ## Nebula Graph Studio chart 配置参数说明 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 64e4ceda5f..27a4df6da2 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 @@ -264,4 +264,4 @@ $ npm run stop # stop nebula-graph-studio ## 后续操作 -进入 Studio 登录界面后，用户需要连接 Nebula Graph。详细信息，参考 [连接数据库](st-ug-connect.md)。 +进入 Studio 登录界面后，用户需要连接 Nebula Graph。详细信息，参考[连接数据库](st-ug-connect.md)。 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 ba3d596574..272fb7ff44 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 @@ -4,7 +4,7 @@ ## 支持版本 -Studio v{{ studio.release }} 及以后版本。请更新版本，详细操作参考 [版本更新](../about-studio/st-ug-check-updates.md)。 +Studio v{{ studio.release }} 及以后版本。请更新版本，详细操作参考[版本更新](../about-studio/st-ug-check-updates.md)。 ## 前提条件 @@ -74,7 +74,7 @@ Studio v{{ studio.release }} 及以后版本。请更新版本，详细操作参 ## 删除 Edge type !!! danger - 删除 Edge type 前先确认 [影响](../../3.ngql-guide/11.edge-type-statements/2.drop-edge.md)，已删除的数据如未 [备份](../../7.data-security/3.manage-snapshot.md) 无法恢复。 + 删除 Edge type 前先确认[影响](../../3.ngql-guide/11.edge-type-statements/2.drop-edge.md)，已删除的数据如未[备份](../../7.data-security/3.manage-snapshot.md) 无法恢复。 按以下步骤使用 **Schema** 删除 Edge type： 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 cd17cee4c2..9fc36e6abe 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 @@ -8,7 +8,7 @@ ## 支持版本 -Studio v{{ studio.release }} 及以后版本。请更新版本，详细操作参考 [版本更新](../about-studio/st-ug-check-updates.md)。 +Studio v{{ studio.release }} 及以后版本。请更新版本，详细操作参考[版本更新](../about-studio/st-ug-check-updates.md)。 ## 前提条件 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 e151c76a96..bd9deeadb7 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 @@ -4,7 +4,7 @@ Studio 连接到 Nebula Graph 数据库后，用户可以创建或删除图空 ## 支持版本 -Studio v{{ studio.release }} 及以后版本。请更新版本，详细操作参考 [版本更新](../about-studio/st-ug-check-updates.md)。 +Studio v{{ studio.release }} 及以后版本。请更新版本，详细操作参考[版本更新](../about-studio/st-ug-check-updates.md)。 ## 前提条件 @@ -25,7 +25,7 @@ Studio v{{ studio.release }} 及以后版本。请更新版本，详细操作参 3. 在 **创建** 页面，完成以下配置： - - **名称**：指定图空间名称，本示例中设置为 `basketballplayer`。不可与已有的图空间名称重复。不可使用关键字或保留关键字做标识符，参考 [关键字](../../3.ngql-guide/1.nGQL-overview/keywords-and-reserved-words.md "点击前往 关键字")。 + - **名称**：指定图空间名称，本示例中设置为 `basketballplayer`。不可与已有的图空间名称重复。不可使用关键字或保留关键字做标识符，参考[关键字](../../3.ngql-guide/1.nGQL-overview/keywords-and-reserved-words.md "点击前往 关键字")。 - **vid type**：图空间中点 ID（VID）的数据类型，可选值为定长字符串 `FIXED_STRING()` 或 `INT64`，一旦定义无法修改。本示例设置为`FIXED_STRING(32)`，参考 [VID](../../1.introduction/3.vid.md)。 @@ -47,7 +47,7 @@ Studio v{{ studio.release }} 及以后版本。请更新版本，详细操作参 ## 删除图空间 !!! danger - 删除图空间会删除其中的所有数据，已删除的数据如未 [备份](../../7.data-security/3.manage-snapshot.md) 无法恢复。 + 删除图空间会删除其中的所有数据，已删除的数据如未[备份](../../7.data-security/3.manage-snapshot.md) 无法恢复。 按以下步骤使用 **Schema** 删除图空间： 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 a62f9bf0b0..11b93b5e20 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 @@ -4,7 +4,7 @@ ## 支持版本 -Studio v{{ studio.release }} 及以后版本。请更新版本，详细操作参考 [版本更新](../about-studio/st-ug-check-updates.md)。 +Studio v{{ studio.release }} 及以后版本。请更新版本，详细操作参考[版本更新](../about-studio/st-ug-check-updates.md)。 ## 前提条件 @@ -72,7 +72,7 @@ Studio v{{ studio.release }} 及以后版本。请更新版本，详细操作参 ## 删除 Tag !!! danger - 删除 Tag 前先确认 [影响](../../3.ngql-guide/10.tag-statements/2.drop-tag.md)，已删除的数据如未 [备份](../../7.data-security/3.manage-snapshot.md) 无法恢复。 + 删除 Tag 前先确认[影响](../../3.ngql-guide/10.tag-statements/2.drop-tag.md)，已删除的数据如未[备份](../../7.data-security/3.manage-snapshot.md) 无法恢复。 按以下步骤使用 **Schema** 删除 Tag： diff --git a/docs-2.0/nebula-studio/quick-start/st-ug-create-schema.md b/docs-2.0/nebula-studio/quick-start/st-ug-create-schema.md index 185a24ec8f..035822311e 100644 --- a/docs-2.0/nebula-studio/quick-start/st-ug-create-schema.md +++ b/docs-2.0/nebula-studio/quick-start/st-ug-create-schema.md @@ -26,9 +26,9 @@ 按以下步骤使用 **Schema** 创建 Schema： -1. 创建 Tag。详细信息，参考 [操作 Tag](../manage-schema/st-ug-crud-tag.md)。 +1. 创建 Tag。详细信息，参考[操作 Tag](../manage-schema/st-ug-crud-tag.md)。 -2. 创建 Edge type。详细信息，参考 [操作 Edge type](../manage-schema/st-ug-crud-edge-type.md)。 +2. 创建 Edge type。详细信息，参考[操作 Edge type](../manage-schema/st-ug-crud-edge-type.md)。 ## 使用控制台创建 Schema @@ -74,4 +74,4 @@ DESCRIBE EDGE serve; ## 后续操作 -创建 Schema 后，用户可以开始 [导入数据](st-ug-import-data.md)。 +创建 Schema 后，用户可以开始[导入数据](st-ug-import-data.md)。 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 949fe05591..152eae61a6 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 @@ -26,7 +26,7 @@ !!! Note - 一次可以选择多个 CSV 文件，本文使用的 CSV 文件可以在 [规划 Schema ](st-ug-plan-schema.md) 中下载。 + 一次可以选择多个 CSV 文件，本文使用的 CSV 文件可以在[规划 Schema ](st-ug-plan-schema.md) 中下载。 4. 在文件列表的 **操作** 列，点击 **预览** 或 **删除**，保证文件信息正确，之后，再点击 **下一步** 按钮。 @@ -73,4 +73,4 @@ ## 后续操作 -完成数据导入后，用户可以开始 [图探索](st-ug-explore.md)。 +完成数据导入后，用户可以开始[图探索](st-ug-explore.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 6ae7bc6c8e..2fbe4dff54 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 @@ -2,7 +2,7 @@ ## 问题描述 -按 [连接 Studio](../deploy-connect/st-ug-connect.md) 文档操作，提示 **配置失败**。 +按[连接 Studio](../deploy-connect/st-ug-connect.md) 文档操作，提示 **配置失败**。 ## 可能的原因及解决方法 @@ -22,8 +22,8 @@ 检查 Nebula Graph 服务状态。关于查看服务的操作： -- 如果在 Linux 服务器上通过编译部署的 Nebula Graph，参考 [查看 Nebula Graph 服务](../../4.deployment-and-installation/2.compile-and-install-nebula-graph/deploy-nebula-graph-cluster.md "点击查看 Nebula Graph 内核文档")。 -- 如果使用 Docker Compose 部署和 RPM 部署的 Nebula Graph，参考 [查看 Nebula Graph 服务状态和端口](../deploy-connect/st-ug-deploy.md "点击前往 GitHub 网站")。 +- 如果在 Linux 服务器上通过编译部署的 Nebula Graph，参考[查看 Nebula Graph 服务](../../4.deployment-and-installation/2.compile-and-install-nebula-graph/deploy-nebula-graph-cluster.md "点击查看 Nebula Graph 内核文档")。 +- 如果使用 Docker Compose 部署和 RPM 部署的 Nebula Graph，参考[查看 Nebula Graph 服务状态和端口](../deploy-connect/st-ug-deploy.md "点击前往 GitHub 网站")。 如果 Nebula Graph 服务正常，进入第 4 步继续排查问题。否则，请重启 Nebula Graph 服务。 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 e1a01f8312..4edbf2e7cc 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 @@ -27,7 +27,7 @@ nebula-web-docker_nginx_1 /docker-entrypoint.sh ngin ... Up 0.0.0.0: nebula-web-docker_web_1 docker-entrypoint.sh npm r ... Up 0.0.0.0:32784->7001/tcp ``` -如果没有返回以上结果，则先停止 Studio 重新启动。详细信息，参考 [部署 Studio](../deploy-connect/st-ug-deploy.md)。 +如果没有返回以上结果，则先停止 Studio 重新启动。详细信息，参考[部署 Studio](../deploy-connect/st-ug-deploy.md)。 !!! Note 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 0c3915bab2..b771387da4 100644 --- a/docs-2.0/nebula-studio/troubleshooting/st-ug-faq.md +++ b/docs-2.0/nebula-studio/troubleshooting/st-ug-faq.md @@ -5,8 +5,8 @@ 如果发现无法使用某个功能，建议按以下步骤排除问题： 1. 确认 Nebula Graph 是最新版本。如果使用 Docker Compose 部署 Nebula Graph 数据库，建议运行 `docker-compose pull && docker-compose up -d` 拉取最新的 Docker 镜像，并启动容器。 -2. 确认 Studio 是最新版本。详细信息参考 [版本更新](../about-studio/st-ug-check-updates.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) 项目，确认是否已经有类似的问题。 +2. 确认 Studio 是最新版本。详细信息参考[版本更新](../about-studio/st-ug-check-updates.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. 如果上述操作均未解决问题，欢迎在论坛上提交问题。 +用户可以使用已支持的[客户端或者命令行工具](https://docs.nebula-graph.com.cn/{{nebula.release}}/20.appendix/6.eco-tool-version/) 来连接 Nebula Graph 数据库。 +- Nebula Graph 服务已[启动](https://docs.nebula-graph.com.cn/{{nebula.release}}/4.deployment-and-installation/manage-service/)。 - 运行 Nebula Console 的机器和运行 Nebula Graph 的服务器网络互通。 @@ -77,7 +77,7 @@ Nebula Graph 支持多种类型客户端，包括 CLI 客户端、GUI 客户端 | `-e/-eval` | 设置字符串类型的 nGQL 语句。连接成功后会执行一次该语句并返回结果，然后自动断开连接。 | | `-f/-file` | 设置存储 nGQL 语句的文件的路径。连接成功后会执行该文件内的 nGQL 语句并返回结果，执行完毕后自动断开连接。 | -用户可以使用`./nebula-console --help`命令获取所有参数的说明，也可以在 [项目仓库](https://github.com/vesoft-inc/nebula-console/tree/{{console.branch}}) 找到更多说明。 +用户可以使用`./nebula-console --help`命令获取所有参数的说明，也可以在[项目仓库](https://github.com/vesoft-inc/nebula-console/tree/{{console.branch}}) 找到更多说明。 ## Nebula Console 命令 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 b592860bc2..8dd5ee30ca 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 @@ -2,7 +2,7 @@ RPM 和 DEB 是 Linux 系统下常见的两种安装包格式，本文介绍如 !!! note - 部署 Nebula Graph 集群的方式参见 [使用 RPM/DEB 包部署集群](https://docs.nebula-graph.com.cn/{{nebula.release}}/4.deployment-and-installation/deploy-nebula-graph-cluster/)。 + 部署 Nebula Graph 集群的方式参见[使用 RPM/DEB 包部署集群](https://docs.nebula-graph.com.cn/{{nebula.release}}/4.deployment-and-installation/deploy-nebula-graph-cluster/)。 !!! enterpriseonly 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 index 4222bc9dac..2f0d414e38 100644 --- a/docs-2.0/spark-connector/reader/sc-ug-reader-example.md +++ b/docs-2.0/spark-connector/reader/sc-ug-reader-example.md @@ -11,7 +11,7 @@ - Scala - Java：1.8 -- 已经成功编译 Nebula Spark Connector Reader，并已经将 `nebula-spark-1.x.y.jar` 复制到本地 Maven 库。详细信息参考 [编译 Nebula Spark Connector](../sc-ug-compile.md) +- 已经成功编译 Nebula Spark Connector Reader，并已经将 `nebula-spark-1.x.y.jar` 复制到本地 Maven 库。详细信息参考[编译 Nebula Spark Connector](../sc-ug-compile.md) - 已经获取 Nebula Graph 数据库的以下信息： - 图空间名称和分区数量（如果创建图空间时未设置分区数量，则默认使用 100） 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 index 9accc79701..21f7afffe4 100644 --- a/docs-2.0/spark-connector/writer/sc-ug-writer-example.md +++ b/docs-2.0/spark-connector/writer/sc-ug-writer-example.md @@ -11,7 +11,7 @@ - Scala - Java：1.8 -- 已经成功编译 Nebula Spark Connector，并已经将 `nebula-spark-1.x.y.jar` 复制到本地 Maven 库。详细信息参考 [编译 Nebula Spark Connector](../sc-ug-compile.md)。 +- 已经成功编译 Nebula Spark Connector，并已经将 `nebula-spark-1.x.y.jar` 复制到本地 Maven 库。详细信息参考[编译 Nebula Spark Connector](../sc-ug-compile.md)。 - 待写入的点和边数据源。在本示例中所用的数据源为 JSON 文件，用户可以从 [nebula-java 库](https://github.com/vesoft-inc/nebula-java/tree/v1.0/examples/src/main/resources "点击前往 GitHub 网站") 中下载。