From 7a8453c4e789741d94ad6ad7c2c14309fb83e63b Mon Sep 17 00:00:00 2001 From: Amber1990Zhang <42762957+Amber1990Zhang@users.noreply.github.com> Date: Mon, 16 Mar 2020 14:48:43 +0800 Subject: [PATCH 1/2] show statements --- .../show-statements/show-charset-syntax.md | 27 +++++ .../show-statements/show-collation-syntax.md | 23 ++++ .../show-statements/show-configs-syntax.md | 9 ++ .../show-create-space-syntax.md | 7 ++ .../show-create-tag-edge-syntax.md | 7 ++ .../show-statements/show-hosts-syntax.md | 22 ++++ .../show-statements/show-indexes-syntax.md | 8 ++ .../show-statements/show-parts-syntax.md | 23 ++++ .../show-statements/show-roles-syntax.md | 7 ++ .../show-statements/show-snapshots-syntax.md | 7 ++ .../show-statements/show-spaces-syntax.md | 7 ++ .../show-statements/show-tags-edges-syntax.md | 7 ++ .../show-statements/show-users-syntax.md | 7 ++ .../3.utility-statements/show-syntax.md | 103 ----------------- docs/manual-CN/README.md | 15 ++- .../show-statements/show-charset-syntax.md | 27 +++++ .../show-statements/show-collation-syntax.md | 23 ++++ .../show-statements/show-configs-syntax.md | 9 ++ .../show-create-space-syntax.md | 7 ++ .../show-create-tag-edge-syntax.md | 7 ++ .../show-statements/show-hosts-syntax.md | 22 ++++ .../show-statements/show-indexes-syntax.md | 7 ++ .../show-statements/show-parts-syntax.md | 23 ++++ .../show-statements/show-roles-syntax.md | 7 ++ .../show-statements/show-snapshots-syntax.md | 7 ++ .../show-statements/show-spaces-syntax.md | 7 ++ .../show-statements/show-tags-edges-syntax.md | 7 ++ .../show-statements/show-users-syntax.md | 7 ++ .../3.utility-statements/show-syntax.md | 104 ------------------ docs/manual-EN/README.md | 16 ++- 30 files changed, 350 insertions(+), 209 deletions(-) create mode 100644 docs/manual-CN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-charset-syntax.md create mode 100644 docs/manual-CN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-collation-syntax.md create mode 100644 docs/manual-CN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-configs-syntax.md create mode 100644 docs/manual-CN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-create-space-syntax.md create mode 100644 docs/manual-CN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-create-tag-edge-syntax.md create mode 100644 docs/manual-CN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-hosts-syntax.md create mode 100644 docs/manual-CN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-indexes-syntax.md create mode 100644 docs/manual-CN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-parts-syntax.md create mode 100644 docs/manual-CN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-roles-syntax.md create mode 100644 docs/manual-CN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-snapshots-syntax.md create mode 100644 docs/manual-CN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-spaces-syntax.md create mode 100644 docs/manual-CN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-tags-edges-syntax.md create mode 100644 docs/manual-CN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-users-syntax.md delete mode 100644 docs/manual-CN/2.query-language/4.statement-syntax/3.utility-statements/show-syntax.md create mode 100644 docs/manual-EN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-charset-syntax.md create mode 100644 docs/manual-EN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-collation-syntax.md create mode 100644 docs/manual-EN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-configs-syntax.md create mode 100644 docs/manual-EN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-create-space-syntax.md create mode 100644 docs/manual-EN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-create-tag-edge-syntax.md create mode 100644 docs/manual-EN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-hosts-syntax.md create mode 100644 docs/manual-EN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-indexes-syntax.md create mode 100644 docs/manual-EN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-parts-syntax.md create mode 100644 docs/manual-EN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-roles-syntax.md create mode 100644 docs/manual-EN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-snapshots-syntax.md create mode 100644 docs/manual-EN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-spaces-syntax.md create mode 100644 docs/manual-EN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-tags-edges-syntax.md create mode 100644 docs/manual-EN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-users-syntax.md delete mode 100644 docs/manual-EN/2.query-language/4.statement-syntax/3.utility-statements/show-syntax.md diff --git a/docs/manual-CN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-charset-syntax.md b/docs/manual-CN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-charset-syntax.md new file mode 100644 index 00000000000..479e052e425 --- /dev/null +++ b/docs/manual-CN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-charset-syntax.md @@ -0,0 +1,27 @@ +# SHOW CHARSET 语法 + +```ngql +SHOW CHARSET +``` + +`SHOW CHARSET` 返回所有可用的字符集。目前支持两种类型：utf8、utf8mb4。其中默认字符集为 utf8。**Nebula Graph** 将 utf8 进行了扩展，utf8 同时支持 4 个字节的字符，因此，utf8 和 utf8mb4 是等价的。 + +```ngql +nebula> SHOW CHARSET; +======================================================== +| Charset | Description | Default collation | Maxlen | +======================================================== +| utf8 | UTF-8 Unicode | utf8_bin | 4 | +-------------------------------------------------------- +``` + +`SHOW CHARSET` 输出以下列： + +- Charset + 字符集名称。 +- Description + 字符集的描述。 +- Default collation + 字符集的默认排序规则。 +- Maxlen + 存储一个字符所需的最大字节数。 diff --git a/docs/manual-CN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-collation-syntax.md b/docs/manual-CN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-collation-syntax.md new file mode 100644 index 00000000000..c70dfa104b3 --- /dev/null +++ b/docs/manual-CN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-collation-syntax.md @@ -0,0 +1,23 @@ +# SHOW COLLATION 语法 + +```ngql +SHOW COLLATION +``` + +`SHOW COLLATION` 语句列出服务器支持的排序规则。目前支持四种类型：utf8_bin、utf8_general_ci、utf8mb4_bin、utf8mb4_general_ci。字符集为 utf8 时，默认 collate 为 utf8_bin；字符集为 utf8mb4 时，默认 collate 为 utf8mb4_bin。utf8_general_ci 和 utf8mb4_general_ci 都是忽略大小写的比较，行为同 MySQL 一致。 + +```ngql +nebula> SHOW COLLATION; +======================= +| Collation | Charset | +======================= +| utf8_bin | utf8 | +----------------------- +``` + +`SHOW COLLATION` 输出有以下列： + +- Collation + 排序规则名称。 +- Charset + 与排序规则关联的字符集的名称。 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 new file mode 100644 index 00000000000..3372866b120 --- /dev/null +++ b/docs/manual-CN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-configs-syntax.md @@ -0,0 +1,9 @@ +# SHOW CONFIGS 语法 + +```ngql +SHOW CONFIGS [graph|meta|storage] +``` + +`SHOW CONFIGS` 语句显示参数信息。 `SHOW CONFIGS` 输出以下列：module（模块信息）、name（参数名称）、type（参数类型）、mode（参数模式）和 value（参数值）。 + +更多关于 `SHOW CONFIGS [graph|meta|storage]` 的信息，参见 [configs syntax](../../../3.build-develop-and-administration/3.deploy-and-administrations/server-administration/configuration-statements/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 new file mode 100644 index 00000000000..08f5f0554c1 --- /dev/null +++ b/docs/manual-CN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-create-space-syntax.md @@ -0,0 +1,7 @@ +# SHOW CREATE SPACE 语法 + +```ngql +SHOW CREATE SPACE +``` + +`SHOW CREATE SPACE` 返回指定 space 及其创建语法。如果 space 包含默认值，则同时返回默认值。 diff --git a/docs/manual-CN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-create-tag-edge-syntax.md b/docs/manual-CN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-create-tag-edge-syntax.md new file mode 100644 index 00000000000..88887be1db2 --- /dev/null +++ b/docs/manual-CN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-create-tag-edge-syntax.md @@ -0,0 +1,7 @@ +# SHOW CREATE TAGS/EDGES 语法 + +```ngql +SHOW CREATE {TAG | EDGE } +``` + +`SHOW CREATE TAG` 和 `SHOW CREATE EDGE` 返回当前图空间中指定的 tag、edge type 及其创建语法。如果 tag 或 edge type 包含默认值，则同时返回默认值。 diff --git a/docs/manual-CN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-hosts-syntax.md b/docs/manual-CN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-hosts-syntax.md new file mode 100644 index 00000000000..a8da30f8e00 --- /dev/null +++ b/docs/manual-CN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-hosts-syntax.md @@ -0,0 +1,22 @@ +# SHOW HOSTS 语法 + +```ngql +SHOW HOSTS +``` + +`SHOW HOSTS` 列出元服务器注册的所有存储主机。`SHOW HOSTS` 输出以下列：IP 地址、端口号、状态（online/offline）、leader 数量、leader 分布、partition 分布。 + +```ngql +nebula> SHOW HOSTS; +============================================================================================= +| Ip | Port | Status | Leader count | Leader distribution | Partition distribution | +============================================================================================= +| 172.28.2.1 | 44500 | online | 0 | No valid partition | No valid partition | +--------------------------------------------------------------------------------------------- +| 172.28.2.2 | 44500 | online | 2 | NBA: 1, gods: 1 | NBA: 1, gods: 1 | +--------------------------------------------------------------------------------------------- +| 172.28.2.3 | 44500 | online | 0 | No valid partition | No valid partition | +--------------------------------------------------------------------------------------------- +| Total | | | 2 | gods: 1, NBA: 1 | gods: 1, NBA: 1 | +--------------------------------------------------------------------------------------------- +``` 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 new file mode 100644 index 00000000000..25c2a31276d --- /dev/null +++ b/docs/manual-CN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-indexes-syntax.md @@ -0,0 +1,8 @@ +# SHOW INDEXES 语法 + +```ngql +SHOW {TAG | EDGE} INDEXES +``` + +`SHOW INDEXES` 用于列出已创建完成的标签或边类型的索引信息。`SHOW INDEXES` 返回以下字段：索引 ID 和 索引名称。 + 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 new file mode 100644 index 00000000000..acd29abf695 --- /dev/null +++ b/docs/manual-CN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-parts-syntax.md @@ -0,0 +1,23 @@ +# SHOW PARTS 语法 + +```ngql +SHOW PARTS +``` + +`SHOW PARTS` 列出指定 partition 的信息。 + +```ngql +nebula> SHOW PARTS 1; +============================================================== +| Partition ID | Leader | Peers | Losts | +============================================================== +| 1 | 172.28.2.2:44500 | 172.28.2.2:44500 | | +-------------------------------------------------------------- +``` + +`SHOW PARTS` 输出以下列： + +- Partition ID +- Leader +- Peers +- Losts \ No newline at end of file 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 new file mode 100644 index 00000000000..1cb002709e4 --- /dev/null +++ b/docs/manual-CN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-roles-syntax.md @@ -0,0 +1,7 @@ +# SHOW ROLES 语法 + +```ngql +SHOW ROLES IN > +``` + +`SHOW ROLES` 语句显示分配给用户账户的角色。`SHOW ROLES` 输出以下列：用户账户和角色类型。 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 new file mode 100644 index 00000000000..73e3bdd94b2 --- /dev/null +++ b/docs/manual-CN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-snapshots-syntax.md @@ -0,0 +1,7 @@ +# SHOW SNAPSHOTS 语法 + +```ngql +SHOW SNAPSHOTS +``` + +`SHOW SNAPSHOTS` 语句返回所有快照。 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 new file mode 100644 index 00000000000..ed38738627b --- /dev/null +++ b/docs/manual-CN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-spaces-syntax.md @@ -0,0 +1,7 @@ +# SHOW SPACES 语法 + +```ngql +SHOW SPACES +``` + +`SHOW SPACES` 列出 **Nebula Graph** 集群中的所有图空间。 diff --git a/docs/manual-CN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-tags-edges-syntax.md b/docs/manual-CN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-tags-edges-syntax.md new file mode 100644 index 00000000000..d3050b72076 --- /dev/null +++ b/docs/manual-CN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-tags-edges-syntax.md @@ -0,0 +1,7 @@ +# SHOW TAGS/EDGES 语法 + +```ngql +SHOW {TAGS | EDGES} +``` + +`SHOW TAGS` 和 `SHOW EDGES` 则返回当前图空间中被定义的 tag 和 edge type。 diff --git a/docs/manual-CN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-users-syntax.md b/docs/manual-CN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-users-syntax.md new file mode 100644 index 00000000000..4261a2406ec --- /dev/null +++ b/docs/manual-CN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-users-syntax.md @@ -0,0 +1,7 @@ +# SHOW USERS 语法 + +```ngql +SHOW USERS +``` + +`SHOW USERS` 语句显示用户信息。 `SHOW USERS` 输出以下列：账户名。 diff --git a/docs/manual-CN/2.query-language/4.statement-syntax/3.utility-statements/show-syntax.md b/docs/manual-CN/2.query-language/4.statement-syntax/3.utility-statements/show-syntax.md deleted file mode 100644 index 2561a2f62ba..00000000000 --- a/docs/manual-CN/2.query-language/4.statement-syntax/3.utility-statements/show-syntax.md +++ /dev/null @@ -1,103 +0,0 @@ -# SHOW 语法 - -```ngql -SHOW {SPACES | TAGS | EDGES | HOSTS | PARTS } -SHOW PARTS -SHOW CREATE { SPACE | TAG | EDGE} { | | } -SHOW {TAG | EDGE} INDEXES -SHOW CONFIGS [graph|meta|storage] -SHOW SNAPSHOTS -SHOW CHARSET -SHOW COLLATION -``` - -`SHOW SPACES` 列出 **Nebula Graph** 集群中的所有图空间。 - -`SHOW TAGS` 和 `SHOW EDGES` 则返回当前图空间中被定义的 tag 和 edge type。 - -`SHOW CREATE SPACE` 返回指定 space 及其创建语法。如果 space 包含默认值，则同时返回默认值。 -`SHOW CREATE TAG` 和 `SHOW CREATE EDGE` 返回当前图空间中指定的 tag、edge type 及其创建语法。如果 tag 或 edge type 包含默认值，则同时返回默认值。 - -`SHOW INDEXES` 用于列出已创建完成的标签或边类型的索引信息。 - -`SHOW HOSTS` 列出元服务器注册的所有存储主机。 - -`SHOW PARTS` 列出指定 SPACE 的 partition 信息。 - -`SHOW PARTS ` 列出指定 partition 的信息。 - -更多关于 `SHOW CONFIGS [graph|meta|storage]` 的信息，参见 [configs syntax](../../../3.build-develop-and-administration/3.deploy-and-administrations/server-administration/configuration-statements/configs-syntax.md)。 - -`SHOW SNAPSHOTS` 返回所有快照。 - -`SHOW CHARSET` 返回所有支持的字符集。 - -`SHOW COLLATION` 返回支持的排序规则。 - -## 示例 - -```ngql -nebula> SHOW HOSTS; -============================================================================================= -| Ip | Port | Status | Leader count | Leader distribution | Partition distribution | -============================================================================================= -| 172.28.2.1 | 44500 | online | 33 | nba: 3, test: 30 | test: 100, nba: 3 | ---------------------------------------------------------------------------------------------- -| 172.28.2.2 | 44500 | online | 48 | nba: 4, test: 44 | test: 100, nba: 4 | ---------------------------------------------------------------------------------------------- -| 172.28.2.3 | 44500 | online | 30 | nba: 3, test: 27 | test: 100, nba: 3 | ---------------------------------------------------------------------------------------------- -| Total | | | 111 | nba: 10, test: 101 | test: 300, nba: 10 | ---------------------------------------------------------------------------------------------- - -nebula> SHOW SPACES; -======== -| Name | -======== -| nba | --------- - -nebula> USE nba; -nebula> SHOW PARTS; -============================================================== -| Partition ID | Leader | Peers | Losts | -============================================================== -| 1 | 172.28.2.2:44500 | 172.28.2.2:44500 | | --------------------------------------------------------------- -| 2 | 172.28.2.3:44500 | 172.28.2.3:44500 | | --------------------------------------------------------------- -| 3 | 172.28.2.1:44500 | 172.28.2.1:44500 | | --------------------------------------------------------------- -| 4 | 172.28.2.2:44500 | 172.28.2.2:44500 | | --------------------------------------------------------------- -| 5 | 172.28.2.3:44500 | 172.28.2.3:44500 | | --------------------------------------------------------------- -| 6 | 172.28.2.1:44500 | 172.28.2.1:44500 | | --------------------------------------------------------------- -| 7 | 172.28.2.2:44500 | 172.28.2.2:44500 | | --------------------------------------------------------------- -| 8 | 172.28.2.3:44500 | 172.28.2.3:44500 | | --------------------------------------------------------------- -| 9 | 172.28.2.1:44500 | 172.28.2.1:44500 | | --------------------------------------------------------------- -| 10 | 172.28.2.2:44500 | 172.28.2.2:44500 | | --------------------------------------------------------------- - -nebula> SHOW TAGS; -=============== -| ID | Name | -=============== -| 2 | player | ---------------- -| 3 | team | ---------------- - -nebula> SHOW CREATE TAG team; -=========================================================================== -| Tag | Create Tag | -=========================================================================== -| team | CREATE TAG team ( - name string -) ttl_duration = 0, ttl_col = "" | ---------------------------------------------------------------------------- -``` diff --git a/docs/manual-CN/README.md b/docs/manual-CN/README.md index 96cce4e4f5e..481ed339cc8 100644 --- a/docs/manual-CN/README.md +++ b/docs/manual-CN/README.md @@ -81,9 +81,22 @@ * [返回结果语句 (Yield)](2.query-language/4.statement-syntax/2.data-query-and-manipulation-statements/yield-syntax.md) * 辅助功能语句 + * Show 语句 + * [Show Charset 语法](2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-charset-syntax.md) + * [Show Collation 语法](2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-collation-syntax.md) + * [Show Configs 语法](2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-configs-syntax.md) + * [Show Create Spaces 语法](2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-create-space-syntax.md) + * [Show Create Tag/Edge 语法](2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-create-tag-edge-syntax.md) + * [Show Hosts 语法](2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-hosts-syntax.md) + * [Show Indexes 语法](2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-indexes-syntax.md) + * [Show Parts 语法](2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-parts-syntax.md) + * [Show Roles 语法](2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-roles-syntax.md) + * [Show Snapshots 语法](2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-snapshots-syntax.md) + * [Show Spaces 语法](2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-spaces-syntax.md) + * [Show Tag/Edge 语法](2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-tags-edges-syntax.md) + * [Show Users 语法](2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-users-syntax.md) * [Describe](2.query-language/4.statement-syntax/3.utility-statements/describe-syntax.md) * [Use](2.query-language/4.statement-syntax/3.utility-statements/use-syntax.md) - * [Show](2.query-language/4.statement-syntax/3.utility-statements/show-syntax.md) * 图算法 * [查找路径](2.query-language/4.statement-syntax/4.graph-algorithms/find-path-syntax.md) diff --git a/docs/manual-EN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-charset-syntax.md b/docs/manual-EN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-charset-syntax.md new file mode 100644 index 00000000000..808a04bfc5e --- /dev/null +++ b/docs/manual-EN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-charset-syntax.md @@ -0,0 +1,27 @@ +# SHOW CHARSET Syntax + +```ngql +SHOW CHARSET +``` + +`SHOW CHARSET` displays the available character sets. Currently available types are: utf8 and utf8mb4. The default charset type is utf8. **Nebula Graph** extends the uft8 to support four byte characters. Therefore utf8 and utf8mb4 equivalent. + +```ngql +nebula> SHOW CHARSET; +======================================================== +| Charset | Description | Default collation | Maxlen | +======================================================== +| utf8 | UTF-8 Unicode | utf8_bin | 4 | +-------------------------------------------------------- +``` + +`SHOW CHARSET` output has these columns: + +- Charset + The character set name. +- Description + A description of the character set. +- Default collation + The default collation for the character set. +- Maxlen + The maximum number of bytes required to store one character. diff --git a/docs/manual-EN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-collation-syntax.md b/docs/manual-EN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-collation-syntax.md new file mode 100644 index 00000000000..b13806824f3 --- /dev/null +++ b/docs/manual-EN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-collation-syntax.md @@ -0,0 +1,23 @@ +# SHOW COLLATION Syntax + +```ngql +SHOW COLLATION +``` + +`SHOW COLLATION` displays the collations supported by the server. Currently available types are: utf8_bin, utf8_general_ci, utf8mb4_bin and utf8mb4_general_ci. When the character set is utf8, the default collate is utf8_bin; when the character set is utf8mb4, the default collate is utf8mb4_bin. Both utf8_general_ci and utf8mb4_general_ci are case-insensitive comparisons and behave the same as MySQL. + +```ngql +nebula> SHOW COLLATION; +======================= +| Collation | Charset | +======================= +| utf8_bin | utf8 | +----------------------- +``` + +`SHOW COLLATION` output has these columns: + +- Collation + The collation name. +- Charset + The name of the character set with which the collation is associated. diff --git a/docs/manual-EN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-configs-syntax.md b/docs/manual-EN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-configs-syntax.md new file mode 100644 index 00000000000..ed1aca57302 --- /dev/null +++ b/docs/manual-EN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-configs-syntax.md @@ -0,0 +1,9 @@ +# SHOW CONFIGS Syntax + +```ngql +SHOW CONFIGS [graph|meta|storage] +``` + +`SHOW CONFIGS` lists the configuration information. `SHOW CONFIGS` output has these columns: module, name, type, mode and value. + +For more information about `SHOW CONFIGS [graph|meta|storage]`, please refer to [configs syntax](../../../3.build-develop-and-administration/3.deploy-and-administrations/server-administration/configuration-statements/configs-syntax.md). diff --git a/docs/manual-EN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-create-space-syntax.md b/docs/manual-EN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-create-space-syntax.md new file mode 100644 index 00000000000..289dcff0abb --- /dev/null +++ b/docs/manual-EN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-create-space-syntax.md @@ -0,0 +1,7 @@ +# SHOW CREATE SPACE Syntax + +```ngql +SHOW CREATE SPACE +``` + +`SHOW CREATE SPACE` statement returns the specified graph space and its creation syntax. If the graph space contains a default value, the default value is also returned. diff --git a/docs/manual-EN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-create-tag-edge-syntax.md b/docs/manual-EN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-create-tag-edge-syntax.md new file mode 100644 index 00000000000..cdded10388a --- /dev/null +++ b/docs/manual-EN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-create-tag-edge-syntax.md @@ -0,0 +1,7 @@ +# SHOW CREATE TAGS/EDGES Syntax + +```ngql +SHOW CREATE {TAG | EDGE } +``` + +`SHOW CREATE TAG` and `SHOW CREATE EDGE` return the specified tag or edge type and their creation syntax in a given space. If the tag or edge type contains a default value, the default value is also returned. diff --git a/docs/manual-EN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-hosts-syntax.md b/docs/manual-EN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-hosts-syntax.md new file mode 100644 index 00000000000..b2ffc91e0c2 --- /dev/null +++ b/docs/manual-EN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-hosts-syntax.md @@ -0,0 +1,22 @@ +# SHOW HOSTS Syntax + +```ngql +SHOW HOSTS +``` + +`SHOW HOSTS` statement lists storage hosts registered by the meta server. `SHOW HOSTS` output has these columns:: ip, port, status (online/offline), leader count, leader distribution, partition distribution. + +```ngql +nebula> SHOW HOSTS; +============================================================================================= +| Ip | Port | Status | Leader count | Leader distribution | Partition distribution | +============================================================================================= +| 172.28.2.1 | 44500 | online | 0 | No valid partition | No valid partition | +--------------------------------------------------------------------------------------------- +| 172.28.2.2 | 44500 | online | 2 | NBA: 1, gods: 1 | NBA: 1, gods: 1 | +--------------------------------------------------------------------------------------------- +| 172.28.2.3 | 44500 | online | 0 | No valid partition | No valid partition | +--------------------------------------------------------------------------------------------- +| Total | | | 2 | gods: 1, NBA: 1 | gods: 1, NBA: 1 | +--------------------------------------------------------------------------------------------- +``` diff --git a/docs/manual-EN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-indexes-syntax.md b/docs/manual-EN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-indexes-syntax.md new file mode 100644 index 00000000000..b4de3824201 --- /dev/null +++ b/docs/manual-EN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-indexes-syntax.md @@ -0,0 +1,7 @@ +# SHOW INDEXES Syntax + +```ngql +SHOW {TAG | EDGE} INDEXES +``` + +`SHOW INDEXES` returns the defined tag/edg-type index information. `SHOW INDEXES` returns the following fields: index ID and index name. diff --git a/docs/manual-EN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-parts-syntax.md b/docs/manual-EN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-parts-syntax.md new file mode 100644 index 00000000000..a7c1556df10 --- /dev/null +++ b/docs/manual-EN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-parts-syntax.md @@ -0,0 +1,23 @@ +# SHOW PARTS Syntax + +```ngql +SHOW PARTS +``` + +`SHOW PARTS` lists the partition information of the given SPACE. + +```ngql +nebula> SHOW PARTS 1; +============================================================== +| Partition ID | Leader | Peers | Losts | +============================================================== +| 1 | 172.28.2.2:44500 | 172.28.2.2:44500 | | +-------------------------------------------------------------- +``` + +`SHOW PARTS` output has these columns: + +- Partition ID +- Leader +- Peers +- Losts diff --git a/docs/manual-EN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-roles-syntax.md b/docs/manual-EN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-roles-syntax.md new file mode 100644 index 00000000000..8e166e41bd3 --- /dev/null +++ b/docs/manual-EN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-roles-syntax.md @@ -0,0 +1,7 @@ +# SHOW ROLES Syntax + +```ngql +SHOW ROLES IN > +``` + +`SHOW ROLES` statement displays the roles that are assigned to a user account. `SHOW ROLES` output has these columns: account and role type. diff --git a/docs/manual-EN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-snapshots-syntax.md b/docs/manual-EN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-snapshots-syntax.md new file mode 100644 index 00000000000..176f5006f83 --- /dev/null +++ b/docs/manual-EN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-snapshots-syntax.md @@ -0,0 +1,7 @@ +# SHOW SNAPSHOTS Syntax + +```ngql +SHOW SNAPSHOTS +``` + +`SHOW SNAPSHOTS` statement lists all the snapshots. diff --git a/docs/manual-EN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-spaces-syntax.md b/docs/manual-EN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-spaces-syntax.md new file mode 100644 index 00000000000..f5d4c8631a4 --- /dev/null +++ b/docs/manual-EN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-spaces-syntax.md @@ -0,0 +1,7 @@ +# SHOW SPACES Syntax + +```ngql +SHOW SPACES +``` + +`SHOW SPACES` lists the SPACES on the **Nebula Graph** cluster. diff --git a/docs/manual-EN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-tags-edges-syntax.md b/docs/manual-EN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-tags-edges-syntax.md new file mode 100644 index 00000000000..7dee823f9b0 --- /dev/null +++ b/docs/manual-EN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-tags-edges-syntax.md @@ -0,0 +1,7 @@ +# SHOW TAGS/EDGES Syntax + +```ngql +SHOW {TAGS | EDGES} +``` + +`SHOW TAGS` and `SHOW EDGES` return the defined tags and edge types in a given space, respectively. diff --git a/docs/manual-EN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-users-syntax.md b/docs/manual-EN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-users-syntax.md new file mode 100644 index 00000000000..3574c632c91 --- /dev/null +++ b/docs/manual-EN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-users-syntax.md @@ -0,0 +1,7 @@ +# SHOW USERS Syntax + +```ngql +SHOW USERS +``` + +`SHOW USERS` lists the users information. `SHOW USERS` output has these columns: account names. diff --git a/docs/manual-EN/2.query-language/4.statement-syntax/3.utility-statements/show-syntax.md b/docs/manual-EN/2.query-language/4.statement-syntax/3.utility-statements/show-syntax.md deleted file mode 100644 index f29b2aaa9a2..00000000000 --- a/docs/manual-EN/2.query-language/4.statement-syntax/3.utility-statements/show-syntax.md +++ /dev/null @@ -1,104 +0,0 @@ -# Show Syntax - -```ngql -SHOW {SPACES | TAGS | EDGES | HOSTS | PARTS } -SHOW PARTS -SHOW CREATE { SPACE | TAG | EDGE} { | | } -SHOW {TAG | EDGE} INDEXES -SHOW CONFIGS [graph|meta|storage] -SHOW SNAPSHOTS -SHOW CHARSET -SHOW COLLATION -``` - -`SHOW SPACES` lists the SPACES on the **Nebula Graph** cluster. - -`SHOW TAGS` and `SHOW EDGES` return the defined tags and edge types in a given space, respectively. - -`SHOW CREATE SPACE` returns the specified graph space and its creation syntax. If the graph space contains a default value, the default value is also returned. - -`SHOW CREATE TAG` and `SHOW CREATE EDGE` return the specified tag or edge type and their creation syntax in a given space. If the tag or edge type contains a default value, the default value is also returned. - -`SHOW INDEXES` returns the defined tag/edg-type index information. - -`SHOW HOSTS` is to list storage hosts registered by the meta server. There are 6 columns: ip, port, status (online/offline), leader partitions count in all spaces, leader partitions count in each space, total partitions count in all spaces. - -`SHOW PARTS` lists the partition information of the given SPACE. - -`SHOW PARTS ` lists the specified partition information. - -For more information about `SHOW CONFIGS [graph|meta|storage]`, please refer to [configs syntax](../../../3.build-develop-and-administration/3.deploy-and-administrations/server-administration/configuration-statements/configs-syntax.md). - -`SHOW SNAPSHOTS` lists all the snapshots. - -`SHOW CHARSET` displays the available character sets. - -`SHOW COLLATION` lists the display collations for a character set. - -## Example - -```ngql -nebula> SHOW HOSTS; -============================================================================================= -| Ip | Port | Status | Leader count | Leader distribution | Partition distribution | -============================================================================================= -| 172.28.2.1 | 44500 | online | 33 | nba: 3, test: 30 | test: 100, nba: 3 | ---------------------------------------------------------------------------------------------- -| 172.28.2.2 | 44500 | online | 48 | nba: 4, test: 44 | test: 100, nba: 4 | ---------------------------------------------------------------------------------------------- -| 172.28.2.3 | 44500 | online | 30 | nba: 3, test: 27 | test: 100, nba: 3 | ---------------------------------------------------------------------------------------------- -| Total | | | 111 | nba: 10, test: 101 | test: 300, nba: 10 | ---------------------------------------------------------------------------------------------- - -nebula> SHOW SPACES; -======== -| Name | -======== -| nba | --------- - -nebula> USE nba; -nebula> SHOW PARTS; -============================================================== -| Partition ID | Leader | Peers | Losts | -============================================================== -| 1 | 172.28.2.2:44500 | 172.28.2.2:44500 | | --------------------------------------------------------------- -| 2 | 172.28.2.3:44500 | 172.28.2.3:44500 | | --------------------------------------------------------------- -| 3 | 172.28.2.1:44500 | 172.28.2.1:44500 | | --------------------------------------------------------------- -| 4 | 172.28.2.2:44500 | 172.28.2.2:44500 | | --------------------------------------------------------------- -| 5 | 172.28.2.3:44500 | 172.28.2.3:44500 | | --------------------------------------------------------------- -| 6 | 172.28.2.1:44500 | 172.28.2.1:44500 | | --------------------------------------------------------------- -| 7 | 172.28.2.2:44500 | 172.28.2.2:44500 | | --------------------------------------------------------------- -| 8 | 172.28.2.3:44500 | 172.28.2.3:44500 | | --------------------------------------------------------------- -| 9 | 172.28.2.1:44500 | 172.28.2.1:44500 | | --------------------------------------------------------------- -| 10 | 172.28.2.2:44500 | 172.28.2.2:44500 | | --------------------------------------------------------------- - -nebula> SHOW TAGS; -=============== -| ID | Name | -=============== -| 2 | player | ---------------- -| 3 | team | ---------------- - -nebula> SHOW CREATE TAG team; -=========================================================================== -| Tag | Create Tag | -=========================================================================== -| team | CREATE TAG team ( - name string -) ttl_duration = 0, ttl_col = "" | ---------------------------------------------------------------------------- -``` diff --git a/docs/manual-EN/README.md b/docs/manual-EN/README.md index 3e309344103..24a2a932be2 100644 --- a/docs/manual-EN/README.md +++ b/docs/manual-EN/README.md @@ -81,9 +81,23 @@ It is the optimal solution in the world capable of hosting graphs with dozens of * [Yield Syntax](2.query-language/4.statement-syntax/2.data-query-and-manipulation-statements/yield-syntax.md) * Utility Statements + * Show Statements + * [Show Charset Syntax](2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-charset-syntax.md) + * [Show Collation Syntax](2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-collation-syntax.md) + * [Show Configs Syntax](2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-configs-syntax.md) + * [Show Create Spaces Syntax](2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-create-space-syntax.md) + * [Show Create Tag/Edge Syntax](2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-create-tag-edge-syntax.md) + * [Show Hosts Syntax](2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-hosts-syntax.md) + * [Show Indexes Syntax](2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-indexes-syntax.md) + * [Show Parts Syntax](2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-parts-syntax.md) + * [Show Roles Syntax](2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-roles-syntax.md) + * [Show Snapshots Syntax](2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-snapshots-syntax.md) + * [Show Spaces Syntax](2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-spaces-syntax.md) + * [Show Tag/Edge Syntax](2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-tags-edges-syntax.md) + * [Show Users Syntax](2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-users-syntax.md) * [Describe Syntax](2.query-language/4.statement-syntax/3.utility-statements/describe-syntax.md) * [Use Syntax](2.query-language/4.statement-syntax/3.utility-statements/use-syntax.md) - * [Show Syntax](2.query-language/4.statement-syntax/3.utility-statements/show-syntax.md) + * Graph Algorithms * [Find Path Syntax](2.query-language/4.statement-syntax/4.graph-algorithms/find-path-syntax.md) From 0984a2ce80b316a32d20fc6096906d1a9d2845dc Mon Sep 17 00:00:00 2001 From: Amber1990Zhang <42762957+Amber1990Zhang@users.noreply.github.com> Date: Fri, 20 Mar 2020 10:07:49 +0800 Subject: [PATCH 2/2] update --- .../show-statements/show-collation-syntax.md | 2 +- .../show-statements/show-collation-syntax.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/manual-CN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-collation-syntax.md b/docs/manual-CN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-collation-syntax.md index c70dfa104b3..0183755bafb 100644 --- a/docs/manual-CN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-collation-syntax.md +++ b/docs/manual-CN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-collation-syntax.md @@ -4,7 +4,7 @@ SHOW COLLATION ``` -`SHOW COLLATION` 语句列出服务器支持的排序规则。目前支持四种类型：utf8_bin、utf8_general_ci、utf8mb4_bin、utf8mb4_general_ci。字符集为 utf8 时，默认 collate 为 utf8_bin；字符集为 utf8mb4 时，默认 collate 为 utf8mb4_bin。utf8_general_ci 和 utf8mb4_general_ci 都是忽略大小写的比较，行为同 MySQL 一致。 +`SHOW COLLATION` 语句列出 **Nebula Graph** 目前支持的所有排序规则。目前支持四种排序规则：utf8_bin、utf8_general_ci、utf8mb4_bin、utf8mb4_general_ci。字符集为 utf8 时，默认 collate 为 utf8_bin；字符集为 utf8mb4 时，默认 collate 为 utf8mb4_bin。utf8_general_ci 和 utf8mb4_general_ci 都是忽略大小写的比较，行为同 MySQL 一致。 ```ngql nebula> SHOW COLLATION; diff --git a/docs/manual-EN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-collation-syntax.md b/docs/manual-EN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-collation-syntax.md index b13806824f3..9f6b67ba1c7 100644 --- a/docs/manual-EN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-collation-syntax.md +++ b/docs/manual-EN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-collation-syntax.md @@ -4,7 +4,7 @@ SHOW COLLATION ``` -`SHOW COLLATION` displays the collations supported by the server. Currently available types are: utf8_bin, utf8_general_ci, utf8mb4_bin and utf8mb4_general_ci. When the character set is utf8, the default collate is utf8_bin; when the character set is utf8mb4, the default collate is utf8mb4_bin. Both utf8_general_ci and utf8mb4_general_ci are case-insensitive comparisons and behave the same as MySQL. +`SHOW COLLATION` displays the collations supported by **Nebula Graph**. Currently available types are: utf8_bin, utf8_general_ci, utf8mb4_bin and utf8mb4_general_ci. When the character set is utf8, the default collate is utf8_bin; when the character set is utf8mb4, the default collate is utf8mb4_bin. Both utf8_general_ci and utf8mb4_general_ci are case-insensitive comparisons and behave the same as MySQL. ```ngql nebula> SHOW COLLATION;