update docs (#1446)

vesoft-inc · Feb 8, 2022 · 7f8bce1 · 7f8bce1
1 parent dad9470
commit 7f8bce1
Show file tree

Hide file tree

Showing 3 changed files with 43 additions and 20 deletions.
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
@@ -171,9 +171,14 @@ nebula> SHOW HOSTS;
 ### nGQL 语法
 
 ```ngql
-CREATE {TAG | EDGE} {<tag_name> | <edge_type>}(<property_name> <data_type>
-[, <property_name> <data_type> ...])
-[COMMENT = '<comment>'];
+CREATE {TAG | EDGE} [IF NOT EXISTS] {<tag_name> | <edge_type_name>}
+    (
+      <prop_name> <data_type> [NULL | NOT NULL] [DEFAULT <default_value>] [COMMENT '<comment>']
+      [{, <prop_name> <data_type> [NULL | NOT NULL] [DEFAULT <default_value>] [COMMENT '<comment>']} ...] 
+    )
+    [TTL_DURATION = <ttl_duration>]
+    [TTL_COL = <prop_name>]
+    [COMMENT = '<comment>'];
 ```
 
 参数详情请参见 [CREATE TAG](../3.ngql-guide/10.tag-statements/1.create-tag.md) 和 [CREATE EDGE](../3.ngql-guide/11.edge-type-statements/1.create-edge.md)。
@@ -209,7 +214,7 @@ nebula> CREATE EDGE serve(start_year int, end_year int);
 
     ```ngql
     INSERT VERTEX [IF NOT EXISTS] [tag_props, [tag_props] ...]
-    VALUES VID: ([prop_value_list])
+    VALUES <vid>: ([prop_value_list])
 
     tag_props:
       tag_name ([prop_name_list])
@@ -221,14 +226,20 @@ nebula> CREATE EDGE serve(start_year int, end_year int);
        [prop_value [, prop_value] ...]  
     ```
 
-    `VID`是 Vertex ID 的缩写，`VID`在一个图空间中是唯一的。参数详情请参见 [INSERT VERTEX](../3.ngql-guide/12.vertex-statements/1.insert-vertex.md)。
+    `vid`是 Vertex ID 的缩写，`vid`在一个图空间中是唯一的。参数详情请参见 [INSERT VERTEX](../3.ngql-guide/12.vertex-statements/1.insert-vertex.md)。
 
 - 插入边
 
     ```ngql
-    INSERT EDGE [IF NOT EXISTS] <edge_type> (<property_name>[, <property_name>...])
-    VALUES <src_vid> -> <dst_vid>[@<rank>] : (<property_value>[, <property_value>...])
-    [, <src_vid> -> <dst_vid>[@<rank>] : (<property_name>[, <property_name>...]), ...];
+    INSERT EDGE [IF NOT EXISTS] <edge_type> ( <prop_name_list> ) VALUES 
+    <src_vid> -> <dst_vid>[@<rank>] : ( <prop_value_list> )
+    [, <src_vid> -> <dst_vid>[@<rank>] : ( <prop_value_list> ), ...];
+
+    <prop_name_list> ::=
+    [ <prop_name> [, <prop_name> ] ...]
+
+    <prop_value_list> ::=
+    [ <prop_value> [, <prop_value> ] ...]
     ```
 
     参数详情请参见 [INSERT EDGE](../3.ngql-guide/13.edge-statements/1.insert-edge.md)。
@@ -276,10 +287,10 @@ nebula> CREATE EDGE serve(start_year int, end_year int);
     ```ngql
     GO [[<M> TO] <N> STEPS ] FROM <vertex_list>
     OVER <edge_type_list> [{REVERSELY | BIDIRECT}]
-    [ WHERE <conditions> ]
-    YIELD [DISTINCT] <return_list>
-    [{SAMPLE <sample_list> | LIMIT <limit_list>}]
-    [| GROUP BY {col_name | expr | position} YIELD <col_name>]
+    [ WHERE <conditions> ]
+    YIELD [DISTINCT] <return_list>
+    [{ SAMPLE <sample_list> | <limit_by_list_clause> }]
+    [| GROUP BY {<col_name> | expression> | <position>} YIELD <col_name>]
     [| ORDER BY <expression> [{ASC | DESC}]]
     [| LIMIT [<offset>,] <number_rows>];
     ```
@@ -307,12 +318,15 @@ nebula> CREATE EDGE serve(start_year int, end_year int);
     LOOKUP ON {<vertex_tag> | <edge_type>}
     [WHERE <expression> [AND <expression> ...]]
     YIELD <return_list> [AS <alias>];
+
+    <return_list>
+        <prop_name> [AS <col_alias>] [, <prop_name> [AS <prop_alias>] ...];
     ```
 
 - `MATCH`
 
     ```nGQL
-    MATCH <pattern> [<WHERE clause>] RETURN <output>;
+    MATCH <pattern> [<clause_1>]  RETURN <output>  [<clause_2>];
     ```
 
 ### `GO`语句示例

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
@@ -380,7 +380,7 @@
 
 | 语句                                                         | 语法                                                         | 示例                                                  | 说明                                                         |
 | ------------------------------------------------------------ | ------------------------------------------------------------ | ----------------------------------------------------- | ------------------------------------------------------------ |
-| [CREATE SPACE](../3.ngql-guide/9.space-statements/1.create-space.md) | `CREATE SPACE [IF NOT EXISTS] <graph_space_name> ( [partition_num = <partition_number>,] [replica_factor = <replica_number>,]  vid_type = {FIXED_STRING(<N>) | INT[64]} ) [ON zone_list]  [COMMENT = '<comment>']` | `CREATE SPACE my_space_1 (vid_type=FIXED_STRING(30))` | 创建一个新的图空间。                                         |
+| [CREATE SPACE](../3.ngql-guide/9.space-statements/1.create-space.md) | `CREATE SPACE [IF NOT EXISTS] <graph_space_name> ( [partition_num = <partition_number>,] [replica_factor = <replica_number>,]  vid_type = {FIXED_STRING(<N>) | INT[64]} ) [COMMENT = '<comment>']` | `CREATE SPACE my_space_1 (vid_type=FIXED_STRING(30))` | 创建一个新的图空间。                                         |
 | [CREATE SPACE](../3.ngql-guide/9.space-statements/1.create-space.md) | `CREATE SPACE <new_graph_space_name> AS <old_graph_space_name>` | `CREATE SPACE my_space_4 as my_space_3`               | 克隆现有图空间的 Schema。                                       |
 | [USE](../3.ngql-guide/9.space-statements/2.use-space.md) | `USE <graph_space_name>`                                     | `USE space1`                                          | 指定一个图空间，或切换到另一个图空间，将其作为后续查询的工作空间。 |
 | [SHOW SPACES](../3.ngql-guide/9.space-statements/3.show-spaces.md) | `SHOW SPACES`                                                | `SHOW SPACES`                                         | 列出 Nebula Graph 示例中的所有图空间。                         |
@@ -412,7 +412,7 @@
 
 | 语句                                                         | 语法                                                         | 示例                                                         | 说明                                                         |
 | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
-| [INSERT VERTEX](../3.ngql-guide/12.vertex-statements/1.insert-vertex.md) | `INSERT VERTEX [IF NOT EXISTS] [tag_props, [tag_props] ...] VALUES VID: ([prop_value_list])` | `INSERT VERTEX t2 (name, age) VALUES "13":("n3", 12), "14":("n4", 8)` | 在 Nebula Graph 实例的指定图空间中插入一个或多个点。           |
+| [INSERT VERTEX](../3.ngql-guide/12.vertex-statements/1.insert-vertex.md) | `INSERT VERTEX [IF NOT EXISTS] [tag_props, [tag_props] ...] VALUES <vid>: ([prop_value_list])` | `INSERT VERTEX t2 (name, age) VALUES "13":("n3", 12), "14":("n4", 8)` | 在 Nebula Graph 实例的指定图空间中插入一个或多个点。           |
 | [DELETE VERTEX](../3.ngql-guide/12.vertex-statements/4.delete-vertex.md) | `DELETE VERTEX <vid> [, <vid> ...]`                          | `DELETE VERTEX "team1"`                                      | 删除点，以及点关联的出边和入边。                             |
 | [UPDATE VERTEX](../3.ngql-guide/12.vertex-statements/2.update-vertex.md) | `UPDATE VERTEX ON <tag_name> <vid> SET <update_prop> [WHEN <condition>] [YIELD <output>]` | `UPDATE VERTEX ON player "player101" SET age = age + 2 `     | 修改点上 Tag 的属性值。                                        |
 | [UPSERT VERTEX](../3.ngql-guide/12.vertex-statements/3.upsert-vertex.md) | `UPSERT VERTEX ON <tag> <vid> SET <update_prop> [WHEN <condition>] [YIELD <output>]` | `UPSERT VERTEX ON player "player667" SET age = 31`           | 结合`UPDATE`和`INSERT`，如果点存在，会修改点的属性值；如果点不存在，会插入新的点。 |
@@ -477,7 +477,7 @@
 
   | 语法                              | 说明                                                         |
   | :-------------------------------- | :----------------------------------------------------------- |
-  |`BALANCE LEADER`|在当前图空间内所有 Zone 之间启动任务均衡分布 leader。该命令会返回任务 ID。|
+  |`BALANCE LEADER`|在当前图空间内启动任务均衡分布 leader。该命令会返回任务 ID。|
 <!-- balance-3.1
   |`BALANCE IN ZONE [REMOVE <ip>:<port> [,<ip>:<port> ...]]`|在当前图空间内每个 Zone 内部启动任务均衡分布分片。该命令会返回任务 ID。可以使用`REMOVE`选项指定需要清空的 Storage 节点，方便进行维护。|
   |`BALANCE ACROSS ZONE [REMOVE "zone_name" [,"zone_name" ...]]`|在当前图空间内所有 Zone 之间启动任务均衡分布分片，保证各个 Zone 分片数量平衡。该命令会返回任务 ID。可以使用`REMOVE`选项指定需要清空的 Zone，方便进行维护。|

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
@@ -43,17 +43,26 @@ Nebula Graph 查询语言 nGQL 参照以下标准设计：
 |  符号 | 含义  |
 |  ----  | ----  |
 | < >    | 语法元素的名称。 |
-| ::=    | 定义元素的公式。 |
+| :    | 定义元素的公式。 |
 | [ ]    | 可选元素。 |
 | { }    | 显式的指定元素。 |
 |  \|    | 所有可选的元素。 |
 | ...    | 可以重复多次。 |
 
-例如创建点或边的 nGQL 语法：
+例如创建点的 nGQL 语法：
 
 ```ngql
-CREATE {TAG | EDGE} {<tag_name> | <edge_type>}(<property_name> <data_type>
-[, <property_name> <data_type> ...]);
+INSERT VERTEX [IF NOT EXISTS] [tag_props, [tag_props] ...]
+VALUES <vid>: ([prop_value_list])
+
+tag_props:
+  tag_name ([prop_name_list])
+
+prop_name_list:
+   [prop_name [, prop_name] ...]
+
+prop_value_list:
+   [prop_value [, prop_value] ...]  
 ```
 
 示例语句：