Skip to content

Commit

Permalink
schema support Chinese (#1310)
Browse files Browse the repository at this point in the history
* schema support Chinese

* Update keywords-and-reserved-words.md

* Update 1.create-tag.md

* update

* Update 1.create-tag.md

* Update 1.create-edge.md

* Update 1.create-native-index.md

* Update 1.create-space.md
  • Loading branch information
cooper-lzy committed Dec 10, 2021
1 parent a20e836 commit fdb74dd
Show file tree
Hide file tree
Showing 5 changed files with 9 additions and 6 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

关键字在 nGQL 中有重要意义,分为保留关键字和非保留关键字。

非保留关键字作为标识符时可以不使用引号。保留关键字作为标识符时,需要用反引号(\`将它们括起来,例如 \`AND\`
非保留关键字作为标识符时可以不使用引号。保留关键字作为标识符时,需要用反引号(\`包围,例如 \`AND\`

!!! Note

Expand All @@ -17,6 +17,9 @@ Execution succeeded
nebula> CREATE TAG SPACE(name string);
Execution succeeded
nebula> CREATE TAG 中文(简体 string);
Execution succeeded
```

- `TAG`是保留关键字,要将`TAG`作为标识符,用户必须使用反引号(\`)括起来。
Expand Down
2 changes: 1 addition & 1 deletion docs-2.0/3.ngql-guide/10.tag-statements/1.create-tag.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ CREATE TAG [IF NOT EXISTS] <tag_name>
|参数|说明|
|:---|:---|
|`IF NOT EXISTS`|检测待创建的 Tag 是否存在,只有不存在时,才会创建 Tag。仅检测 Tag 的名称,不会检测具体属性。|
|`<tag_name>`|每个图空间内的 Tag 必须是唯一的。Tag 名称设置后无法修改。Tag 名称由大小写英文字母、数字或下划线组成,区分大写小,且不可使用[关键字和保留字](../../3.ngql-guide/1.nGQL-overview/keywords-and-reserved-words.md)|
|`<tag_name>`|每个图空间内的 Tag 必须是唯一的。Tag 名称设置后无法修改。Tag 名称支持 1~4 字节的 UTF-8 编码字符,包括英文字母(区分大小写)、数字、中文等,但是不包括除下划线外的特殊字符。使用保留关键字时,需要用反引号(\`)包围,详情参见[关键字和保留字](../../3.ngql-guide/1.nGQL-overview/keywords-and-reserved-words.md)|
|`<prop_name>`|属性名称。每个 Tag 中的属性名称必须唯一。属性的命名规则与 Tag 相同。|
|`<data_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)|
|`NULL \| NOT NULL`|指定属性值是否支持为`NULL`。默认值为`NULL`|
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ CREATE EDGE [IF NOT EXISTS] <edge_type_name>
|参数|说明|
|:---|:---|
|`IF NOT EXISTS`|检测待创建的 Edge type 是否存在,只有不存在时,才会创建 Edge type。仅检测 Edge type 的名称,不会检测具体属性。|
|`<edge_type_name>`|每个图空间内的 Edge type 必须是唯一的。Edge type 名称设置后无法修改。Edge type 名称由大小写英文字母、数字或下划线组成,区分大写小,且不可使用[关键字和保留字](../../3.ngql-guide/1.nGQL-overview/keywords-and-reserved-words.md)|
|`<edge_type_name>`|每个图空间内的 Edge type 必须是唯一的。Edge type 名称设置后无法修改。Edge type 名称支持 1~4 字节的 UTF-8 编码字符,包括英文字母(区分大小写)、数字、中文等,但是不包括除下划线外的特殊字符。使用保留关键字时,需要用反引号(\`)包围,详情参见[关键字和保留字](../../3.ngql-guide/1.nGQL-overview/keywords-and-reserved-words.md)|
|`<prop_name>`|属性名称。每个 Edge type 中的属性名称必须唯一。属性的命名规则与 Edge type 相同。|
|`<data_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)|
|`NULL \| NOT NULL`|指定属性值是否支持为`NULL`。默认值为`NULL`|
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ CREATE {TAG | EDGE} INDEX [IF NOT EXISTS] <index_name> ON {<tag_name> | <edge_na
|:---|:---|
|`TAG \| EDGE`| 指定要创建的索引类型。|
|`IF NOT EXISTS`|检测待创建的索引是否存在,只有不存在时,才会创建索引。|
|`<index_name>`|索引名。索引名在一个图空间中必须是唯一的。推荐的命名方式为`i_tagName_propName`索引名称由大小写英文字母、数字或下划线组成,区分大写小,且不可使用[关键字和保留字](../../3.ngql-guide/1.nGQL-overview/keywords-and-reserved-words.md)|
|`<index_name>`|索引名。索引名在一个图空间中必须是唯一的。推荐的命名方式为`i_tagName_propName`索引名称支持 1~4 字节的 UTF-8 编码字符,包括英文字母(区分大小写)、数字、中文等,但是不包括除下划线外的特殊字符。使用保留关键字时,需要用反引号(\`)包围,详情参见[关键字和保留字](../../3.ngql-guide/1.nGQL-overview/keywords-and-reserved-words.md)|
|`<tag_name> \| <edge_name>`|指定索引关联的 Tag 或 Edge 名称。|
|`<prop_name_list>`|**变长**字符串属性创建索引时,必须用`prop_name(length)`指定索引长度;为 Tag 或 Edge type 本身创建索引时,忽略`<prop_name_list>`|
|`COMMENT`|索引的描述。最大为 256 字节。默认无描述。|
Expand Down
4 changes: 2 additions & 2 deletions docs-2.0/3.ngql-guide/9.space-statements/1.create-space.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ CREATE SPACE [IF NOT EXISTS] <graph_space_name> (
|参数|说明|
|:---|:---|
|`IF NOT EXISTS`|检测待创建的图空间是否存在,只有不存在时,才会创建图空间。仅检测图空间的名称,不会检测具体属性。|
|`<graph_space_name>`|在 Nebula Graph 实例中唯一标识一个图空间。图空间名称由大小写英文字母、数字或下划线组成,区分大写小,且不可使用[关键字和保留字](../../3.ngql-guide/1.nGQL-overview/keywords-and-reserved-words.md)|
|`<graph_space_name>`|在 Nebula Graph 实例中唯一标识一个图空间。图空间名称支持 1~4 字节的 UTF-8 编码字符,包括英文字母(区分大小写)、数字、中文等,但是不包括除下划线外的特殊字符。使用保留关键字时,需要用反引号(\`)包围,详情参见[关键字和保留字](../../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(<N>)``INT64``INT`等同于`INT64``FIXED_STRING(<N>)`表示数据类型为字符串,最大长度为`N`,超出长度会报错;`INT64`表示数据类型为整数。|
Expand Down Expand Up @@ -58,7 +58,7 @@ CREATE SPACE <new_graph_space_name> AS <old_graph_space_name>;

|参数|说明|
|:---|:---|
|`<new_graph_space_name>`|目标图空间名称。该图空间必须未创建。图空间名称由大小写英文字母、数字或下划线组成,区分大写小,且不可使用[关键字和保留字](../../3.ngql-guide/1.nGQL-overview/keywords-and-reserved-words.md)。创建时会克隆`<old_graph_space_name>`图空间的 Schema,包括图空间本身参数(分片数量、副本数量等),以及 Tag、Edge type 和原生索引。|
|`<new_graph_space_name>`|目标图空间名称。该图空间必须未创建。图空间名称支持 1~4 字节的 UTF-8 编码字符,包括英文字母(区分大小写)、数字、中文等,但是不包括除下划线外的特殊字符。使用保留关键字时,需要用反引号(\`)包围,详情参见[关键字和保留字](../../3.ngql-guide/1.nGQL-overview/keywords-and-reserved-words.md)。创建时会克隆`<old_graph_space_name>`图空间的 Schema,包括图空间本身参数(分片数量、副本数量等),以及 Tag、Edge type 和原生索引。|
|`<old_graph_space_name>`|原始图空间名称。该图空间必须已存在。|

## 示例
Expand Down

0 comments on commit fdb74dd

Please sign in to comment.