From 33ddade6b0c6badd52d6061aab9ea59be0191392 Mon Sep 17 00:00:00 2001 From: Amber1990Zhang <1345783682@qq.com> Date: Tue, 12 May 2020 16:38:44 +0800 Subject: [PATCH 1/4] on-call --- .../1.overview/1.concepts/1.data-model.md | 2 +- .../1.overview/2.quick-start/2.FAQ.md | 2 +- .../1.data-types/data-types.md | 12 +++++----- .../built-in-functions.md | 4 ++-- .../comparison-functions-and-operators.md | 10 ++++---- .../group-by-function.md | 2 +- .../operator-precedence.md | 2 +- .../create-space-syntax.md | 2 +- .../drop-space-syntax.md | 2 +- .../show-statements/show-configs-syntax.md | 24 +++++++++++-------- .../show-create-space-syntax.md | 2 +- .../show-statements/show-indexes-syntax.md | 15 ++++++++++++ .../show-statements/show-parts-syntax.md | 4 ++-- .../show-statements/show-roles-syntax.md | 15 +++++++++++- .../show-statements/show-snapshots-syntax.md | 17 +++++++++++++ .../show-statements/show-spaces-syntax.md | 13 ++++++++++ 16 files changed, 95 insertions(+), 33 deletions(-) diff --git a/docs/manual-CN/1.overview/1.concepts/1.data-model.md b/docs/manual-CN/1.overview/1.concepts/1.data-model.md index 46d3c4cb59c..504f8486a8b 100644 --- a/docs/manual-CN/1.overview/1.concepts/1.data-model.md +++ b/docs/manual-CN/1.overview/1.concepts/1.data-model.md @@ -42,7 +42,7 @@ G = < V, E, PV, PE >, ## 属性 -属性为点和边内部的键值对。本例中，节点 **player** 拥有属性 `id`， `name` 和 `age`，边 _**like** 则拥有属性 `likeness`。 +属性为点和边内部的键值对。本例中，节点 **player** 拥有属性 `id`， `name` 和 `age`，边 **like** 则拥有属性 `likeness`。 ## Schema diff --git a/docs/manual-CN/1.overview/2.quick-start/2.FAQ.md b/docs/manual-CN/1.overview/2.quick-start/2.FAQ.md index 3c1e4f88f96..40f25f620e8 100644 --- a/docs/manual-CN/1.overview/2.quick-start/2.FAQ.md +++ b/docs/manual-CN/1.overview/2.quick-start/2.FAQ.md @@ -73,7 +73,7 @@ nebula> SHOW CONFIGS; ### 单机先后加入两个不同集群 -同一台主机先后用于单机测试和集群测试，storaged 服务无法正常启动（终端上显示的 storaged 服务的监听端口是红色的）。查看 storged 服务的日志(/usr/local/nebula/nebula-storaged.ERROR)，若发现 "wrong cluster" 的报错信息，则可能的出错原因是单机测试和集群测试时的 Nebula Graph 生成的 cluster id 不一致，需要删除 Nebula Graph 安装目录(/usr/local/nebula)下的 cluster.id 文件和 data 目录后，重启服务。 +同一台主机先后用于单机测试和集群测试，storaged 服务无法正常启动（终端上显示的 storaged 服务的监听端口是红色的）。查看 storaged 服务的日志(/usr/local/nebula/nebula-storaged.ERROR)，若发现 "wrong cluster" 的报错信息，则可能的出错原因是单机测试和集群测试时的 Nebula Graph 生成的 cluster id 不一致，需要删除 Nebula Graph 安装目录(/usr/local/nebula)下的 cluster.id 文件和 data 目录后，重启服务。 [[↑] 回到顶部](#常见问题) diff --git a/docs/manual-CN/2.query-language/1.data-types/data-types.md b/docs/manual-CN/2.query-language/1.data-types/data-types.md index fb5a893be69..cfe01ba6962 100644 --- a/docs/manual-CN/2.query-language/1.data-types/data-types.md +++ b/docs/manual-CN/2.query-language/1.data-types/data-types.md @@ -6,19 +6,19 @@ ### 整型 -整型的关键字为 `int`，为 64 位*有符号*整型，范围是 `[-9223372036854775808, 9223372036854775807]`，且在基于 int64 的计算中不存在溢出。整型常量支持多种格式： +整型的关键字为 `int`，为 64 位**有符号**整型，范围是 `[-9223372036854775808, 9223372036854775807]`。整型常量支持多种格式： 1. 十进制，例如 `123456` - 1. 十六进制，例如 `0xdeadbeaf` - 1. 八进制，例如 `01234567` + 2. 十六进制，例如 `0xdeadbeaf` + 3. 八进制，例如 `01234567` ### 双浮点型 -双精度浮点数的关键字为 `double`，且没有上限和下限。 --> +双精度浮点数的关键字为 `double`，且没有上限和下限。 ## 布尔型 @@ -39,7 +39,7 @@ - 调用函数 now() - 时间字符串，例如："2019-10-01 10:00:00" - 直接输入时间戳，即从 1970-01-01 00:00:00 开始的秒数 -- 做数据存储的时候，会先将时间转化为 **UTC 时间**，读取的时候会将存储的 **UTC 时间**转换为**本地时间**给用户 +- 做数据存储的时候，会先将时间转化为 **UTC 时间**，读取的时候 console 会将存储的 **UTC 时间**转换为**本地时间**给用户 - 底层存储数据类型为: **int64** ## 示例 diff --git a/docs/manual-CN/2.query-language/2.functions-and-operators/built-in-functions.md b/docs/manual-CN/2.query-language/2.functions-and-operators/built-in-functions.md index 391890ccce9..31e8e5f8a9d 100644 --- a/docs/manual-CN/2.query-language/2.functions-and-operators/built-in-functions.md +++ b/docs/manual-CN/2.query-language/2.functions-and-operators/built-in-functions.md @@ -12,10 +12,10 @@ double ceil(double x) | 返回大于参数的最小整数（向上取整）  | double round(double x) | 对参数取整，如果参数位于中间位置，则返回远离 0 的数字 | double sqrt(double x) | 返回参数的平方根 | double cbrt(double x) | 返回参数的立方根 | -double hypot(double x, double x) | 返回一个正三角形的斜边 | +double hypot(double x, double y) | 返回一个直角三角形的斜边 | double pow(double x, double y) | 返回 x 的 y 次幂 | double exp(double x) | 计算 e 的 x 次幂 | -double exp2(double x) | 返回 2 的指定次方 | +double exp2(double x) | 返回 2 的指定次幂 | double log(double x) | 返回参数的自然对数 | double log2(double x) | 返回底数为 2 的对数 | double log10(double x) | 返回底数为 10 的对数 | diff --git a/docs/manual-CN/2.query-language/2.functions-and-operators/comparison-functions-and-operators.md b/docs/manual-CN/2.query-language/2.functions-and-operators/comparison-functions-and-operators.md index 1ef54ab0d5a..f85cecadd48 100644 --- a/docs/manual-CN/2.query-language/2.functions-and-operators/comparison-functions-and-operators.md +++ b/docs/manual-CN/2.query-language/2.functions-and-operators/comparison-functions-and-operators.md @@ -65,11 +65,11 @@ nebula> YIELD 2 >= 2; ```ngql nebula> YIELD 2.0 < 1.9; -======================= -| (2.000000<1.900000) | -======================= -| false | ------------------------ +========================================= +| (2.000000000000000<1.900000000000000) | +========================================= +| false | +----------------------------------------- ``` * ≤ diff --git a/docs/manual-CN/2.query-language/2.functions-and-operators/group-by-function.md b/docs/manual-CN/2.query-language/2.functions-and-operators/group-by-function.md index f2568082da1..be111bfced7 100644 --- a/docs/manual-CN/2.query-language/2.functions-and-operators/group-by-function.md +++ b/docs/manual-CN/2.query-language/2.functions-and-operators/group-by-function.md @@ -1,4 +1,4 @@ -# 聚合函数 (Group By) +# 分组函数 (Group By) `GROUP BY` 函数类似于 SQL。 只能与 `YIELD` 语句一起使用。 diff --git a/docs/manual-CN/2.query-language/2.functions-and-operators/operator-precedence.md b/docs/manual-CN/2.query-language/2.functions-and-operators/operator-precedence.md index e40726aa488..dc45dce8088 100644 --- a/docs/manual-CN/2.query-language/2.functions-and-operators/operator-precedence.md +++ b/docs/manual-CN/2.query-language/2.functions-and-operators/operator-precedence.md @@ -3,8 +3,8 @@ 下面的列表展示了 nGQL 运算符的优先级（降序）。同一行的运算符拥有一致的优先级。 ```c +- (负数) ! -- (减法) *, /, % -, + == , >=, >, <=, <, <>, != diff --git a/docs/manual-CN/2.query-language/4.statement-syntax/1.data-definition-statements/create-space-syntax.md b/docs/manual-CN/2.query-language/4.statement-syntax/1.data-definition-statements/create-space-syntax.md index 7b29bc0d727..d46947e44a8 100644 --- a/docs/manual-CN/2.query-language/4.statement-syntax/1.data-definition-statements/create-space-syntax.md +++ b/docs/manual-CN/2.query-language/4.statement-syntax/1.data-definition-statements/create-space-syntax.md @@ -21,7 +21,7 @@ CREATE SPACE [IF NOT EXISTS] ## 自定义图空间选项 -在创建图空间的时候，可以传入如下两个自定义选项： +在创建图空间的时候，可以传入如下四个自定义选项： * _partition_num_ diff --git a/docs/manual-CN/2.query-language/4.statement-syntax/1.data-definition-statements/drop-space-syntax.md b/docs/manual-CN/2.query-language/4.statement-syntax/1.data-definition-statements/drop-space-syntax.md index d120c09be67..75653277a21 100644 --- a/docs/manual-CN/2.query-language/4.statement-syntax/1.data-definition-statements/drop-space-syntax.md +++ b/docs/manual-CN/2.query-language/4.statement-syntax/1.data-definition-statements/drop-space-syntax.md @@ -6,7 +6,7 @@ DROP SPACE [IF EXISTS] 仅支持有 DROP 权限的用户进行此操作。 -DROP SPACE 将删除指定 space 内的所有点和边。 +DROP SPACE 将删除指定 space 内的所有点和边及索引。 删除图空间可使用 `IF EXISTS` 关键字，这个关键字会自动检测对应的图空间是否存在，如果存在则删除，如果不存在则直接返回。 diff --git a/docs/manual-CN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-configs-syntax.md b/docs/manual-CN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-configs-syntax.md index 15a233abcf5..e73ce343c61 100644 --- a/docs/manual-CN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-configs-syntax.md +++ b/docs/manual-CN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-configs-syntax.md @@ -9,16 +9,20 @@ SHOW CONFIGS [graph|meta|storage] 例如： ```ngql -nebula> SHOW CONFIGS meta; -============================================================================================================================ -| module | name | type | mode | value | -============================================================================================================================ -| META | v | INT64 | IMMUTABLE | 4 | ----------------------------------------------------------------------------------------------------------------------------- -| META | help | BOOL | IMMUTABLE | False | ----------------------------------------------------------------------------------------------------------------------------- -| META | port | INT64 | IMMUTABLE | 45500 | ----------------------------------------------------------------------------------------------------------------------------- +nebula> SHOW CONFIGS graph; +============================================================== +| module | name | type | mode | value | +============================================================== +| GRAPH | v | INT64 | MUTABLE | 0 | +-------------------------------------------------------------- +| GRAPH | minloglevel | INT64 | MUTABLE | 2 | +-------------------------------------------------------------- +| GRAPH | slow_op_threshhold_ms | INT64 | MUTABLE | 50 | +-------------------------------------------------------------- +| GRAPH | heartbeat_interval_secs | INT64 | MUTABLE | 3 | +-------------------------------------------------------------- +| GRAPH | meta_client_retry_times | INT64 | MUTABLE | 3 | +-------------------------------------------------------------- ``` 更多关于 `SHOW CONFIGS [graph|meta|storage]` 的信息，参见 [configs syntax](../../../../3.build-develop-and-administration/3.configurations/2.configs-syntax.md)。 diff --git a/docs/manual-CN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-create-space-syntax.md b/docs/manual-CN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-create-space-syntax.md index 1e0253605c4..ca58bc2a8b0 100644 --- a/docs/manual-CN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-create-space-syntax.md +++ b/docs/manual-CN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-create-space-syntax.md @@ -11,6 +11,6 @@ nebula> SHOW CREATE SPACE NBA; ========================================================================================================= | Space | Create Space | ========================================================================================================= -| gods | CREATE SPACE gods (partition_num = 1, replica_factor = 1, charset = utf8, collate = utf8_bin) | +| NBA | CREATE SPACE gods (partition_num = 1, replica_factor = 1, charset = utf8, collate = utf8_bin) | --------------------------------------------------------------------------------------------------------- ``` diff --git a/docs/manual-CN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-indexes-syntax.md b/docs/manual-CN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-indexes-syntax.md index 2aa7f0c21a3..83dda0e970e 100644 --- a/docs/manual-CN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-indexes-syntax.md +++ b/docs/manual-CN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-indexes-syntax.md @@ -5,3 +5,18 @@ SHOW {TAG | EDGE} INDEXES ``` `SHOW INDEXES` 用于列出已创建完成的标签或边类型的索引信息。`SHOW INDEXES` 返回以下字段：索引 ID 和 索引名称。 + +例如： + +```ngql +nebula> SHOW TAG INDEXES; +============================= +| Index ID | Index Name | +============================= +| 6 | player_index_1 | +----------------------------- +| 7 | player_index_0 | +----------------------------- +``` + +如何创建索引请参考 [索引](../../1.data-definition-statements/index.md) 文档。 diff --git a/docs/manual-CN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-parts-syntax.md b/docs/manual-CN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-parts-syntax.md index acd29abf695..aa5e999b553 100644 --- a/docs/manual-CN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-parts-syntax.md +++ b/docs/manual-CN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-parts-syntax.md @@ -4,7 +4,7 @@ SHOW PARTS ``` -`SHOW PARTS` 列出指定 partition 的信息。 +`SHOW PARTS` 列出指定 partition 的信息。`` 为可选，如果不指定则返回所有 part 信息。 ```ngql nebula> SHOW PARTS 1; @@ -20,4 +20,4 @@ nebula> SHOW PARTS 1; - Partition ID - Leader - Peers -- Losts \ No newline at end of file +- Losts diff --git a/docs/manual-CN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-roles-syntax.md b/docs/manual-CN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-roles-syntax.md index 1cb002709e4..88c7a7f4fe6 100644 --- a/docs/manual-CN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-roles-syntax.md +++ b/docs/manual-CN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-roles-syntax.md @@ -1,7 +1,20 @@ # SHOW ROLES 语法 ```ngql -SHOW ROLES IN > +SHOW ROLES IN ``` `SHOW ROLES` 语句显示分配给用户账户的角色。`SHOW ROLES` 输出以下列：用户账户和角色类型。 + +例如： + +```ngql +nebula> SHOW ROLES in NBA; +======================= +| Account | Role Type | +======================= +| userA | ADMIN | +----------------------- +``` + +参考 [Create User](../../../../3.build-develop-and-administration/4.account-management-statements/create-user-syntax.md) 创建用户，参考 [Grant Role](../../../../3.build-develop-and-administration/4.account-management-statements/grant-role-syntax.md) 为用户授予角色。 diff --git a/docs/manual-CN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-snapshots-syntax.md b/docs/manual-CN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-snapshots-syntax.md index 73e3bdd94b2..50a3fb83212 100644 --- a/docs/manual-CN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-snapshots-syntax.md +++ b/docs/manual-CN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-snapshots-syntax.md @@ -5,3 +5,20 @@ SHOW SNAPSHOTS ``` `SHOW SNAPSHOTS` 语句返回所有快照。 + +例如： + +```ngql +nebula> SHOW SNAPSHOTS; +=========================================================== +| Name | Status | Hosts | +=========================================================== +| SNAPSHOT_2019_12_04_10_54_36 | VALID | 127.0.0.1:77833 | +----------------------------------------------------------- +| SNAPSHOT_2019_12_04_10_54_42 | VALID | 127.0.0.1:77833 | +----------------------------------------------------------- +| SNAPSHOT_2019_12_04_10_54_44 | VALID | 127.0.0.1:77833 | +----------------------------------------------------------- +``` + +参考 [这里](../../../../3.build-develop-and-administration/5.storage-service-administration/cluster-snapshot.md) 创建集群快照。 diff --git a/docs/manual-CN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-spaces-syntax.md b/docs/manual-CN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-spaces-syntax.md index ed38738627b..7d36bec5539 100644 --- a/docs/manual-CN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-spaces-syntax.md +++ b/docs/manual-CN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-spaces-syntax.md @@ -5,3 +5,16 @@ SHOW SPACES ``` `SHOW SPACES` 列出 **Nebula Graph** 集群中的所有图空间。 + +例如： + +```ngql +nebula> SHOW SPACES; +======== +| Name | +======== +| NBA | +-------- +``` + +参考[这里](../../1.data-definition-statements/create-space-syntax.md)创建图空间。 From 4132ceb56bd0a46f748da679cfbf945036015752 Mon Sep 17 00:00:00 2001 From: Amber1990Zhang <1345783682@qq.com> Date: Tue, 12 May 2020 16:59:21 +0800 Subject: [PATCH 2/4] group-by --- .../2.functions-and-operators/group-by-function.md | 4 ++-- mkdocs.yml | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/manual-CN/2.query-language/2.functions-and-operators/group-by-function.md b/docs/manual-CN/2.query-language/2.functions-and-operators/group-by-function.md index be111bfced7..e114fd22a3d 100644 --- a/docs/manual-CN/2.query-language/2.functions-and-operators/group-by-function.md +++ b/docs/manual-CN/2.query-language/2.functions-and-operators/group-by-function.md @@ -1,6 +1,6 @@ -# 分组函数 (Group By) +# 分组 (Group By) - `GROUP BY` 函数类似于 SQL。 只能与 `YIELD` 语句一起使用。 + `GROUP BY` 类似于 SQL。 只能与 `YIELD` 语句一起使用。 |名称 | 描述 | |:----|:----:| diff --git a/mkdocs.yml b/mkdocs.yml index 66d9aaf9e71..7f61319b564 100755 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -75,7 +75,7 @@ nav: - 位运算: manual-CN/2.query-language/2.functions-and-operators/bitwise-operators.md - 内置函数: manual-CN/2.query-language/2.functions-and-operators/built-in-functions.md - 比较运算: manual-CN/2.query-language/2.functions-and-operators/comparison-functions-and-operators.md - - 聚合运算 GROUP BY: manual-CN/2.query-language/2.functions-and-operators/group-by-function.md + - 分组 GROUP BY: manual-CN/2.query-language/2.functions-and-operators/group-by-function.md - LIMIT 语法: manual-CN/2.query-language/2.functions-and-operators/limit-syntax.md - 逻辑运算: manual-CN/2.query-language/2.functions-and-operators/logical-operators.md - 运算符优先级: manual-CN/2.query-language/2.functions-and-operators/operator-precedence.md From d3312a69f3dfbaed2fe0d9ccbdc6b04d11785dd2 Mon Sep 17 00:00:00 2001 From: Amber1990Zhang <1345783682@qq.com> Date: Wed, 13 May 2020 10:10:09 +0800 Subject: [PATCH 3/4] comment & show roles --- .../2.query-language/3.language-structure/comment-syntax.md | 2 +- .../3.utility-statements/show-statements/show-roles-syntax.md | 3 +++ 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/docs/manual-CN/2.query-language/3.language-structure/comment-syntax.md b/docs/manual-CN/2.query-language/3.language-structure/comment-syntax.md index 65ca76dd2f2..1c27745ab60 100644 --- a/docs/manual-CN/2.query-language/3.language-structure/comment-syntax.md +++ b/docs/manual-CN/2.query-language/3.language-structure/comment-syntax.md @@ -3,7 +3,7 @@ **Nebula Graph** 支持四种注释方式： * 在行末加 # -* 在行末加 -- +* 在行末加 --，使用 '--' 作注释时，需在其后加空格，即 '-- '。 * 在行末加 //，与 C 语言类似 * 添加 `/* */` 符号，其开始和结束序列无需在同一行，因此此类注释方式支持换行。 diff --git a/docs/manual-CN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-roles-syntax.md b/docs/manual-CN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-roles-syntax.md index 88c7a7f4fe6..c6bf922ed2c 100644 --- a/docs/manual-CN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-roles-syntax.md +++ b/docs/manual-CN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-roles-syntax.md @@ -6,6 +6,9 @@ SHOW ROLES IN `SHOW ROLES` 语句显示分配给用户账户的角色。`SHOW ROLES` 输出以下列：用户账户和角色类型。 +如果是 `GOD` 或 `ADMIN` 类型的用户, **Nebula Graph** 返回其权限内的所有用户角色。 +如果是 `DBA`、 `USER` 或 `GUEST` 类型的用户, **Nebula Graph** 仅返回其自身角色。 + 例如： ```ngql From 757b7ebc3158b97916b40bb67ad0068a81c65d62 Mon Sep 17 00:00:00 2001 From: Amber1990Zhang <1345783682@qq.com> Date: Wed, 13 May 2020 10:31:32 +0800 Subject: [PATCH 4/4] drop space --- .../1.data-definition-statements/drop-space-syntax.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/manual-CN/2.query-language/4.statement-syntax/1.data-definition-statements/drop-space-syntax.md b/docs/manual-CN/2.query-language/4.statement-syntax/1.data-definition-statements/drop-space-syntax.md index 75653277a21..d605a468227 100644 --- a/docs/manual-CN/2.query-language/4.statement-syntax/1.data-definition-statements/drop-space-syntax.md +++ b/docs/manual-CN/2.query-language/4.statement-syntax/1.data-definition-statements/drop-space-syntax.md @@ -6,7 +6,7 @@ DROP SPACE [IF EXISTS] 仅支持有 DROP 权限的用户进行此操作。 -DROP SPACE 将删除指定 space 内的所有点和边及索引。 +DROP SPACE 将删除指定 space 内的所有内容。 删除图空间可使用 `IF EXISTS` 关键字，这个关键字会自动检测对应的图空间是否存在，如果存在则删除，如果不存在则直接返回。