add zone in 3.6.0-ent

Update 5.zone.md Update 5.zone.md fix comments Update 3.1add-storage-hosts.md fix comment Update docs-2.0/3.ngql-guide/4.job-statements.md Update docs-2.0/3.ngql-guide/4.job-statements.md Update docs-2.0/3.ngql-guide/4.job-statements.md Update docs-2.0/3.ngql-guide/9.space-statements/1.create-space.md Update docs-2.0/4.deployment-and-installation/5.zone.md Update mkdocs.yml Update 5.zone.md Update 5.zone.md Update 3.1add-storage-hosts.md Update 6.cheatsheet-for-ngql-command.md Co-Authored-By: cooper-lzy <78672629+cooper-lzy@users.noreply.github.com>
vesoft-inc · Sep 8, 2023 · 2b7596c · 2b7596c
1 parent 160bce6
commit 2b7596c
Show file tree

Hide file tree

Showing 11 changed files with 236 additions and 127 deletions.
diff --git a/docs-2.0/2.quick-start/3.quick-start-on-premise/3.1add-storage-hosts.md b/docs-2.0/2.quick-start/3.quick-start-on-premise/3.1add-storage-hosts.md
@@ -27,12 +27,6 @@
  ADD HOSTS <ip>:<port> [,<ip>:<port> ...];
  ```
 
- <!--
- ```ngql
- ADD HOSTS <ip>:<port> [,<ip>:<port> ...] [INTO NEW ZONE "<new_zone_name>"];
- ```
- -->
-
  示例：
 
  ```ngql

diff --git a/docs-2.0/2.quick-start/6.cheatsheet-for-ngql-command.md b/docs-2.0/2.quick-start/6.cheatsheet-for-ngql-command.md
@@ -434,14 +434,20 @@
 
 * [SUBMIT JOB BALANCE](../synchronization-and-migration/2.balance-syntax.md)
 
+ {{comm.comm_begin}}
+ | 语法 | 说明 |
+ | :-------------------------------- | :----------------------------------------------------------- |
+ |`SUBMIT JOB BALANCE LEADER`|启动任务均衡分布所有图空间中的 leader。该命令会返回任务 ID。|
+ {{comm.comm_end}}
+
+ {{ent.ent_begin}}
  | 语法 | 说明 |
  | :-------------------------------- | :----------------------------------------------------------- |
  |`SUBMIT JOB BALANCE LEADER`|启动任务均衡分布所有图空间中的 leader。该命令会返回任务 ID。|
- {{ ent.ent_begin }}
  |`SUBMIT JOB BALANCE DATA`|启动任务均衡分布当前图空间中的所有分片。该命令会返回任务 ID（`job_id`）。|
  |`SUBMIT JOB BALANCE DATA REMOVE <ip:port> [,<ip>:<port> ...]`|启动任务迁空当前图空间指定的 Storage 服务中的分片。端口默认为`9779`。|
- {{ ent.ent_end }}
-
+ |`SUBMIT JOB BALANCE IN ZONE`|在当前图空间内每个 Zone 内部启动任务均衡分布分片。|
+ {{ent.ent_end}}
 
 * [作业管理](../3.ngql-guide/4.job-statements.md)
 
@@ -453,11 +459,7 @@
  | `SHOW JOB <job_id>` | 显示当前图空间内指定作业和相关任务的信息。Meta 服务将`SUBMIT JOB`请求解析为多个任务，然后分配给进程 nebula-storaged。 |
  | `SHOW JOBS` | 列出当前图空间内所有未过期的作业。 |
  | `STOP JOB` | 停止当前图空间内未完成的作业。 |
- | `RECOVER JOB` | 重新执行当前图空间内失败的作业，并返回已恢复的作业数量。 |
-<!-- balance-3.1
- |`SUBMIT JOB BALANCE IN ZONE`|在当前图空间内每个 Zone 内部启动任务均衡分布分片。|
- |`SUBMIT JOB BALANCE ACROSS ZONE`|在当前图空间内所有 Zone 之间启动任务均衡分布分片。|
--->
+ | `RECOVER JOB` | 重新执行当前图空间内失败的作业，并返回已恢复的作业数量。 ||
 
 * [终止查询](../3.ngql-guide/17.query-tuning-statements/6.kill-query.md)
 

diff --git a/docs-2.0/20.appendix/learning-path.md b/docs-2.0/20.appendix/learning-path.md
@@ -144,13 +144,13 @@
  | ------------------------------------------------------------ |
  |[创建快照](https://docs.nebula-graph.com.cn/{{nebula.release}}/backup-and-restore/3.manage-snapshot/#_5)|
 
-<!--
+ {{ent.ent_begin}}
 - 资源隔离
 
  | 文档 |
  | ------------------------------------------------------------ |
- |[Group & Zone](https://docs.nebula-graph.com.cn/{{nebula.release}}/7.data-security/5.zone/)|
--->
+ |[Zone](../4.deployment-and-installation/5.zone.md)|
+ {{ent.ent_end}}
 
 - SSL 加密
 

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
@@ -11,7 +11,7 @@
 {{comm.comm_begin}}
 
 ```ngql
-FIND { SHORTEST | SINGLE SHORTEST | ALL | NOLOOP } PATH [WITH PROP] FROM <vertex_id_list> TO <vertex_id_list>
+FIND { SHORTEST | ALL | NOLOOP } PATH [WITH PROP] FROM <vertex_id_list> TO <vertex_id_list>
 OVER <edge_type_list> [REVERSELY | BIDIRECT] 
 [<WHERE clause>] [UPTO <N> {STEP|STEPS}] 
 YIELD path as <alias>
@@ -23,8 +23,6 @@ YIELD path as <alias>
 
 - `SHORTEST`：查找所有最短路径。
 
-- `SINGLE SHORTEST`：查找所有最短路径，随机返回其中一条。
-
 - `ALL`：查找所有路径。
 
 - `NOLOOP`：查找非循环路径。

diff --git a/docs-2.0/3.ngql-guide/4.job-statements.md b/docs-2.0/3.ngql-guide/4.job-statements.md
@@ -65,37 +65,38 @@ nebula> SUBMIT JOB BALANCE LEADER;
 +------------+
 ```
 
-<!-- balance-3.1
-## SUBMIT JOB BALANCE IN ZONE
+{{ent.ent_begin}}
+## SUBMIT JOB BALANCE IN ZONE [REMOVE]
 
-`SUBMIT JOB BALANCE IN ZONE`语句会在当前图空间内每个 Zone 内部启动任务均衡分布分片。该命令会返回任务 ID。可以使用`REMOVE`选项指定需要清空的 Storage 节点，方便进行维护。
+`SUBMIT JOB BALANCE IN ZONE`语句会启动一个任务在当前图空间中的所有 Zone 内部均衡分布分片副本。该命令会返回任务 ID。
+
+`SUBMIT JOB BALANCE IN ZONE REMOVE`语句会启动一个任务清空当前图空间的 Zone 内指定的 Storage 节点。清空 Storage 节点前，需要确保 Zone 内剩余 Storage 节点数量可以满足设置的副本数。例如，如果设置了副本数为 3，那么在执行该命令前，需要确保剩余 Storage 节点数量大于等于 3。
 
 示例：
 
 ```ngql
-nebula> SUBMIT JOB BALANCE IN ZONE REMOVE 192.168.10.102:9779;
+# 在当前图空间指定的 Zone 内均衡分布分片副本
+nebula> SUBMIT JOB BALANCE IN ZONE;
 +------------+
 | New Job Id |
 +------------+
-| 26 |
+| 25 |
 +------------+
 ```
 
-## SUBMIT JOB BALANCE ACROSS ZONE
-
-`SUBMIT JOB BALANCE ACROSS ZONE`语句会在当前图空间内所有 Zone 之间启动任务均衡分布分片，保证各个 Zone 分片数量平衡。该命令会返回任务 ID。可以使用`REMOVE`选项指定需要清空的 Zone，方便进行维护。
-
-示例：
-
 ```ngql
-nebula> SUBMIT JOB BALANCE ACROSS ZONE REMOVE "zone1";
+# 清空 Storage 节点
+nebula> SUBMIT JOB BALANCE IN ZONE REMOVE 192.168.10.102:9779;
 +------------+
 | New Job Id |
 +------------+
-| 27 |
+| 26 |
 +------------+
 ```
--->
+
+关于 Zone 的详情，请参见[管理 Zone](../4.deployment-and-installation/5.zone.md)。
+
+{{ent.ent_end}}
 
 ## SUBMIT JOB COMPACT
 

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
@@ -10,6 +10,8 @@
 
 ### 创建图空间
 
+{{comm.comm_begin}}
+
 ```ngql
 CREATE SPACE [IF NOT EXISTS] <graph_space_name> (
  [partition_num = <partition_number>,]
@@ -23,14 +25,37 @@ CREATE SPACE [IF NOT EXISTS] <graph_space_name> (
 |:---|:---|
 |`IF NOT EXISTS`|检测待创建的图空间是否存在，只有不存在时，才会创建图空间。仅检测图空间的名称，不会检测具体属性。|
 |`<graph_space_name>`|1、在{{nebula.name}}实例中唯一标识一个图空间。<br/>2、图空间名称设置后无法被修改。<br/>3、不能以数字开头；支持 1~4 字节的 UTF-8 编码字符，包括英文字母（区分大小写）、数字、中文等，但是不包括除下划线外的特殊字符；使用特殊字符、保留关键字或数字开头时，需要用反引号（\`）包围且不能使用英文句号（`.`）。详情参见[关键字和保留字](../../3.ngql-guide/1.nGQL-overview/keywords-and-reserved-words.md)。<br/>**注意**：如果以中文为图空间命名，报`SyntaxError`错误时，需使用反引号（\`）包围中文字符。|
-|`partition_num`|指定图空间的分片数量。建议设置为集群中硬盘数量的 20 倍（HDD 硬盘建议为 2 倍）。例如集群中有 3 个硬盘，建议设置 60 个分片。默认值为 100。|
+|`partition_num`|指定图空间的分片数量。建议设置为集群中硬盘数量的 20 倍（HDD 硬盘建议为 2 倍）。例如集群中有 3 个硬盘，建议设置 60 个分片。默认值为 10。|
+|`replica_factor`|指定每个分片的副本数量。建议在生产环境中设置为 3，在测试环境中设置为 1。由于需要基于多数表决，副本数量必须是**奇数**。默认值为 1。|
+|`vid_type`|必选参数。指定点 ID 的数据类型。可选值为`FIXED_STRING(<N>)`和`INT64`。`INT`等同于`INT64`。<br>`FIXED_STRING(<N>)`表示数据类型为定长字符串，长度为`N`字节，超出长度会报错。例如，UTF-8中，一个中文字符的长度为三个字节，如果设置`N`为 12，那么`vid_type`为最多 4 个中文字符。<br>`INT64`表示数据类型为整数。|
+|`COMMENT`|图空间的描述。最大为 256 字节。默认无描述。|
+
+{{comm.comm_end}}
+
+{{ent.ent_begin}}
+
+```ngql
+CREATE SPACE [IF NOT EXISTS] <graph_space_name> (
+ [partition_num = <partition_number>,]
+ [replica_factor = <replica_number>,]
+ vid_type = {FIXED_STRING(<N>) | INT[64]}
+ )
+ [COMMENT = '<comment>']
+ [ON <zone_list>'];
+```
+
+|参数|说明|
+|:---|:---|
+|`IF NOT EXISTS`|检测待创建的图空间是否存在，只有不存在时，才会创建图空间。仅检测图空间的名称，不会检测具体属性。|
+|`<graph_space_name>`|1、在{{nebula.name}}实例中唯一标识一个图空间。<br/>2、图空间名称设置后无法被修改。<br/>3、不能以数字开头；支持 1~4 字节的 UTF-8 编码字符，包括英文字母（区分大小写）、数字、中文等，但是不包括除下划线外的特殊字符；使用特殊字符、保留关键字或数字开头时，需要用反引号（\`）包围且不能使用英文句号（`.`）。详情参见[关键字和保留字](../../3.ngql-guide/1.nGQL-overview/keywords-and-reserved-words.md)。<br/>**注意**：如果以中文为图空间命名，报`SyntaxError`错误时，需使用反引号（\`）包围中文字符。|
+|`partition_num`|指定图空间的分片数量。建议设置为集群中硬盘数量的 20 倍（HDD 硬盘建议为 2 倍）。例如集群中有 3 个硬盘，建议设置 60 个分片。默认值为 10。|
 |`replica_factor`|指定每个分片的副本数量。建议在生产环境中设置为 3，在测试环境中设置为 1。由于需要基于多数表决，副本数量必须是**奇数**。默认值为 1。|
 |`vid_type`|必选参数。指定点 ID 的数据类型。可选值为`FIXED_STRING(<N>)`和`INT64`。`INT`等同于`INT64`。<br>`FIXED_STRING(<N>)`表示数据类型为定长字符串，长度为`N`字节，超出长度会报错。例如，UTF-8中，一个中文字符的长度为三个字节，如果设置`N`为 12，那么`vid_type`为最多 4 个中文字符。<br>`INT64`表示数据类型为整数。|
 |`COMMENT`|图空间的描述。最大为 256 字节。默认无描述。|
+|`zone_list`|指定图空间所属的 Zone 列表，分片副本将分布在这些 Zone 中。副本数量不能超过指定 Zone 数量。不指定`zone_list`时，分片副本默认分布在所有 Zone 中。详情请参见 [管理 Zone](../../4.deployment-and-installation/5.zone.md)。|
+
+{{ent.ent_end}}
 
-<!--
-|`zone_list`|指定图空间所属的 Zone 列表，将在这些 Zone 中创建分片和对应副本。副本数量不能超过指定 Zone 数量。不指定`zone_list`时，默认属于所有 Zone。详情请参见 [管理逻辑机架（Zone）](../../4.deployment-and-installation/5.zone.md)。|
--->
 
 !!! caution
 
@@ -105,9 +130,9 @@ nebula> SHOW HOSTS;
 +-------------+------+----------+--------------+--------------------------------+--------------------------------+---------+
 | Host | Port | Status | Leader count | Leader distribution | Partition distribution | Version |
 +-------------+------+----------+--------------+--------------------------------+--------------------------------+---------+
-| "storaged0" | 9779 | "ONLINE" | 8 | "basketballplayer:3, test:5" | "basketballplayer:10, test:10" | "3.1.0" |
-| "storaged1" | 9779  | "ONLINE" | 9 | "basketballplayer:4, test:5" | "basketballplayer:10, test:10" | "3.1.0" |
-| "storaged2" | 9779 | "ONLINE" | 3 | "basketballplayer:3" | "basketballplayer:10, test:10" | "3.1.0" |
+| "storaged0" | 9779 | "ONLINE" | 8 | "basketballplayer:3, test:5" | "basketballplayer:10, test:10" | "{{nebula.release}}" |
+| "storaged1" | 9779 | "ONLINE" | 9 | "basketballplayer:4, test:5" | "basketballplayer:10, test:10" | "{{nebula.release}}" |
+| "storaged2" | 9779 | "ONLINE" | 3 | "basketballplayer:3" | "basketballplayer:10, test:10" | "{{nebula.release}}" |
 +-------------+------+----------+--------------+--------------------------------+--------------------------------+---------+
 ```
 

diff --git a/docs-2.0/3.ngql-guide/9.space-statements/4.describe-space.md b/docs-2.0/3.ngql-guide/9.space-statements/4.describe-space.md
@@ -12,6 +12,7 @@ DESC[RIBE] SPACE <graph_space_name>;
 
 ## 示例
 
+
 ```ngql
 nebula> DESCRIBE SPACE basketballplayer;
 +----+--------------------+------------------+----------------+---------+------------+--------------------+---------+
@@ -21,7 +22,9 @@ nebula> DESCRIBE SPACE basketballplayer;
 +----+--------------------+------------------+----------------+---------+------------+--------------------+---------+
 ```
 
-<!--
+{{ent.ent_begin}}
+如果创建的图空间指定了 Zone，那么`DESCRIBE SPACE`语句会显示图空间的 Zone 信息。详情参见[管理 Zone](../../4.deployment-and-installation/5.zone.md)。
+
 ```ngql
 nebula> DESCRIBE SPACE basketballplayer;
 +----+--------------------+------------------+----------------+---------+------------+--------------------+-------------+-----------+---------+
@@ -30,4 +33,4 @@ nebula> DESCRIBE SPACE basketballplayer;
 | 1 | "basketballplayer" | 10 | 1 | "utf8" | "utf8_bin" | "FIXED_STRING(32)" | false | "default" | |
 +----+--------------------+------------------+----------------+---------+------------+--------------------+-------------+-----------+---------+
 ```
--->
+{{ent.ent_end}}