diff --git a/docs-2.0/1.introduction/2.data-model.md b/docs-2.0/1.introduction/2.data-model.md index 5ccfd1c3ca8..c7a2e4c7f3d 100644 --- a/docs-2.0/1.introduction/2.data-model.md +++ b/docs-2.0/1.introduction/2.data-model.md @@ -15,7 +15,7 @@ Nebula Graph数据模型使用6种基本的数据结构： 点用来保存实体对象，特点如下： - 点是用点标识符（`VID`）标识的。`VID`在同一图空间中唯一。VID 是一个 int64, 或者 fixed_string(N)。 - - 点必须有至少一个标签（Tag)，也可以有多个标签。 + - 点必须有至少一个Tag，也可以有多个Tag。但不能没有Tag。 - 边（edge） @@ -23,17 +23,17 @@ Nebula Graph数据模型使用6种基本的数据结构： - 两点之间可以有多条边。 - 边是有方向的，不存在无向边。 - - 四元组 `<起点VID、边类型（edge type）、边排序值(rank)、终点VID>` 用于唯一标识一条边。边没有EID。 - - 一条边有且仅有一个边类型。 + - 四元组 `<起点VID、Edge type、边排序值(rank)、终点VID>` 用于唯一标识一条边。边没有EID。 + - 一条边有且仅有一个Edge type。 - 一条边有且仅有一个rank。其为int64, 默认为0。 - 标签（tag） - 标签由一组事先预定义的属性构成。 + Tag由一组事先预定义的属性构成。 - 边类型（edge type） - 边类型由一组事先预定义的属性构成。 + Edge type由一组事先预定义的属性构成。 - 属性（properties） diff --git a/docs-2.0/1.introduction/3.nebula-graph-architecture/2.meta-service.md b/docs-2.0/1.introduction/3.nebula-graph-architecture/2.meta-service.md index 28ddbaf737c..c92df57916e 100644 --- a/docs-2.0/1.introduction/3.nebula-graph-architecture/2.meta-service.md +++ b/docs-2.0/1.introduction/3.nebula-graph-architecture/2.meta-service.md @@ -37,7 +37,7 @@ Nebula Graph支持多个图空间，不同图空间内的数据是安全隔离 ### 管理Schema信息 -Nebula Graph是强类型图数据库，它的Schema包括标签、边类型、标签属性和边类型属性。 +Nebula Graph是强类型图数据库，它的Schema包括Tag、Edge type、Tag属性和Edge type属性。 Meta服务中存储了Schema信息，同时还负责Schema的添加、修改和删除，并记录它们的版本。 diff --git a/docs-2.0/1.introduction/3.nebula-graph-architecture/3.graph-service.md b/docs-2.0/1.introduction/3.nebula-graph-architecture/3.graph-service.md index fb356c4d9e6..a6101dab593 100644 --- a/docs-2.0/1.introduction/3.nebula-graph-architecture/3.graph-service.md +++ b/docs-2.0/1.introduction/3.nebula-graph-architecture/3.graph-service.md @@ -32,7 +32,7 @@ Validator模块对生成的AST进行语义校验，主要包括： 校验语句中的元数据信息是否正确。 - 例如解析`OVER`、`WHERE`和`YIELD`语句时，会查找Schema校验边类型、标签的信息是否存在，或者插入数据时校验插入的数据类型和Schema中的是否一致。 + 例如解析`OVER`、`WHERE`和`YIELD`语句时，会查找Schema校验Edge type、Tag的信息是否存在，或者插入数据时校验插入的数据类型和Schema中的是否一致。 - 校验上下文引用信息 @@ -50,7 +50,7 @@ Validator模块对生成的AST进行语义校验，主要包括： 查询语句中包含`*`时，校验子句时需要将`*`涉及的Schema都进行校验。 - 例如语句`GO FROM "Tim" OVER * YIELD like._dst, like.likeness, serve._dst`，校验`OVER`子句时需要校验所有的边类型，如果边类型包含`like`和`serve`，该语句会展开为`GO FROM "Tim" OVER like,serve YIELD like._dst, like.likeness, serve._dst`。 + 例如语句`GO FROM "Tim" OVER * YIELD like._dst, like.likeness, serve._dst`，校验`OVER`子句时需要校验所有的Edge type，如果Edge type包含`like`和`serve`，该语句会展开为`GO FROM "Tim" OVER like,serve YIELD like._dst, like.likeness, serve._dst`。 - 校验输入输出 diff --git a/docs-2.0/1.introduction/3.nebula-graph-architecture/4.storage-service.md b/docs-2.0/1.introduction/3.nebula-graph-architecture/4.storage-service.md index 9939397c71f..a98c71137fa 100644 --- a/docs-2.0/1.introduction/3.nebula-graph-architecture/4.storage-service.md +++ b/docs-2.0/1.introduction/3.nebula-graph-architecture/4.storage-service.md @@ -85,7 +85,7 @@ Nebula Graph使用自行开发的KVStore，而不是其他开源KVStore，原因 |`Type`|key类型。长度为1个字节。| |`PartID`|数据分片编号。长度为3个字节。此字段主要用于Storage负载均衡（balance）时方便根据前缀扫描整个分片的数据。| |`VertexID`|点ID。当点ID类型为int时，长度为8个字节；当点ID类型为string时，长度为创建图空间时指定的`fixed_string`长度。| - |`TagID`|点关联的标签ID。长度为4个字节。| + |`TagID`|点关联的Tag ID。长度为4个字节。| - 边数据存储格式 @@ -104,7 +104,7 @@ Nebula Graph使用自行开发的KVStore，而不是其他开源KVStore，原因 2.0和1.x的差异如下： - - 1.x中，点和边的`Type`值相同，而在2.0中进行了区分，即在物理上分离了点和边，方便快速查询某个点的所有标签。 + - 1.x中，点和边的`Type`值相同，而在2.0中进行了区分，即在物理上分离了点和边，方便快速查询某个点的所有Tag。 - 1.x中，`VertexID`仅支持int类型，而在2.0中新增了string类型。 - 2.0中取消了1.x中的保留字段`Timestamp`。 - 2.0中边数据新增字段`PlaceHolder`。 @@ -144,7 +144,7 @@ EdgeA_Out和EdgeA_In以方向相反的两条边的形式存在于存储层，二 ### 分片算法 -分片策略采用**静态 Hash**的方式，即对点VID进行取模操作，同一个点的所有标签、出边和入边信息都会存储到同一个分片，这种方式极大地提升了查询效率。 +分片策略采用**静态 Hash**的方式，即对点VID进行取模操作，同一个点的所有Tag、出边和入边信息都会存储到同一个分片，这种方式极大地提升了查询效率。 !!! Note diff --git a/docs-2.0/1.introduction/3.vid.md b/docs-2.0/1.introduction/3.vid.md index cd0ea52a17c..d7026b16e00 100644 --- a/docs-2.0/1.introduction/3.vid.md +++ b/docs-2.0/1.introduction/3.vid.md @@ -12,9 +12,9 @@ - VID相同的点，会被认为是同一个点。例如： - + VID相当于一个实体的唯一标号，例如一个人的身份证号。标签（Tag）相当于实体所拥有的类型，例如"滴滴司机"和"老板"。不同的Tag又相应定义了两组不同的属性，例如"驾照号、驾龄、接单量、接单小号"和"工号、薪水、债务额度、商务电话"。 + + VID相当于一个实体的唯一标号，例如一个人的身份证号。Tag相当于实体所拥有的类型，例如"滴滴司机"和"老板"。不同的Tag又相应定义了两组不同的属性，例如"驾照号、驾龄、接单量、接单小号"和"工号、薪水、债务额度、商务电话"。 - + 同时操作相同VID并且相同Tag的两条`INSERT`语句，晚写入的`INSERT`会覆盖先写入的。 + + 同时操作相同VID并且相同Tag的两条`INSERT`语句（均无`IF NOT EXISTS`参数），晚写入的`INSERT`会覆盖先写入的。 + 同时操作包含相同VID但是两个不同`TAG A`和`TAG B`的两条`INSERT`语句，对`TAG A`的操作不会影响`TAG B`。 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 index d28f9a85aaa..dde35cb2c37 100644 --- a/docs-2.0/2.quick-start/4.nebula-graph-crud.md +++ b/docs-2.0/2.quick-start/4.nebula-graph-crud.md @@ -15,7 +15,7 @@ | 点（vertex） | 表示现实世界中的实体。一个点可以有一个或多个标签。 | | 标签（tag） | 点的类型，定义了一组描述点类型的属性。 | | 边（edge） | 表示两个点之间**有方向**的关系。| -| 边类型（edge type） | 边的类型，定义了一组描述边类型的属性。 | +| 边类型（edge type） | 边的类型，定义了一组描述边的类型的属性。 | 更多信息，请参见[数据结构](../1.introduction/2.data-model.md)。 @@ -154,7 +154,7 @@ Nebula Graph中执行如下创建和修改操作，是异步实现的，需要 Got 1 rows (time spent 977/2000 us) ``` -## 创建标签和边类型 +## 创建Tag和Edge type ### nGQL语法 @@ -165,7 +165,7 @@ CREATE {TAG | EDGE} { | }( ### 示例 -创建标签`player`和`team`，以及边类型`follow`和`serve`。说明如下表。 +创建Tag`player`和`team`，以及Edge type`follow`和`serve`。说明如下表。 | 名称 | 类型 | 属性 | | :--- | :--- | :--- | @@ -198,14 +198,14 @@ Wed, 24 Feb 2021 03:48:16 EST ## 插入点和边 -用户可以使用`INSERT`语句，基于现有的标签插入点，或者基于现有的边类型插入边。 +用户可以使用`INSERT`语句，基于现有的Tag插入点，或者基于现有的Edge type插入边。 ### nGQL语法 - 插入点 ```ngql - INSERT VERTEX ([, ...]) + INSERT VERTEX [IF NOT EXISTS] ([, ...]) [, ([, ...]), ...] {VALUES | VALUE} : ([, ...]) [, : ([, ...]; @@ -216,7 +216,7 @@ Wed, 24 Feb 2021 03:48:16 EST - 插入边 ```ngql - INSERT EDGE ([, ...]) + INSERT EDGE [IF NOT EXISTS] ([, ...]) {VALUES | VALUE} -> [@] : ([, ...]) [, -> [@] : ([, ...]), ...]; ``` @@ -294,7 +294,7 @@ Wed, 24 Feb 2021 03:48:16 EST - `FETCH` - - 查询标签属性 + - 查询Tag属性 ```ngql FETCH PROP ON { | | *} @@ -537,7 +537,7 @@ Got 1 rows (time spent 2006/2406 us) ## 索引 -用户可以通过[CREATE INDEX](../3.ngql-guide/14.native-index-statements/1.create-native-index.md)语句为标签（tag）和边类型（edge type）增加索引。 +用户可以通过[CREATE INDEX](../3.ngql-guide/14.native-index-statements/1.create-native-index.md)语句为Tag和Edge type增加索引。 ### 使用索引必读 @@ -562,7 +562,7 @@ Got 1 rows (time spent 2006/2406 us) ### 示例 -为标签`player`的属性`name`创建索引，并且重建索引。 +为Tag`player`的属性`name`创建索引，并且重建索引。 ```ngql nebula> CREATE TAG INDEX player_index_0 on player(name(20)); @@ -577,7 +577,7 @@ nebula> REBUILD TAG INDEX player_index_0; 确保`LOOKUP`或`MATCH`有一个索引可用。如果没有，请先创建索引。 -找到标签为`player`的点的信息，它的`name`属性值为`Tony Parker`。 +找到Tag为`player`的点的信息，它的`name`属性值为`Tony Parker`。 ```nGQL // 为name属性创建索引player_name_0。 diff --git a/docs-2.0/20.appendix/0.FAQ.md b/docs-2.0/20.appendix/0.FAQ.md index 68a5c08067d..ebefd5f77fe 100644 --- a/docs-2.0/20.appendix/0.FAQ.md +++ b/docs-2.0/20.appendix/0.FAQ.md @@ -82,11 +82,11 @@ Storage服务使用Raft协议（多数表决），为保证可用性，要求出 大部分情况下，查询语句需要有`YIELD`或`RETURN`，请检查查询语句是否包含。 -### 如何统计每种Tag有多少个点，每个边类型有多少条边? +### 如何统计每种Tag有多少个点，每个Edge type有多少条边? 请参见[show-stats](../3.ngql-guide/7.general-query-statements/6.show/14.show-stats.md)。 -### 如何获取每种Tag的所有点，或者每种边类型的所有边? +### 如何获取每种Tag的所有点，或者每种Edge type的所有边? 1. 建立并重建索引。 @@ -167,9 +167,9 @@ Storage服务在毫秒级时间内多次收到插入或者更新同一点或边 不支持。即使关闭了客户端，服务端仍会尽力把该查询执行完毕，无法中断。 -### 能不能用中文字符做标识符，比如图空间、标签、边类型、属性、索引的名称？ +### 能不能用中文字符做标识符，比如图空间、Tag、Edge type、属性、索引的名称？ -不能。图空间、标签、边类型、属性以及索引的名称都需由大小写英文字母、数字或下划线组成，暂不支持使用中文字符。 +不能。图空间、Tag、Edge type、属性以及索引的名称都需由大小写英文字母、数字或下划线组成，暂不支持使用中文字符。 同时，上述标识符区分大小写，且不可使用[关键字和保留字](../3.ngql-guide/1.nGQL-overview/keywords-and-reserved-words.md) 。 diff --git a/docs-2.0/3.ngql-guide/1.nGQL-overview/3.graph-patterns.md b/docs-2.0/3.ngql-guide/1.nGQL-overview/3.graph-patterns.md index f6f0269d642..72c5b800039 100644 --- a/docs-2.0/3.ngql-guide/1.nGQL-overview/3.graph-patterns.md +++ b/docs-2.0/3.ngql-guide/1.nGQL-overview/3.graph-patterns.md @@ -36,19 +36,19 @@ (a)-[]->()<-[]-(c) ``` -## 标签模式 +## Tag模式 !!! Note nGQL中的`tag`概念与openCypher中的`label`有一些不同。例如，您必须创建一个`tag`之后才能使用它，而且`tag`还定义了属性的类型。 -模式除了简单地描述图中的点之外，还可以描述点的标签。例如： +模式除了简单地描述图中的点之外，还可以描述点的Tag。例如： ```ngql (a:User)-[]->(b) ``` -模式也可以描述有多个标签的点，例如： +模式也可以描述有多个Tag的点，例如： ```ngql (a:User:Admin)-[]->(b) @@ -86,13 +86,13 @@ (a)-[r]->(b) ``` -和点上的标签一样，边也可以有类型。描述边的类型，例如： +和点上的Tag一样，边也可以有类型。描述边的类型，例如： ```ngql (a)-[r:REL_TYPE]->(b) ``` -和点上的标签不同，一条边只能有一种边类型。但是如果我们想描述多个可选边类型，可以用管道符号（|）将可选值分开，例如： +和点上的Tag不同，一条边只能有一种Edge type。但是如果我们想描述多个可选Edge type，可以用管道符号（|）将可选值分开，例如： ```ngql (a)-[r:TYPE1|TYPE2]->(b) diff --git a/docs-2.0/3.ngql-guide/10.tag-statements/1.create-tag.md b/docs-2.0/3.ngql-guide/10.tag-statements/1.create-tag.md index 55e3d36b5ca..a79d8028f34 100644 --- a/docs-2.0/3.ngql-guide/10.tag-statements/1.create-tag.md +++ b/docs-2.0/3.ngql-guide/10.tag-statements/1.create-tag.md @@ -1,6 +1,6 @@ # CREATE TAG -`CREATE TAG`语句可以通过指定名称创建一个标签。 +`CREATE TAG`语句可以通过指定名称创建一个Tag。 ## OpenCypher兼容性 @@ -11,11 +11,11 @@ nGQL中的tag和openCypher中的label相似，但又有所不同，例如它们 ## 前提条件 -执行`CREATE TAG`语句需要当前登录的用户拥有指定图空间的[创建标签权限](../../7.data-security/1.authentication/3.role-list.md)，否则会报错。 +执行`CREATE TAG`语句需要当前登录的用户拥有指定图空间的[创建Tag权限](../../7.data-security/1.authentication/3.role-list.md)，否则会报错。 ## 语法 -创建标签前，需要先用`USE`语句指定工作空间。 +创建Tag前，需要先用`USE`语句指定工作空间。 ```ngql CREATE TAG [IF NOT EXISTS] @@ -34,21 +34,21 @@ CREATE TAG [IF NOT EXISTS] | DEFAULT ``` -### 标签名称 +### Tag名称 -- `IF NOT EXISTS`：用户可以使用`IF NOT EXISTS`关键字检测待创建的标签是否存在，只有不存在时，才会创建标签。 +- `IF NOT EXISTS`：用户可以使用`IF NOT EXISTS`关键字检测待创建的Tag是否存在，只有不存在时，才会创建Tag。 !!! Note - 仅检测标签的名称，不会检测具体属性。 + 仅检测Tag的名称，不会检测具体属性。 -- `tag_name`：每个图空间内的标签必须是唯一的。标签名称设置后无法修改。标签名称由大小写英文字母、数字或下划线组成，区分大写小，且不可使用[关键字和保留字](../../3.ngql-guide/1.nGQL-overview/keywords-and-reserved-words.md)。 +- `tag_name`：每个图空间内的Tag必须是唯一的。Tag名称设置后无法修改。Tag名称由大小写英文字母、数字或下划线组成，区分大写小，且不可使用[关键字和保留字](../../3.ngql-guide/1.nGQL-overview/keywords-and-reserved-words.md)。 -### 标签属性 +### Tag属性 - `prop_name` - 属性名称。每个标签中的属性名称必须唯一。属性的命名规则与标签相同。 + 属性名称。每个Tag中的属性名称必须唯一。属性的命名规则与Tag相同。 - `data_type` @@ -72,17 +72,17 @@ CREATE TAG [IF NOT EXISTS] 指定要设置存活时间的属性。属性的数据类型必须是`int`或者`timestamp`。 -一个标签只能指定一个字段为`TTL_COL`。更多TTL的信息请参见[TTL](../8.clauses-and-options/ttl-options.md)。 +一个Tag只能指定一个字段为`TTL_COL`。更多TTL的信息请参见[TTL](../8.clauses-and-options/ttl-options.md)。 ## 示例 ```ngql nebula> CREATE TAG player(name string, age int); -# 创建没有属性的标签。 +# 创建没有属性的Tag。 nebula> CREATE TAG no_property();  -# 创建包含默认值的标签。 +# 创建包含默认值的Tag。 nebula> CREATE TAG player_with_default(name string, age int DEFAULT 20); # 对字段create_time设置TTL为100秒。 @@ -91,13 +91,13 @@ nebula> CREATE TAG woman(name string, age int, \ TTL_DURATION = 100, TTL_COL = "create_time"; ``` -## 创建标签说明 +## 创建Tag说明 -尝试使用新创建的标签可能会失败，因为创建是异步实现的。 +尝试使用新创建的Tag可能会失败，因为创建是异步实现的。 -Nebula Graph将在下一个心跳周期内完成标签的创建，为了确保创建成功，可以使用如下方法之一： +Nebula Graph将在下一个心跳周期内完成Tag的创建，为了确保创建成功，可以使用如下方法之一： -- 在[`SHOW TAGS`](4.show-tags.md)语句的结果中查找新的标签，如果找不到，请等待几秒重试。 +- 在[`SHOW TAGS`](4.show-tags.md)语句的结果中查找新的Tag，如果找不到，请等待几秒重试。 - 等待两个心跳周期，例如20秒。 diff --git a/docs-2.0/3.ngql-guide/10.tag-statements/2.drop-tag.md b/docs-2.0/3.ngql-guide/10.tag-statements/2.drop-tag.md index 74c757e06bf..a3c093555d2 100644 --- a/docs-2.0/3.ngql-guide/10.tag-statements/2.drop-tag.md +++ b/docs-2.0/3.ngql-guide/10.tag-statements/2.drop-tag.md @@ -1,20 +1,20 @@ # DROP TAG -`DROP TAG`语句可以删除当前工作空间内的指定标签。 +`DROP TAG`语句可以删除当前工作空间内的指定Tag。 -点可以有一个或多个标签。 +点可以有一个或多个Tag。 -- 如果某个点只有一个标签，删除这个标签后，用户就**无法访问**这个点，下次Compaction操作时会删除该点，但点上的边仍然存在。 +- 如果某个点只有一个Tag，删除这个Tag后，用户就**无法访问**这个点，下次Compaction操作时会删除该点，但点上的边仍然存在。 -- 如果某点有多个标签，删除其中一个标签，仍然可以访问这个点，但是**无法访问**已删除标签定义的所有属性。 +- 如果某点有多个Tag，删除其中一个Tag，仍然可以访问这个点，但是**无法访问**已删除Tag定义的所有属性。 -删除标签操作仅删除Schema数据，硬盘上的文件或目录不会立刻删除，而是在下一次Compaction操作时删除。 +删除Tag操作仅删除Schema数据，硬盘上的文件或目录不会立刻删除，而是在下一次Compaction操作时删除。 ## 前提条件 - 登录的用户必须拥有对应权限才能执行`DROP TAG`语句。详情请参见[内置角色权限](../../7.data-security/1.authentication/3.role-list.md)。 -- 确保标签不包含任何索引，否则`DROP TAG`时会报冲突错误`[ERROR (-8)]: Conflict!`。删除索引请参见[drop index](../14.native-index-statements/6.drop-native-index.md)。 +- 确保Tag不包含任何索引，否则`DROP TAG`时会报冲突错误`[ERROR (-8)]: Conflict!`。删除索引请参见[drop index](../14.native-index-statements/6.drop-native-index.md)。 ## 语法 @@ -22,9 +22,9 @@ DROP TAG [IF EXISTS] ; ``` -- `IF NOT EXISTS`：检测待删除的标签是否存在，只有存在时，才会删除标签。 +- `IF NOT EXISTS`：检测待删除的Tag是否存在，只有存在时，才会删除Tag。 -- `tag_name`：指定要删除的标签名称。一次只能删除一个标签。 +- `tag_name`：指定要删除的Tag名称。一次只能删除一个Tag。 ## 示例 @@ -35,9 +35,9 @@ nebula> DROP TAG test; !!! Note - nGQL中没有移除指定点的某个标签的语句。 + nGQL中没有移除指定点的某个Tag的语句。 - * 在openCypher中，可以使用`REMOVE v:LABEL`语句来移除该点`v`的标签`LABLE`。 + * 在openCypher中，可以使用`REMOVE v:LABEL`语句来移除该点`v`的Tag`LABLE`。 * 在nGQL中，通过`CREATE TAG`和`INSERT VERTEX`语句后，可以为该点增加一个`TAG`；但是没有任何办法移除这个点的`TAG`。 建议在schema中增加一个字段来标识软移除，例如为每个TAG的schema增加一个字段`removed`。 diff --git a/docs-2.0/3.ngql-guide/10.tag-statements/3.alter-tag.md b/docs-2.0/3.ngql-guide/10.tag-statements/3.alter-tag.md index c5174d946c5..d25d9b26ccc 100644 --- a/docs-2.0/3.ngql-guide/10.tag-statements/3.alter-tag.md +++ b/docs-2.0/3.ngql-guide/10.tag-statements/3.alter-tag.md @@ -1,6 +1,6 @@ # ALTER TAG -`ALTER TAG`语句可以修改标签的结构。例如增删属性、修改数据类型，也可以为属性设置、修改[TTL](../8.clauses-and-options/ttl-options.md)（Time-To-Live）。 +`ALTER TAG`语句可以修改Tag的结构。例如增删属性、修改数据类型，也可以为属性设置、修改[TTL](../8.clauses-and-options/ttl-options.md)（Time-To-Live）。 ## 前提条件 @@ -24,7 +24,7 @@ ttl_definition: TTL_DURATION = ttl_duration, TTL_COL = prop_name ``` -- `tag_name`：指定要修改的标签名称。一次只能修改一个标签。请确保要修改的标签在当前工作空间中存在，否则会报错。 +- `tag_name`：指定要修改的Tag名称。一次只能修改一个Tag。请确保要修改的Tag在当前工作空间中存在，否则会报错。 - 可以在一个`ALTER TAG`语句中使用多个`ADD`、`DROP`和`CHANGE`子句，子句之间用英文逗号（,）分隔。 @@ -36,13 +36,13 @@ nebula> ALTER TAG t1 ADD (p3 int, p4 string); nebula> ALTER TAG t1 TTL_DURATION = 2, TTL_COL = "p2"; ``` -## 修改标签说明 +## 修改Tag说明 -尝试使用刚修改的标签可能会失败，因为修改是异步实现的。 +尝试使用刚修改的Tag可能会失败，因为修改是异步实现的。 -Nebula Graph将在下一个心跳周期内完成标签的修改，为了确保修改成功，可以使用如下方法之一： +Nebula Graph将在下一个心跳周期内完成Tag的修改，为了确保修改成功，可以使用如下方法之一： -- 在[`DESCRIBE TAG`](5.describe-tag.md)语句的结果中查看标签信息，确认修改成功。如果没有修改成功，请等待几秒重试。 +- 在[`DESCRIBE TAG`](5.describe-tag.md)语句的结果中查看Tag信息，确认修改成功。如果没有修改成功，请等待几秒重试。 - 等待两个心跳周期，例如20秒。 diff --git a/docs-2.0/3.ngql-guide/10.tag-statements/4.show-tags.md b/docs-2.0/3.ngql-guide/10.tag-statements/4.show-tags.md index 916d4204c15..acb8b7cb617 100644 --- a/docs-2.0/3.ngql-guide/10.tag-statements/4.show-tags.md +++ b/docs-2.0/3.ngql-guide/10.tag-statements/4.show-tags.md @@ -1,6 +1,6 @@ # SHOW TAGS -`SHOW TAGS`语句显示当前图空间内的所有标签名称。 +`SHOW TAGS`语句显示当前图空间内的所有Tag名称。 执行`SHOW TAGS`语句不需要任何权限，但是返回结果由登录的用户[权限](../../7.data-security/1.authentication/3.role-list.md)决定。 diff --git a/docs-2.0/3.ngql-guide/10.tag-statements/5.describe-tag.md b/docs-2.0/3.ngql-guide/10.tag-statements/5.describe-tag.md index 6783d5f0155..27a066670b0 100644 --- a/docs-2.0/3.ngql-guide/10.tag-statements/5.describe-tag.md +++ b/docs-2.0/3.ngql-guide/10.tag-statements/5.describe-tag.md @@ -1,6 +1,6 @@ # DESCRIBE TAG -`DESCRIBE TAG`显示指定标签的详细信息，例如字段名称、数据类型等。 +`DESCRIBE TAG`显示指定Tag的详细信息，例如字段名称、数据类型等。 ## 前提条件 diff --git a/docs-2.0/3.ngql-guide/11.edge-type-statements/1.create-edge.md b/docs-2.0/3.ngql-guide/11.edge-type-statements/1.create-edge.md index e1782c4a82f..674c1733ff6 100644 --- a/docs-2.0/3.ngql-guide/11.edge-type-statements/1.create-edge.md +++ b/docs-2.0/3.ngql-guide/11.edge-type-statements/1.create-edge.md @@ -1,21 +1,21 @@ # CREATE EDGE -`CREATE EDGE`语句可以通过指定名称创建一个边类型。 +`CREATE EDGE`语句可以通过指定名称创建一个Edge type。 ## OpenCypher兼容性 -nGQL中的边类型和openCypher中的关系类型相似，但又有所不同，例如它们的创建方式。 +nGQL中的Edge type和openCypher中的关系类型相似，但又有所不同，例如它们的创建方式。 * openCypher中的关系类型需要在`CREATE`语句中与点一起创建。 -* nGQL中的边类型需要使用`CREATE EDGE`语句独立创建。边类型更像是MySQL中的表。 +* nGQL中的Edge type需要使用`CREATE EDGE`语句独立创建。Edge type更像是MySQL中的表。 ## 前提条件 -执行`CREATE EDGE`语句需要当前登录的用户拥有指定图空间的[创建边类型权限](../../7.data-security/1.authentication/3.role-list.md)，否则会报错。 +执行`CREATE EDGE`语句需要当前登录的用户拥有指定图空间的[创建Edge type权限](../../7.data-security/1.authentication/3.role-list.md)，否则会报错。 ## 语法 -创建边类型前，需要先用`USE`语句指定工作空间。 +创建Edge type前，需要先用`USE`语句指定工作空间。 ```ngql CREATE EDGE [IF NOT EXISTS] @@ -34,21 +34,21 @@ CREATE EDGE [IF NOT EXISTS] | DEFAULT ``` -### 边类型名称 +### Edge type名称 -- `IF NOT EXISTS`：检测待创建的边类型是否存在，只有不存在时，才会创建边类型。 +- `IF NOT EXISTS`：检测待创建的Edge type是否存在，只有不存在时，才会创建Edge type。 !!! Note - 仅检测边类型的名称，不会检测具体属性。 + 仅检测Edge type的名称，不会检测具体属性。 -- `edge_type_name`：每个图空间内的边类型必须是唯一的。边类型名称设置后无法修改。边类型名称由大小写英文字母、数字或下划线组成，区分大写小，且不可使用[关键字和保留字](../../3.ngql-guide/1.nGQL-overview/keywords-and-reserved-words.md)。 +- `edge_type_name`：每个图空间内的Edge type必须是唯一的。Edge type名称设置后无法修改。Edge type名称由大小写英文字母、数字或下划线组成，区分大写小，且不可使用[关键字和保留字](../../3.ngql-guide/1.nGQL-overview/keywords-and-reserved-words.md)。 -### 边类型属性 +### Edge type属性 - `prop_name` - 属性名称。每个边类型中的属性名称必须唯一。属性的命名规则与边类型相同。 + 属性名称。每个Edge type中的属性名称必须唯一。属性的命名规则与Edge type相同。 - `data_type` @@ -72,17 +72,17 @@ CREATE EDGE [IF NOT EXISTS] 指定要设置存活时间的属性。属性的数据类型必须是`int`或者`timestamp`。 -一个边类型只能指定一个字段为`TTL_COL`。更多TTL的信息请参见[TTL](../8.clauses-and-options/ttl-options.md)。 +一个Edge type只能指定一个字段为`TTL_COL`。更多TTL的信息请参见[TTL](../8.clauses-and-options/ttl-options.md)。 ### 示例 ```ngql nebula> CREATE EDGE follow(degree int); -# 创建没有属性的边类型。 +# 创建没有属性的Edge type。 nebula> CREATE EDGE no_property(); -# 创建包含默认值的边类型。 +# 创建包含默认值的Edge type。 nebula> CREATE EDGE follow_with_default(degree int DEFAULT 20); # 对字段p2设置TTL为100秒。 diff --git a/docs-2.0/3.ngql-guide/11.edge-type-statements/2.drop-edge.md b/docs-2.0/3.ngql-guide/11.edge-type-statements/2.drop-edge.md index 9896899dda8..37dbe77d2f3 100644 --- a/docs-2.0/3.ngql-guide/11.edge-type-statements/2.drop-edge.md +++ b/docs-2.0/3.ngql-guide/11.edge-type-statements/2.drop-edge.md @@ -1,16 +1,16 @@ # DROP EDGE -`DROP EDGE`语句可以删除当前工作空间内的指定边类型。 +`DROP EDGE`语句可以删除当前工作空间内的指定Edge type。 -一个边只能有一个边类型，删除这个边类型后，用户就**无法访问**这个边，下次Compaction操作时会删除该边。 +一个边只能有一个Edge type，删除这个Edge type后，用户就**无法访问**这个边，下次Compaction操作时会删除该边。 -删除边类型操作仅删除Schema数据，硬盘上的文件或目录不会立刻删除，而是在下一次Compaction操作时删除。 +删除Edge type操作仅删除Schema数据，硬盘上的文件或目录不会立刻删除，而是在下一次Compaction操作时删除。 ## 前提条件 - 登录的用户必须拥有对应权限才能执行`DROP EDGE`语句。详情请参见[内置角色权限](../../7.data-security/1.authentication/3.role-list.md)。 -- 确保边类型不包含任何索引，否则`DROP EDGE`时会报冲突错误`[ERROR (-8)]: Conflict!`。删除索引请参见[drop index](../14.native-index-statements/6.drop-native-index.md)。 +- 确保Edge type不包含任何索引，否则`DROP EDGE`时会报冲突错误`[ERROR (-8)]: Conflict!`。删除索引请参见[drop index](../14.native-index-statements/6.drop-native-index.md)。 ## 语法 @@ -18,9 +18,9 @@ DROP EDGE [IF EXISTS] ``` -- `IF NOT EXISTS`：检测待删除的边类型是否存在，只有存在时，才会删除边类型。 +- `IF NOT EXISTS`：检测待删除的Edge type是否存在，只有存在时，才会删除Edge type。 -- `edge_type_name`：指定要删除的边类型名称。一次只能删除一个边类型。 +- `edge_type_name`：指定要删除的Edge type名称。一次只能删除一个Edge type。 ## 示例 diff --git a/docs-2.0/3.ngql-guide/11.edge-type-statements/3.alter-edge.md b/docs-2.0/3.ngql-guide/11.edge-type-statements/3.alter-edge.md index 7b7c6bb59f0..4f7dc5b8233 100644 --- a/docs-2.0/3.ngql-guide/11.edge-type-statements/3.alter-edge.md +++ b/docs-2.0/3.ngql-guide/11.edge-type-statements/3.alter-edge.md @@ -1,6 +1,6 @@ # ALTER EDGE -`ALTER EDGE`语句可以修改边类型的结构。例如增删属性、修改数据类型，也可以为属性设置、修改[TTL](../8.clauses-and-options/ttl-options.md)（Time-To-Live）。 +`ALTER EDGE`语句可以修改Edge type的结构。例如增删属性、修改数据类型，也可以为属性设置、修改[TTL](../8.clauses-and-options/ttl-options.md)（Time-To-Live）。 ## 前提条件 @@ -24,7 +24,7 @@ ttl_definition: TTL_DURATION = ttl_duration, TTL_COL = prop_name ``` -- `edge_type_name`：指定要修改的边类型名称。一次只能修改一个边类型。请确保要修改的边类型在当前工作空间中存在，否则会报错。 +- `edge_type_name`：指定要修改的Edge type名称。一次只能修改一个Edge type。请确保要修改的Edge type在当前工作空间中存在，否则会报错。 - 可以在一个`ALTER EDGE`语句中使用多个`ADD`、`DROP`和`CHANGE`子句，子句之间用英文逗号（,）分隔。 @@ -36,13 +36,13 @@ nebula> ALTER EDGE e1 ADD (p3 int, p4 string); nebula> ALTER EDGE e1 TTL_DURATION = 2, TTL_COL = "p2"; ``` -## 修改边类型说明 +## 修改Edge type说明 -尝试使用刚修改的边类型可能会失败，因为修改是异步实现的。 +尝试使用刚修改的Edge type可能会失败，因为修改是异步实现的。 -Nebula Graph将在下一个心跳周期内完成边类型的修改，为了确保修改成功，可以使用如下方法之一： +Nebula Graph将在下一个心跳周期内完成Edge type的修改，为了确保修改成功，可以使用如下方法之一： -- 在[`DESCRIBE EDGE`](5.describe-edge.md)语句的结果中查看边类型信息，确认修改成功。如果没有修改成功，请等待几秒重试。 +- 在[`DESCRIBE EDGE`](5.describe-edge.md)语句的结果中查看Edge type信息，确认修改成功。如果没有修改成功，请等待几秒重试。 - 等待两个心跳周期，例如20秒。 diff --git a/docs-2.0/3.ngql-guide/11.edge-type-statements/4.show-edges.md b/docs-2.0/3.ngql-guide/11.edge-type-statements/4.show-edges.md index 99a823f73a9..ad8c81f018c 100644 --- a/docs-2.0/3.ngql-guide/11.edge-type-statements/4.show-edges.md +++ b/docs-2.0/3.ngql-guide/11.edge-type-statements/4.show-edges.md @@ -1,6 +1,6 @@ # SHOW EDGES -`SHOW EDGES`语句显示当前图空间内的所有边类型名称。 +`SHOW EDGES`语句显示当前图空间内的所有Edge type名称。 执行`SHOW EDGES`语句不需要任何权限，但是返回结果由登录的用户[权限](../../7.data-security/1.authentication/3.role-list.md)决定。 diff --git a/docs-2.0/3.ngql-guide/11.edge-type-statements/5.describe-edge.md b/docs-2.0/3.ngql-guide/11.edge-type-statements/5.describe-edge.md index be264496ba7..1c0da1b6826 100644 --- a/docs-2.0/3.ngql-guide/11.edge-type-statements/5.describe-edge.md +++ b/docs-2.0/3.ngql-guide/11.edge-type-statements/5.describe-edge.md @@ -1,6 +1,6 @@ # DESCRIBE EDGE -`DESCRIBE EDGE`显示指定边类型的详细信息，例如字段名称、数据类型等。 +`DESCRIBE EDGE`显示指定Edge type的详细信息，例如字段名称、数据类型等。 ## 前提条件 diff --git a/docs-2.0/3.ngql-guide/12.vertex-statements/1.insert-vertex.md b/docs-2.0/3.ngql-guide/12.vertex-statements/1.insert-vertex.md index 5355399ce8d..6d8871fc3cc 100644 --- a/docs-2.0/3.ngql-guide/12.vertex-statements/1.insert-vertex.md +++ b/docs-2.0/3.ngql-guide/12.vertex-statements/1.insert-vertex.md @@ -9,7 +9,7 @@ ## 语法 ```ngql -INSERT VERTEX () [, (), ...] +INSERT VERTEX [IF NOT EXISTS] () [, (), ...] {VALUES | VALUE} VID: ([, ]) prop_name_list: @@ -19,20 +19,26 @@ prop_value_list: [prop_value [, prop_value] ...] ``` -- `tag_name`：点关联的标签（点类型）。标签必须提前创建，详情请参见[CREATE TAG](../10.tag-statements/1.create-tag.md)。 +- `IF NOT EXISTS`：用户可以使用`IF NOT EXISTS`关键字检测待插入的VID是否存在，只有不存在时，才会插入，如果已经存在，不会进行修改。 + + !!! Note + + 仅检测VID+Tag的值是否相同，不会检测属性值。 + +- `tag_name`：点关联的Tag（点类型）。Tag必须提前创建，详情请参见[CREATE TAG](../10.tag-statements/1.create-tag.md)。 - `prop_name_list`：需要设置的属性名称列表。 - `VID`：点ID。在Nebula Graph 2.0中支持字符串和整数，需要在创建图空间时设置，详情请参见[CREATE SPACE](../9.space-statements/1.create-space.md)。 -- `prop_value_list`：根据`prop_name_list`填写属性值。如果属性值和标签中的数据类型不匹配，会返回错误。如果没有填写属性值，而标签中对应的属性设置为`NOT NULL`，也会返回错误。详情请参见[CREATE TAG](../10.tag-statements/1.create-tag.md)。 +- `prop_value_list`：根据`prop_name_list`填写属性值。如果属性值和Tag中的数据类型不匹配，会返回错误。如果没有填写属性值，而Tag中对应的属性设置为`NOT NULL`，也会返回错误。详情请参见[CREATE TAG](../10.tag-statements/1.create-tag.md)。 !!! caution `INSERT VERTEX`与openCypher中`CREATE`的语意不同： - `INSERT VERTEX`语意更接近于NoSQL(key-value)方式的INSERT语意，或者SQL中的`UPSERT` (`UPDATE` or `INSERT`)。 - - 相同`VID`和`TAG`的情况下，新写入的数据会覆盖旧数据，不存在时会新写入。 + - 相同`VID`和`TAG`的情况下，如果没有使用`IF NOT EXISTS`，新写入的数据会覆盖旧数据，不存在时会新写入。 - 相同`VID`但不同`TAG`的情况下，不同TAG对应的记录不会相互覆盖，不存在会新写入。 参考以下示例。 @@ -60,7 +66,7 @@ nebula> INSERT VERTEX t2 (name, age) VALUES "13":("n3", 12), "14":("n4", 8); nebula> CREATE TAG t3(p1 int); nebula> CREATE TAG t4(p2 string); -# 一次插入两个标签的属性到同一个点。 +# 一次插入两个Tag的属性到同一个点。 nebula> INSERT VERTEX t3 (p1), t4(p2) VALUES "21": (321, "hello"); ``` @@ -105,3 +111,18 @@ nebula> FETCH PROP on t5 "004"; | ("004" :t5{p1: "shala", p2: 4, p3: __NULL__}) | +-----------------------------------------------+ ``` + +使用`IF NOT EXISTS`插入已存在的点时，不会进行修改。 + +```ngql +# 插入点1。 +nebula> INSERT VERTEX t2 (name, age) VALUES "1":("n2", 13); +# 使用IF NOT EXISTS修改点1，因为点1已存在，不会进行修改。 +nebula> INSERT VERTEX IF NOT EXISTS t2 (name, age) VALUES "1":("n3", 14); +nebula> FETCH PROP ON t2 "1"; ++--------------------------------+ +| vertices_ | ++--------------------------------+ +| ("1" :t2{age: 13, name: "n2"}) | ++--------------------------------+ +``` diff --git a/docs-2.0/3.ngql-guide/12.vertex-statements/2.update-vertex.md b/docs-2.0/3.ngql-guide/12.vertex-statements/2.update-vertex.md index 8dedb827341..60fb6201087 100644 --- a/docs-2.0/3.ngql-guide/12.vertex-statements/2.update-vertex.md +++ b/docs-2.0/3.ngql-guide/12.vertex-statements/2.update-vertex.md @@ -1,12 +1,12 @@ # UPDATE VERTEX -`UPDATE VERTEX`语句可以修改点上标签的属性值。 +`UPDATE VERTEX`语句可以修改点上Tag的属性值。 Nebula Graph支持CAS（compare and set）操作。 !!! note - 一次只能修改一个标签。 + 一次只能修改一个Tag。 ## 语法 @@ -19,7 +19,7 @@ SET | 参数 | 是否必须 | 说明 | 示例 | |-|-|-|-| -| `ON ` | 是 | 指定点的标签。要修改的属性必须在这个标签内。 | `ON player` | +| `ON ` | 是 | 指定点的Tag。要修改的属性必须在这个Tag内。 | `ON player` | | `` | 是 | 指定要修改的点ID。 | `"player100"` | | `SET ` | 是 | 指定如何修改属性值。 | `SET age = age +1` | | `WHEN ` | 否 | 指定过滤条件。如果``结果为`false`，`SET`子句不会生效。| `WHEN name == "Tim"` | diff --git a/docs-2.0/3.ngql-guide/12.vertex-statements/3.upsert-vertex.md b/docs-2.0/3.ngql-guide/12.vertex-statements/3.upsert-vertex.md index 96377741264..da394a75b49 100644 --- a/docs-2.0/3.ngql-guide/12.vertex-statements/3.upsert-vertex.md +++ b/docs-2.0/3.ngql-guide/12.vertex-statements/3.upsert-vertex.md @@ -4,7 +4,7 @@ !!! note - `UPSERT VERTEX`一次只能修改一个标签。 + `UPSERT VERTEX`一次只能修改一个Tag。 `UPSERT VERTEX`性能远低于`INSERT`，因为`UPSERT`是一组分片级别的读取、修改、写入操作。 @@ -23,7 +23,7 @@ SET | 参数 | 是否必须 | 说明 | 示例 | |-|-|-|-| -| `ON ` | 是 | 指定点的标签。要修改的属性必须在这个标签内。 | `ON player` | +| `ON ` | 是 | 指定点的Tag。要修改的属性必须在这个Tag内。 | `ON player` | | `` | 是 | 指定要修改或插入的点ID。 | `"player100"` | | `SET ` | 是 | 指定如何修改属性值。 | `SET age = age +1` | | `WHEN ` | 否 | 指定过滤条件。 | `WHEN name == "Tim"` | @@ -39,7 +39,7 @@ SET 例如： -- 要插入的点包含基于标签`player`的属性`name`和`age`。 +- 要插入的点包含基于Tag`player`的属性`name`和`age`。 - `SET`子句指定`age=30`。 diff --git a/docs-2.0/3.ngql-guide/13.edge-statements/1.insert-edge.md b/docs-2.0/3.ngql-guide/13.edge-statements/1.insert-edge.md index 45d83d8d444..2ac6c4ad655 100644 --- a/docs-2.0/3.ngql-guide/13.edge-statements/1.insert-edge.md +++ b/docs-2.0/3.ngql-guide/13.edge-statements/1.insert-edge.md @@ -2,12 +2,12 @@ `INSERT EDGE`语句可以在Nebula Graph实例的指定图空间中插入一条或多条边。边是有方向的，从起始点（src_vid）到目的点（dst_vid）。 -`INSERT EDGE`的执行方式为覆盖式插入。如果已有边类型、起点、终点、rank都相同的边，则**覆盖**原边。 +`INSERT EDGE`的执行方式为覆盖式插入。如果已有Edge type、起点、终点、rank都相同的边，则**覆盖**原边。 ## 语法 ```ngql -INSERT EDGE ( ) {VALUES | VALUE} +INSERT EDGE [IF NOT EXISTS] ( ) {VALUES | VALUE} -> [@] : ( ) [, -> [@] : ( ), ...]; @@ -18,7 +18,13 @@ INSERT EDGE ( ) {VALUES | VALUE} [ [, ] ...] ``` -- ``：边关联的边类型，只能指定一个边类型。边类型必须提前创建，详情请参见[CREATE EDGE](../11.edge-type-statements/1.create-edge.md)。 +- `IF NOT EXISTS`：用户可以使用`IF NOT EXISTS`关键字检测待插入的边是否存在，只有不存在时，才会插入。 + + !!! Note + + 仅检测边的类型、起始点、目的点和rank，不会检测属性值。 + +- ``：边关联的Edge type，只能指定一个Edge type。Edge type必须提前创建，详情请参见[CREATE EDGE](../11.edge-type-statements/1.create-edge.md)。 - ``：需要设置的属性名称列表。 @@ -26,13 +32,13 @@ INSERT EDGE ( ) {VALUES | VALUE} - `dst_vid`：目的点ID，表示边的终点。 -- `rank`：可选项。边的rank值。默认值为`0`。rank值可以用来区分边类型、起始点、目的点都相同的边。 +- `rank`：可选项。边的rank值。默认值为`0`。rank值可以用来区分Edge type、起始点、目的点都相同的边。 !!! compatibility "openCypher兼容性" openCypher中没有rank的概念。 -- ``：根据`prop_name_list`填写属性值。如果属性值和边类型中的数据类型不匹配，会返回错误。如果没有填写属性值，而边类型中对应的属性设置为`NOT NULL`，也会返回错误。详情请参见[CREATE EDGE](../11.edge-type-statements/1.create-edge.md)。 +- ``：根据`prop_name_list`填写属性值。如果属性值和Edge type中的数据类型不匹配，会返回错误。如果没有填写属性值，而Edge type中对应的属性设置为`NOT NULL`，也会返回错误。详情请参见[CREATE EDGE](../11.edge-type-statements/1.create-edge.md)。 ## 示例 @@ -72,6 +78,21 @@ nebula> FETCH PROP ON e2 "11"->"13"; +-------------------------------------------+ ``` +使用`IF NOT EXISTS`插入已存在的边时，不会进行修改。 + +```ngql +# 插入边。 +nebula> INSERT EDGE e2 (name, age) VALUES "14"->"15"@1:("n1", 12); +# 使用IF NOT EXISTS修改边，因为边已存在，不会进行修改。 +nebula> INSERT EDGE IF NOT EXISTS e2 (name, age) VALUES "14"->"15"@1:("n2", 13); +nebula> FETCH PROP ON e2 "14"->"15"@1; ++-------------------------------------------+ +| edges_ | ++-------------------------------------------+ +| [:e2 "14"->"15" @1 {age: 12, name: "n1"}] | ++-------------------------------------------+ +``` + !!! Note * Nebula Graph {{ nebula.release }} 允许存在悬挂边（dangling edge）。因此可以在起点或者终点存在前，先写边；此时就可以通过 `._src`或`._dst`获取到（尚未写入的）点VID（不建议这样使用）。 diff --git a/docs-2.0/3.ngql-guide/13.edge-statements/2.update-edge.md b/docs-2.0/3.ngql-guide/13.edge-statements/2.update-edge.md index 4b1d8ea5791..bc0feeea0c7 100644 --- a/docs-2.0/3.ngql-guide/13.edge-statements/2.update-edge.md +++ b/docs-2.0/3.ngql-guide/13.edge-statements/2.update-edge.md @@ -1,6 +1,6 @@ # UPDATE EDGE -`UPDATE EDGE`语句可以修改边上边类型的属性。 +`UPDATE EDGE`语句可以修改边上Edge type的属性。 Nebula Graph支持CAS（compare and set）操作。 @@ -16,7 +16,7 @@ SET | 参数 | 是否必须 | 说明 | 示例 | |-|-|-|-| -| `ON ` | 是 | 指定边类型。要修改的属性必须在这个边类型内。 | `ON serve` | +| `ON ` | 是 | 指定Edge type。要修改的属性必须在这个Edge type内。 | `ON serve` | | `` | 是 | 指定边的起始点ID。 | `"player100"` | | `` | 是 | 指定边的目的点ID。 | `"team204"` | | `` | 否 | 指定边的rank值。 | `10` | diff --git a/docs-2.0/3.ngql-guide/13.edge-statements/3.upsert-edge.md b/docs-2.0/3.ngql-guide/13.edge-statements/3.upsert-edge.md index 5123f0e2d28..2119d0b0c0d 100644 --- a/docs-2.0/3.ngql-guide/13.edge-statements/3.upsert-edge.md +++ b/docs-2.0/3.ngql-guide/13.edge-statements/3.upsert-edge.md @@ -20,7 +20,7 @@ SET | 参数 | 是否必须 | 说明 | 示例 | |-|-|-|-| -| `ON ` | 是 | 指定边类型。要修改的属性必须在这个边类型内。 | `ON serve` | +| `ON ` | 是 | 指定Edge type。要修改的属性必须在这个Edge type内。 | `ON serve` | | `` | 是 | 指定边的起始点ID。 | `"player100"` | | `` | 是 | 指定边的目的点ID。 | `"team204"` | | `` | 否 | 指定边的rank值。 | `10` | @@ -38,7 +38,7 @@ SET 例如： -- 要插入的边包含基于边类型`serve`的属性`start_year`和`end_year`。 +- 要插入的边包含基于Edge type`serve`的属性`start_year`和`end_year`。 - `SET`子句指定`end_year = 2021`。 diff --git a/docs-2.0/3.ngql-guide/14.native-index-statements/1.create-native-index.md b/docs-2.0/3.ngql-guide/14.native-index-statements/1.create-native-index.md index 06694f09a41..2e9d964bad6 100644 --- a/docs-2.0/3.ngql-guide/14.native-index-statements/1.create-native-index.md +++ b/docs-2.0/3.ngql-guide/14.native-index-statements/1.create-native-index.md @@ -2,7 +2,7 @@ ## 前提条件 -创建索引之前，请确保相关的标签或边类型已经创建。如何创建标签和边类型，请参见[CREATE TAG](../10.tag-statements/1.create-tag.md)和[CREATE EDGE](../11.edge-type-statements/1.create-edge.md)。 +创建索引之前，请确保相关的Tag或Edge type已经创建。如何创建Tag和Edge type，请参见[CREATE TAG](../10.tag-statements/1.create-tag.md)和[CREATE EDGE](../11.edge-type-statements/1.create-edge.md)。 如何创建全文索引，请参见[部署全文索引](../../4.deployment-and-installation/6.deploy-text-based-index/2.deploy-es.md)。 @@ -10,13 +10,13 @@ 索引的概念和使用限制都较为复杂。索引配合`LOOKUP`和`MATCH`语句使用。 -`CREATE INDEX`语句用于对Tag、EdgeType或其属性创建原生索引。通常分别称为“标签索引”、“边类型索引”和“属性索引”。 +`CREATE INDEX`语句用于对Tag、EdgeType或其属性创建原生索引。通常分别称为“Tag索引”、“Edge type索引”和“属性索引”。 -"标签索引"和"边类型索引"应用于和"标签"、"边类型"（自身）相关的查询,而不是"基于标签上某属性"的查询。例如用 `LOOKUP` 找到"某种边类型E"的所有的边。 +"Tag索引"和"Edge type索引"应用于和"Tag"、"Edge type"（自身）相关的查询,而不是"基于Tag上某属性"的查询。例如用 `LOOKUP` 找到"某种Edge type E"的所有的边。 "属性索引"目的是"基于属性的查询"。例如基于属性`Age`找到`Age == 19`的所有的点VID。 -如果已经为"某个标签T的属性A"建立过属性索引`i_TA`，则没有必要对于`标签T`额外再建立一个标签索引`i_T`。这是因为查询引擎可以使用`i_TA`来替代`i_T`。边类型索引同理。但是，`i_T`却不能替代`i_TA`用于属性查找。 +如果已经为"某个Tag T的属性A"建立过属性索引`i_TA`，则没有必要对于`Tag T`额外再建立一个Tag索引`i_T`。这是因为查询引擎可以使用`i_TA`来替代`i_T`。Edge type索引同理。但是，`i_T`却不能替代`i_TA`用于属性查找。 !!! caution @@ -66,9 +66,9 @@ CREATE {TAG | EDGE} INDEX [IF NOT EXISTS] ON { | CREATE TAG INDEX player_index on player(); @@ -78,7 +78,7 @@ nebula> CREATE TAG INDEX player_index on player(); nebula> CREATE EDGE INDEX follow_index on follow(); ``` -为标签或边类型创建索引后，用户可以使用 `LOOKUP` 语句查找`带有该标签的`所有点的VID，或者`所有该类型的边`的`对应起始点VID、目的点VID、以及rank`。详情请参见[LOOKUP](../7.general-query-statements/5.lookup.md)。 +为Tag或Edge type创建索引后，用户可以使用 `LOOKUP` 语句查找`带有该Tag的`所有点的VID，或者`所有该类型的边`的`对应起始点VID、目的点VID、以及rank`。详情请参见[LOOKUP](../7.general-query-statements/5.lookup.md)。 ## 创建单属性索引 @@ -86,7 +86,7 @@ nebula> CREATE EDGE INDEX follow_index on follow(); nebula> CREATE TAG INDEX player_index_0 on player(name(10)); ``` -上述示例是为所有包含标签`player`的点创建属性`name`的索引，索引长度为10。即只使用属性`name`的前10个字符来创建索引。 +上述示例是为所有包含Tag`player`的点创建属性`name`的索引，索引长度为10。即只使用属性`name`的前10个字符来创建索引。 ```ngql # 变长字符串需要指定索引长度。 @@ -104,7 +104,7 @@ nebula> CREATE EDGE INDEX follow_index_0 on follow(degree); ## 创建复合属性索引 -`复合属性索引`用于查找一个标签(或者边类型)中的多个属性（的组合）。 +`复合属性索引`用于查找一个Tag(或者Edge type)中的多个属性（的组合）。 ```ngql nebula> CREATE TAG INDEX player_index_1 on player(name(10), age); @@ -112,12 +112,12 @@ nebula> CREATE TAG INDEX player_index_1 on player(name(10), age); !!! caution - 不支持跨标签或边类型创建复合索引。 + 不支持跨Tag或Edge type创建复合索引。 复合属性索引被(`LOOKUP` 或者 `MATCH`)使用时，遵循"最左匹配原则"，必须从复合属性索引的最左侧开始匹配。请参见下方示例。 ```ngql -# 为标签t的前三个属性创建复合属性索引。 +# 为Tag t的前三个属性创建复合属性索引。 nebula> CREATE TAG INDEX example_index ON TAG t(p1, p2, p3); # 注意：无法匹配到索引，因为不是从p1开始。 diff --git a/docs-2.0/3.ngql-guide/14.native-index-statements/2.1.show-create-index.md b/docs-2.0/3.ngql-guide/14.native-index-statements/2.1.show-create-index.md index 33070af6517..b90cc55c705 100644 --- a/docs-2.0/3.ngql-guide/14.native-index-statements/2.1.show-create-index.md +++ b/docs-2.0/3.ngql-guide/14.native-index-statements/2.1.show-create-index.md @@ -1,6 +1,6 @@ # SHOW CREATE INDEX -`SHOW CREATE INDEX`展示创建标签或者边类型时使用的nGQL语句,其中包含索引的详细信息，例如其关联的属性。 +`SHOW CREATE INDEX`展示创建Tag或者Edge type时使用的nGQL语句,其中包含索引的详细信息，例如其关联的属性。 ## 语法 @@ -10,7 +10,7 @@ SHOW CREATE {TAG | EDGE} INDEX ; ## 示例 -用户可以先运行`SHOW TAG INDEXES`查看有哪些标签索引，然后用`SHOW CREATE TAG INDEX`查看指定索引的创建信息。 +用户可以先运行`SHOW TAG INDEXES`查看有哪些Tag索引，然后用`SHOW CREATE TAG INDEX`查看指定索引的创建信息。 ```ngql nebula> SHOW TAG INDEXES; @@ -32,7 +32,7 @@ nebula> SHOW CREATE TAG INDEX player_index_1; +------------------+--------------------------------------------------+ ``` -边类型索引可以用类似的方法查询： +Edge type索引可以用类似的方法查询： ```ngql nebula> SHOW EDGE INDEXES; diff --git a/docs-2.0/3.ngql-guide/14.native-index-statements/2.show-native-indexes.md b/docs-2.0/3.ngql-guide/14.native-index-statements/2.show-native-indexes.md index b1a24be17e3..66f2607c216 100644 --- a/docs-2.0/3.ngql-guide/14.native-index-statements/2.show-native-indexes.md +++ b/docs-2.0/3.ngql-guide/14.native-index-statements/2.show-native-indexes.md @@ -1,6 +1,6 @@ # SHOW INDEXES -`SHOW INDEXES`语句可以列出当前图空间内的所有标签和边类型（包括属性）的索引。 +`SHOW INDEXES`语句可以列出当前图空间内的所有Tag和Edge type（包括属性）的索引。 ## 语法 diff --git a/docs-2.0/3.ngql-guide/14.native-index-statements/README.md b/docs-2.0/3.ngql-guide/14.native-index-statements/README.md index 096cab0558d..2f8b6662c37 100644 --- a/docs-2.0/3.ngql-guide/14.native-index-statements/README.md +++ b/docs-2.0/3.ngql-guide/14.native-index-statements/README.md @@ -6,11 +6,11 @@ Nebula Graph支持两种类型索引：原生索引和全文索引。 原生索引可以基于指定的属性查询数据，有如下特点： -- 包括标签索引和边类型索引。 +- 包括Tag索引和Edge type索引。 - 必须手动重建索引（`REBUILD INDEX`）。 -- 支持创建同一个标签或边类型的多个属性的索引（复合索引），但是不能跨标签或边类型。 +- 支持创建同一个Tag或Edge type的多个属性的索引（复合索引），但是不能跨Tag或Edge type。 - 复合索引可以实现部分匹配检索，遵循最左匹配原则。详情请参见[LOOKUP FAQ](../7.general-query-statements/5.lookup.md#faq)。 diff --git a/docs-2.0/3.ngql-guide/15.full-text-index-statements/1.search-with-text-based-index.md b/docs-2.0/3.ngql-guide/15.full-text-index-statements/1.search-with-text-based-index.md index 1c08ed5a599..6527d9316bc 100644 --- a/docs-2.0/3.ngql-guide/15.full-text-index-statements/1.search-with-text-based-index.md +++ b/docs-2.0/3.ngql-guide/15.full-text-index-statements/1.search-with-text-based-index.md @@ -59,7 +59,7 @@ nebula> USE basketballplayer; //添加listener到Nebula Graph集群。 nebula> ADD LISTENER ELASTICSEARCH 192.168.8.5:9789; -//创建标签。 +//创建Tag。 nebula> CREATE TAG player(name string, age int); //创建原生索引。 diff --git a/docs-2.0/3.ngql-guide/16.subgraph-and-path/1.get-subgraph.md b/docs-2.0/3.ngql-guide/16.subgraph-and-path/1.get-subgraph.md index fb3bb757487..a5333245e8c 100644 --- a/docs-2.0/3.ngql-guide/16.subgraph-and-path/1.get-subgraph.md +++ b/docs-2.0/3.ngql-guide/16.subgraph-and-path/1.get-subgraph.md @@ -1,6 +1,6 @@ # GET SUBGRAPH -`GET SUBGRAPH`语句检索指定边类型的起始点可以到达的点和边的信息，返回子图信息。 +`GET SUBGRAPH`语句检索指定Edge type的起始点可以到达的点和边的信息，返回子图信息。 ## 语法 @@ -17,7 +17,7 @@ GET SUBGRAPH [WITH PROP] [ STEPS] FROM {, ...} - `vid`：指定起始点ID。 -- `edge_type`：指定边类型。可以用`IN`、`OUT`和`BOTH`来指定起始点上该边类型的方向。默认为`BOTH`。 +- `edge_type`：指定Edge type。可以用`IN`、`OUT`和`BOTH`来指定起始点上该Edge type的方向。默认为`BOTH`。 !!! note @@ -29,7 +29,7 @@ GET SUBGRAPH [WITH PROP] [ STEPS] FROM {, ...} ![A sample graph for GET SUBGRAPH](https://docs-cdn.nebula-graph.com.cn/docs-2.0/2.quick-start/dataset-for-crud.png) -- 查询从点`player100`开始、0~1跳、所有边类型的子图。 +- 查询从点`player100`开始、0~1跳、所有Edge type的子图。 ```ngql nebula> GET SUBGRAPH 1 STEPS FROM "player100"; 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 index 32cbf3a968d..1a8b1156e3c 100644 --- 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 @@ -22,7 +22,7 @@ OVER [REVERSELY | BIDIRECT] [] [UPTO STEPS] [ - ``：点ID列表.多个点用英文逗号（,）分隔。支持`$-`和`$var`。 -- ``：边类型列表.多个边类型用英文逗号（,）分隔。`*`表示所有边类型。 +- ``：Edge type列表.多个Edge type用英文逗号（,）分隔。`*`表示所有Edge type。 - `REVERSELY | BIDIRECT`：`REVERSELY`表示反向，`BIDIRECT`表示双向。 diff --git a/docs-2.0/3.ngql-guide/3.data-types/4.date-and-time.md b/docs-2.0/3.ngql-guide/3.data-types/4.date-and-time.md index 88ae35e4bd0..0f2ceb38a09 100644 --- a/docs-2.0/3.ngql-guide/3.data-types/4.date-and-time.md +++ b/docs-2.0/3.ngql-guide/3.data-types/4.date-and-time.md @@ -47,7 +47,7 @@ ## 示例 -1. 创建标签，名称为`date1`，包含`DATE`、`TIME`和`DATETIME`三种类型。 +1. 创建Tag，名称为`date1`，包含`DATE`、`TIME`和`DATETIME`三种类型。 ```ngql nebula> CREATE TAG date1(p1 date, p2 time, p3 datetime); @@ -59,7 +59,7 @@ nebula> INSERT VERTEX date1(p1, p2, p3) VALUES "test1":(date("2021-03-17"), time("17:53:59"), datetime("2021-03-17T17:53:59")); ``` -3. 创建标签，名称为`school`，包含`TIMESTAMP`类型。 +3. 创建Tag，名称为`school`，包含`TIMESTAMP`类型。 ```ngql nebula> CREATE TAG school(name string , found_time timestamp); diff --git a/docs-2.0/3.ngql-guide/3.data-types/5.null.md b/docs-2.0/3.ngql-guide/3.data-types/5.null.md index b736198a472..269231981f5 100644 --- a/docs-2.0/3.ngql-guide/3.data-types/5.null.md +++ b/docs-2.0/3.ngql-guide/3.data-types/5.null.md @@ -34,13 +34,13 @@ Nebula Graph中，对NULL的操作以及返回结果不兼容openCypher。 ### 使用NOT NULL -创建标签，名称为`player`，指定属性`name`为`NOT NULL`。 +创建Tag，名称为`player`，指定属性`name`为`NOT NULL`。 ```ngql nebula> CREATE TAG player(name string NOT NULL, age int); ``` -使用`SHOW`命令查看创建标签语句，属性`name`为`NOT NULL`，属性`age`为默认的`NULL`。 +使用`SHOW`命令查看创建Tag语句，属性`name`为`NOT NULL`，属性`age`为默认的`NULL`。 ```ngql nebula> SHOW CREATE TAG player; @@ -62,7 +62,7 @@ nebula> INSERT VERTEX player(name, age) VALUES "Kobe":("Kobe",null); ### 使用NOT NULL并设置默认值 -创建标签，名称为`player`，指定属性`age`为`NOT NULL`，并设置默认值`18`。 +创建Tag，名称为`player`，指定属性`age`为`NOT NULL`，并设置默认值`18`。 ```ngql nebula> CREATE TAG player(name string, age int NOT NULL DEFAULT 18); diff --git a/docs-2.0/3.ngql-guide/4.variable-and-composite-queries/3.property-reference.md b/docs-2.0/3.ngql-guide/4.variable-and-composite-queries/3.property-reference.md index b93bd50e002..1fcdd04eddf 100644 --- a/docs-2.0/3.ngql-guide/4.variable-and-composite-queries/3.property-reference.md +++ b/docs-2.0/3.ngql-guide/4.variable-and-composite-queries/3.property-reference.md @@ -17,8 +17,8 @@ $^.. |参数|说明| |:----------|:-----------------| |`$^` |起始点 | -|`tag_name` |点的标签名称 | -|`prop_name`|标签内的属性名称| +|`tag_name` |点的Tag名称 | +|`prop_name`|Tag内的属性名称| ### 目的点 @@ -29,8 +29,8 @@ $$.. |参数|说明| |:----------|:-----------------| |`$$` |目的点 | -|`tag_name` |点的标签名称 | -|`prop_name`|标签内的属性名称| +|`tag_name` |点的Tag名称 | +|`prop_name`|Tag内的属性名称| ## 引用边的属性 @@ -42,8 +42,8 @@ $$.. |参数|说明| |:----------|:------------------| -|`edge_type`|边类型 | -|`prop_name` |边类型的属性名称| +|`edge_type`|Edge type | +|`prop_name` |Edge type的属性名称| ### 引用内置的边属性 @@ -59,7 +59,7 @@ $$.. ## 示例 ```ngql -# 返回起始点的标签player的name属性值和目的点的标签player的age属性值。 +# 返回起始点的Tag player的name属性值和目的点的Tag player的age属性值。 nebula> GO FROM "player100" OVER follow YIELD $^.player.name AS startName, $$.player.age AS endAge; +--------------+--------+ | startName | endAge | @@ -69,7 +69,7 @@ nebula> GO FROM "player100" OVER follow YIELD $^.player.name AS startName, $$.pl | "Tim Duncan" | 33 | +--------------+--------+ -# 返回边类型follow的degree属性值。 +# 返回Edge type follow的degree属性值。 nebula> GO FROM "player100" OVER follow YIELD follow.degree; +---------------+ | follow.degree | @@ -79,7 +79,7 @@ nebula> GO FROM "player100" OVER follow YIELD follow.degree; | 90 | +---------------+ -# 返回边类型follow的起始点、目的点、边类型编码和边rank值。 +# 返回Edge type follow的起始点、目的点、Edge type编码和边rank值。 nebula> GO FROM "player100" OVER follow YIELD follow._src, follow._dst, follow._type, follow._rank; +-------------+-------------+--------------+--------------+ | follow._src | follow._dst | follow._type | follow._rank | diff --git a/docs-2.0/3.ngql-guide/6.functions-and-expressions/4.schema.md b/docs-2.0/3.ngql-guide/6.functions-and-expressions/4.schema.md index 456506ba0f3..39f64d7757d 100644 --- a/docs-2.0/3.ngql-guide/6.functions-and-expressions/4.schema.md +++ b/docs-2.0/3.ngql-guide/6.functions-and-expressions/4.schema.md @@ -5,10 +5,10 @@ Nebula Graph支持以下Schema函数。 |函数| 说明 | |:---- | :----| | id(vertex) | 返回点ID。数据类型和点ID的类型保持一致。| -|list tags(vertex) | 返回点的标签。| -|list labels(vertex) | 返回点的标签。| +|list tags(vertex) | 返回点的Tag。| +|list labels(vertex) | 返回点的Tag。| |map properties(vertex_or_edge) | 接收点或边并返回其属性。| -|string type(edge) | 返回边的边类型。| +|string type(edge) | 返回边的Edge type。| |vertex startNode(path) | 获取一条边或一条路径并返回它的起始点ID。| |string endNode(path) | 获取一条边或一条路径并返回它的目的点ID。| |int rank(edge) | 返回边的rank。| diff --git a/docs-2.0/3.ngql-guide/6.functions-and-expressions/6.list.md b/docs-2.0/3.ngql-guide/6.functions-and-expressions/6.list.md index 681b54fb2d0..e93b2eede00 100644 --- a/docs-2.0/3.ngql-guide/6.functions-and-expressions/6.list.md +++ b/docs-2.0/3.ngql-guide/6.functions-and-expressions/6.list.md @@ -5,7 +5,7 @@ Nebula Graph支持以下列表（List）函数。 | 函数| 说明 | |:---- |:---- | | keys(expr) | 返回一个列表，包含字符串形式的点、边或映射的所有属性。 | -| labels(vertex) | 返回点的标签列表。 | +| labels(vertex) | 返回点的Tag列表。 | | nodes(path) | 返回路径中所有点的列表。 | | range(start, end [, step]) | 返回`[start,end]`范围内固定步长的列表，默认步长`step`为1。 | | relationships(path) | 返回路径中所有关系的列表。 | diff --git a/docs-2.0/3.ngql-guide/7.general-query-statements/2.match.md b/docs-2.0/3.ngql-guide/7.general-query-statements/2.match.md index 6c66785c8a5..7f5421c9d88 100644 --- a/docs-2.0/3.ngql-guide/7.general-query-statements/2.match.md +++ b/docs-2.0/3.ngql-guide/7.general-query-statements/2.match.md @@ -16,7 +16,7 @@ MATCH [] RETURN ## MATCH工作流程 -1. `MATCH`语句使用原生索引查找起始点，起始点可以在模式的任何位置。即一个有效的`MATCH`语句，**必须有一个属性、标签或者点已经创建索引，或者在`WHERE`子句中用id()函数指定了特定点的VID**。如何创建索引，请参见[创建原生索引](../14.native-index-statements/1.create-native-index.md)。 +1. `MATCH`语句使用原生索引查找起始点，起始点可以在模式的任何位置。即一个有效的`MATCH`语句，**必须有一个属性、Tag或者点已经创建索引，或者在`WHERE`子句中用id()函数指定了特定点的VID**。如何创建索引，请参见[创建原生索引](../14.native-index-statements/1.create-native-index.md)。 2. `MATCH`语句在模式中搜索，寻找匹配的边或点。 @@ -43,7 +43,7 @@ MATCH [] RETURN 索引会导致写性能大幅降低（降低90%甚至更多）。请**不要随意**在生产环境中使用索引，除非很清楚使用索引对业务的影响。 ```ngql -# 在标签player的name属性和边类型follow上创建索引。 +# 在Tag player的name属性和Edge type follow上创建索引。 nebula> CREATE TAG INDEX name ON player(name(20)); nebula> CREATE EDGE INDEX follow_index on follow(); @@ -95,13 +95,13 @@ nebula> SHOW JOB 122; 用户可以在一对括号中使用自定义变量来表示模式中的点。例如`(v)`。 -### 匹配标签 +### 匹配Tag !!! Note - 标签的索引和属性的索引不同。如果标签的某个属性有索引，但是标签本身没有索引，用户无法基于该标签执行`MATCH`语句。 + Tag的索引和属性的索引不同。如果Tag的某个属性有索引，但是Tag本身没有索引，用户无法基于该Tag执行`MATCH`语句。 -用户可以在点的右侧用`:`表示模式中的标签。 +用户可以在点的右侧用`:`表示模式中的Tag。 ```ngql nebula> MATCH (v:player) RETURN v; @@ -119,7 +119,7 @@ nebula> MATCH (v:player) RETURN v; ### 匹配点的属性 -用户可以在标签的右侧用`{: }`表示模式中点的属性。 +用户可以在Tag的右侧用`{: }`表示模式中点的属性。 ```ngql # 使用属性name搜索匹配的点。 @@ -302,9 +302,9 @@ nebula> MATCH (v:player{name:"Tim Duncan"})-[e]-(v2) \ ... ``` -### 匹配边类型 +### 匹配Edge type -和点一样，用户可以用`:`表示模式中的边类型，例如`-[e:follow]-`。 +和点一样，用户可以用`:`表示模式中的Edge type，例如`-[e:follow]-`。 ```ngql nebula> MATCH ()-[e:follow]-() \ @@ -327,7 +327,7 @@ nebula> MATCH ()-[e:follow]-() \ ### 匹配边的属性 -用户可以用`{: }`表示模式中边类型的属性，例如`[e:follow{likeness:95}]`。 +用户可以用`{: }`表示模式中Edge type的属性，例如`[e:follow{likeness:95}]`。 ```ngql nebula> MATCH (v:player{name:"Tim Duncan"})-[e:follow{degree:95}]->(v2) \ @@ -341,9 +341,9 @@ nebula> MATCH (v:player{name:"Tim Duncan"})-[e:follow{degree:95}]->(v2) \ +--------------------------------------------------------+ ``` -### 匹配多个边类型 +### 匹配多个Edge type -使用`|`可以匹配多个边类型，例如`[e:follow|:serve]`。第一个边类型前的英文冒号（:）不可省略，后续边类型前的英文冒号可以省略，例如`[e:follow|serve]`。 +使用`|`可以匹配多个Edge type，例如`[e:follow|:serve]`。第一个Edge type前的英文冒号（:）不可省略，后续Edge type前的英文冒号可以省略，例如`[e:follow|serve]`。 ```ngql nebula> MATCH (v:player{name:"Tim Duncan"})-[e:follow|:serve]->(v2) \ @@ -473,9 +473,9 @@ nebula> MATCH p=(v:player{name:"Tim Duncan"})-[e:follow*0..3]->(v2:player) \ +-----------------------------------------------------------+-----------+ ``` -### 匹配多个边类型的变长路径 +### 匹配多个Edge type的变长路径 -用户可以在变长或定长模式中指定多个边类型。`hop`、`minHop`和`maxHop`对所有边类型都生效。 +用户可以在变长或定长模式中指定多个Edge type。`hop`、`minHop`和`maxHop`对所有Edge type都生效。 ```ngql nebula> MATCH p=(v:player{name:"Tim Duncan"})-[e:follow|serve*2]->(v2) \ @@ -537,9 +537,9 @@ nebula> MATCH (v:player{name:"Tim Duncan"}) \ +-------------+ ``` -### 检索标签 +### 检索Tag -使用`labels()`函数检索点上的标签列表。 +使用`labels()`函数检索点上的Tag列表。 ```ngql nebula> MATCH (v:player{name:"Tim Duncan"}) \ @@ -607,9 +607,9 @@ nebula> MATCH p=(v:player{name:"Tim Duncan"})-[]->(v2) \ +------------------------------------+ ``` -### 检索边类型 +### 检索Edge type -使用`type()`函数检索匹配的边类型。 +使用`type()`函数检索匹配的Edge type。 ```ngql nebula> MATCH p=(v:player{name:"Tim Duncan"})-[e]->() \ diff --git a/docs-2.0/3.ngql-guide/7.general-query-statements/3.go.md b/docs-2.0/3.ngql-guide/7.general-query-statements/3.go.md index 62c2347a77c..83f76750b17 100644 --- a/docs-2.0/3.ngql-guide/7.general-query-statements/3.go.md +++ b/docs-2.0/3.ngql-guide/7.general-query-statements/3.go.md @@ -42,7 +42,7 @@ OVER [{REVERSELY | BIDIRECT}] - ``：用逗号分隔的点ID列表，或特殊的引用符`$-.id`。详情请参见[管道符](../5.operators/4.pipe.md)。 -- ``：遍历的边类型列表。 +- ``：遍历的Edge type列表。 - `REVERSELY | BIDIRECT`：默认情况下检索的是``的出边，`REVERSELY`表示反向，即检索入边，`BIDIRECT`表示双向，即检索出边和入边。 @@ -50,7 +50,7 @@ OVER [{REVERSELY | BIDIRECT}] !!! Note - 遍历多个边类型时，`WHERE`子句有一些限制。例如不支持`WHERE edge1.prop1 > edge2.prop2`。 + 遍历多个Edge type时，`WHERE`子句有一些限制。例如不支持`WHERE edge1.prop1 > edge2.prop2`。 - `YIELD [DISTINCT] `：指定输出结果。详情请参见[YIELD](../8.clauses-and-options/yield.md)。如果没有指定，默认返回目的点ID。 @@ -108,7 +108,7 @@ nebula> GO FROM "player100", "player102" OVER serve \ ``` ```ngql -# 遍历多个边类型。属性没有值时，会显示__EMPTY__。 +# 遍历多个Edge type。属性没有值时，会显示__EMPTY__。 nebula> GO FROM "player100" OVER follow, serve \ YIELD follow.degree, serve.start_year; +---------------+------------------+ diff --git a/docs-2.0/3.ngql-guide/7.general-query-statements/4.fetch.md b/docs-2.0/3.ngql-guide/7.general-query-statements/4.fetch.md index 107a7330771..0327b97b205 100644 --- a/docs-2.0/3.ngql-guide/7.general-query-statements/4.fetch.md +++ b/docs-2.0/3.ngql-guide/7.general-query-statements/4.fetch.md @@ -18,14 +18,14 @@ FETCH PROP ON {[, tag_name ...] | *} |参数|说明| |:---|:---| -|`tag_name`|标签名称。| -|`*`|表示当前图空间中的所有标签。| +|`tag_name`|Tag名称。| +|`*`|表示当前图空间中的所有Tag。| |`vid`|点ID。| |`output`|指定要返回的信息。详情请参见[`YIELD`](../8.clauses-and-options/yield.md)。如果没有`YIELD`子句，将返回所有匹配的信息。| -### 基于标签获取点的属性值 +### 基于Tag获取点的属性值 -在`FETCH`语句中指定标签获取对应点的属性值。 +在`FETCH`语句中指定Tag获取对应点的属性值。 ```ngql nebula> FETCH PROP ON player "player100"; @@ -67,18 +67,18 @@ nebula> FETCH PROP ON player "player101", "player102", "player103"; +-----------------------------------------------------------+ ``` -### 基于多个标签获取点的属性值 +### 基于多个Tag获取点的属性值 -在`FETCH`语句中指定多个标签获取属性值。标签之间用英文逗号（,）分隔。 +在`FETCH`语句中指定多个Tag获取属性值。Tag之间用英文逗号（,）分隔。 ```ngql -# 创建新标签t1。 +# 创建新Tag t1。 nebula> CREATE TAG t1(a string, b int); -# 为点player100添加标签t1。 +# 为点player100添加Tag t1。 nebula> INSERT VERTEX t1(a, b) VALUE "player100":("Hello", 100); -# 基于标签player和t1获取点player100上的属性值。 +# 基于Tag player和t1获取点player100上的属性值。 nebula> FETCH PROP ON player, t1 "player100"; +----------------------------------------------------------------------------+ | vertices_ | @@ -87,7 +87,7 @@ nebula> FETCH PROP ON player, t1 "player100"; +----------------------------------------------------------------------------+ ``` - 用户可以在`FETCH`语句中组合多个标签和多个点。 + 用户可以在`FETCH`语句中组合多个Tag和多个点。 ```ngql nebula> FETCH PROP ON player, t1 "player100", "player103"; @@ -128,10 +128,10 @@ FETCH PROP ON -> [@] [, -> FETCH PROP ON serve "player100" -> "team204", "player133" -> "team202"; ### 基于rank获取属性值 -如果有多条边，起始点、目的点和边类型都相同，可以通过指定rank获取正确的边属性值。 +如果有多条边，起始点、目的点和Edge type都相同，可以通过指定rank获取正确的边属性值。 ```ngql # 插入不同属性值、不同rank的边。 diff --git a/docs-2.0/3.ngql-guide/7.general-query-statements/5.lookup.md b/docs-2.0/3.ngql-guide/7.general-query-statements/5.lookup.md index b9132a4cc37..9315a45222d 100644 --- a/docs-2.0/3.ngql-guide/7.general-query-statements/5.lookup.md +++ b/docs-2.0/3.ngql-guide/7.general-query-statements/5.lookup.md @@ -4,11 +4,11 @@ - 根据`WHERE`子句搜索特定数据。 -- 通过标签列出点：检索指定标签的所有点ID。 +- 通过Tag列出点：检索指定Tag的所有点ID。 -- 通过边类型列出边：检索指定边类型的所有边的起始点、目的点和rank。 +- 通过Edge type列出边：检索指定Edge type的所有边的起始点、目的点和rank。 -- 统计包含指定标签的点或属于指定边类型的边的数量。 +- 统计包含指定Tag的点或属于指定Edge type的边的数量。 ## OpenCypher兼容性 @@ -36,8 +36,8 @@ LOOKUP ON { | } [WHERE [AND ... - `YIELD `：指定要返回的结果和格式。 - 如果只有`WHERE`子句，没有`YIELD`子句： - - `LOOKUP`标签时，返回点ID。 - - `LOOKUP`边类型时，返回起始点ID、目的点ID和rank。 + - `LOOKUP`Tag时，返回点ID。 + - `LOOKUP`Edge type时，返回起始点ID、目的点ID和rank。 ## WHERE语句限制 @@ -51,7 +51,7 @@ LOOKUP ON { | } [WHERE [AND ... ## 检索点 -返回标签为`player`且`name`为`Tony Parker`的点。 +返回Tag为`player`且`name`为`Tony Parker`的点。 ```ngql nebula> CREATE TAG INDEX index_player ON player(name(30), age); @@ -90,7 +90,7 @@ nebula> LOOKUP ON player WHERE player.name == "Kobe Bryant" YIELD player.name AS ## 检索边 -返回边类型为`follow`且`degree`为`90`的边。 +返回Edge type为`follow`且`degree`为`90`的边。 ```ngql nebula> CREATE EDGE INDEX index_follow ON follow(degree); @@ -140,13 +140,13 @@ nebula> LOOKUP ON follow WHERE follow.degree == 60 YIELD follow.degree AS Degree +-------------+------------------+----------------+--------------+ ``` -## 通过标签列出所有的对应的点/通过边类型列出边 +## 通过Tag列出所有的对应的点/通过Edge type列出边 -如果需要通过标签列出所有的点，或通过边类型列出边，则标签、边类型或属性上必须有至少一个索引。 +如果需要通过Tag列出所有的点，或通过Edge type列出边，则Tag、Edge type或属性上必须有至少一个索引。 -例如一个标签`player`有两个属性`name`和`age`，为了遍历所有包含标签`player`的点ID，标签`player`、属性`name`或属性`age`中必须有一个已经创建索引。 +例如一个Tag`player`有两个属性`name`和`age`，为了遍历所有包含Tag`player`的点ID，Tag`player`、属性`name`或属性`age`中必须有一个已经创建索引。 -- 查找所有标签为`player`的点 VID。 +- 查找所有Tag为`player`的点 VID。 ```ngql nebula> CREATE TAG player(name string,age int); @@ -174,7 +174,7 @@ nebula> LOOKUP ON follow WHERE follow.degree == 60 YIELD follow.degree AS Degree +-------------+ ``` -- 查找边类型为`like`的所有边的信息。 +- 查找Edge type为`like`的所有边的信息。 ```ngql nebula)> CREATE EDGE like(likeness int); @@ -202,7 +202,7 @@ nebula> LOOKUP ON follow WHERE follow.degree == 60 YIELD follow.degree AS Degree ## 统计点或边 -统计标签为`player`的点和边类型为`like`的边。 +统计Tag为`player`的点和Edge type为`like`的边。 ```ngql nebula> LOOKUP ON player | YIELD COUNT(*) AS Player_Number; diff --git a/docs-2.0/3.ngql-guide/7.general-query-statements/6.show/14.show-stats.md b/docs-2.0/3.ngql-guide/7.general-query-statements/6.show/14.show-stats.md index c0f3e4ce222..f5fa3c28b12 100644 --- a/docs-2.0/3.ngql-guide/7.general-query-statements/6.show/14.show-stats.md +++ b/docs-2.0/3.ngql-guide/7.general-query-statements/6.show/14.show-stats.md @@ -6,8 +6,8 @@ - 点的总数 - 边的总数 -- 每个标签关联的点的总数 -- 每个边类型关联的边的总数 +- 每个Tag关联的点的总数 +- 每个Edge type关联的边的总数 ## 前提条件 diff --git a/docs-2.0/3.ngql-guide/7.general-query-statements/6.show/15.show-tags-edges.md b/docs-2.0/3.ngql-guide/7.general-query-statements/6.show/15.show-tags-edges.md index 5974445b13c..d522a9fe763 100644 --- a/docs-2.0/3.ngql-guide/7.general-query-statements/6.show/15.show-tags-edges.md +++ b/docs-2.0/3.ngql-guide/7.general-query-statements/6.show/15.show-tags-edges.md @@ -1,8 +1,8 @@ # SHOW TAGS/EDGES -`SHOW TAGS`语句显示当前图空间内的所有标签。 +`SHOW TAGS`语句显示当前图空间内的所有Tag。 -`SHOW EDGES`语句显示当前图空间内的所有边类型。 +`SHOW EDGES`语句显示当前图空间内的所有Edge type。 ## 语法 diff --git a/docs-2.0/3.ngql-guide/7.general-query-statements/6.show/5.show-create-tags-edges.md b/docs-2.0/3.ngql-guide/7.general-query-statements/6.show/5.show-create-tags-edges.md index 59c60fe9eb0..92fd0bc9f3b 100644 --- a/docs-2.0/3.ngql-guide/7.general-query-statements/6.show/5.show-create-tags-edges.md +++ b/docs-2.0/3.ngql-guide/7.general-query-statements/6.show/5.show-create-tags-edges.md @@ -1,8 +1,8 @@ # SHOW CREATE TAG/EDGE -`SHOW CREATE TAG`语句显示指定标签的基本信息。标签的更多详细信息，请参见[CREATE TAG](../../10.tag-statements/1.create-tag.md)。 +`SHOW CREATE TAG`语句显示指定Tag的基本信息。Tag的更多详细信息，请参见[CREATE TAG](../../10.tag-statements/1.create-tag.md)。 -`SHOW CREATE EDGE`语句显示指定边类型的基本信息。边类型的更多详细信息，请参见[CREATE EDGE](../../11.edge-type-statements/1.create-edge.md)。 +`SHOW CREATE EDGE`语句显示指定Edge type的基本信息。Edge type的更多详细信息，请参见[CREATE EDGE](../../11.edge-type-statements/1.create-edge.md)。 ## 语法 diff --git a/docs-2.0/3.ngql-guide/8.clauses-and-options/ttl-options.md b/docs-2.0/3.ngql-guide/8.clauses-and-options/ttl-options.md index 2580b488738..beaf6321388 100644 --- a/docs-2.0/3.ngql-guide/8.clauses-and-options/ttl-options.md +++ b/docs-2.0/3.ngql-guide/8.clauses-and-options/ttl-options.md @@ -10,7 +10,7 @@ TTL（Time To Live）指定属性的存活时间，超时后，该属性就会 - 不能修改带有TTL选项的属性的Schema。 -- 标签或边类型上如果有索引，不能设置TTL选项，即使在没有索引的属性上设置也不行。 +- Tag或Edge type上如果有索引，不能设置TTL选项，即使在没有索引的属性上设置也不行。 ## 属性过期 @@ -18,13 +18,13 @@ TTL（Time To Live）指定属性的存活时间，超时后，该属性就会 点属性过期有如下影响： -- 如果一个点仅有一个标签，点上的一个属性过期，点也会过期。 +- 如果一个点仅有一个Tag，点上的一个属性过期，点也会过期。 -- 如果一个点有多个标签，点上的一个属性过期，和该属性相同标签的其他属性也会过期，但是点不会过期，点上其他标签的属性保持不变。 +- 如果一个点有多个Tag，点上的一个属性过期，和该属性相同Tag的其他属性也会过期，但是点不会过期，点上其他Tag的属性保持不变。 ### 边属性过期 -因为一条边仅有一个边类型，边上的一个属性过期，边也会过期。 +因为一条边仅有一个Edge type，边上的一个属性过期，边也会过期。 ## 过期处理 @@ -47,27 +47,27 @@ nGQL支持的TTL选项如下。 ## 使用TTl选项 -### 标签或边类型已存在 +### Tag或Edge type已存在 -如果标签和边类型已经创建，请使用`ALTER`语句更新标签或边类型。 +如果Tag和Edge type已经创建，请使用`ALTER`语句更新Tag或Edge type。 ```ngql -# 创建标签。 +# 创建Tag。 nebula> CREATE TAG t1 (a timestamp); -# ALTER修改标签，添加TTL选项。 +# ALTER修改Tag，添加TTL选项。 nebula> ALTER TAG t1 ttl_col = "a", ttl_duration = 5; # 插入点，插入后5秒过期。 nebula> INSERT VERTEX t1(a) values "101":(now()); ``` -### 标签或边类型不存在 +### Tag或Edge type不存在 -创建标签或边类型时可以同时设置TTL选项。详情请参见[CREATE TAG](../10.tag-statements/1.create-tag.md)和[CREATE EDGE](../11.edge-type-statements/1.create-edge.md)。 +创建Tag或Edge type时可以同时设置TTL选项。详情请参见[CREATE TAG](../10.tag-statements/1.create-tag.md)和[CREATE EDGE](../11.edge-type-statements/1.create-edge.md)。 ```ngql -# 创建标签并设置TTL选项。 +# 创建Tag并设置TTL选项。 nebula> CREATE TAG t2(a int, b int, c string) ttl_duration= 100, ttl_col = "a"; # 插入点。过期时间戳为1612778164774（1612778164674 + 100）。 diff --git a/docs-2.0/3.ngql-guide/8.clauses-and-options/with.md b/docs-2.0/3.ngql-guide/8.clauses-and-options/with.md index e7c9c3d4dc0..8b152758b30 100644 --- a/docs-2.0/3.ngql-guide/8.clauses-and-options/with.md +++ b/docs-2.0/3.ngql-guide/8.clauses-and-options/with.md @@ -58,7 +58,7 @@ nebula> MATCH p=(v:player{name:"Tim Duncan"})--() \ ### 示例2 1. 匹配点ID为`player100`的点。 -2. 通过`labels()`函数将点的所有标签输出到一个列表。 +2. 通过`labels()`函数将点的所有Tag输出到一个列表。 3. 将列表拆分为行。 4. 返回结果。 diff --git a/docs-2.0/4.deployment-and-installation/6.deploy-text-based-index/1.text-based-index-restrictions.md b/docs-2.0/4.deployment-and-installation/6.deploy-text-based-index/1.text-based-index-restrictions.md index 52800f1767a..caafd4999ac 100644 --- a/docs-2.0/4.deployment-and-installation/6.deploy-text-based-index/1.text-based-index-restrictions.md +++ b/docs-2.0/4.deployment-and-installation/6.deploy-text-based-index/1.text-based-index-restrictions.md @@ -8,13 +8,13 @@ - 定长字符串长度超过256字节，将无法创建全文索引。 -- 如果标签上存在全文索引，无法删除或修改标签。 +- 如果Tag上存在全文索引，无法删除或修改Tag。 - 不能同时为多个属性创建全文索引。 - 全文搜索语句`LOOKUP`/`MATCH`中的`WHERE`子句不支持逻辑运算`AND`和`OR`。 -- 全文索引不支持多个标签的搜索。 +- 全文索引不支持多个Tag的搜索。 - 不支持排序全文搜索的返回结果，而是按照数据插入的顺序返回。 diff --git a/docs-2.0/5.configurations-and-logs/1.configurations/4.storage-config.md b/docs-2.0/5.configurations-and-logs/1.configurations/4.storage-config.md index e8a81e96d85..7f98f912d61 100644 --- a/docs-2.0/5.configurations-and-logs/1.configurations/4.storage-config.md +++ b/docs-2.0/5.configurations-and-logs/1.configurations/4.storage-config.md @@ -86,7 +86,7 @@ Storage服务提供了两份初始配置文件`nebula-storaged.conf.default`和` |`rocksdb_stats_level` | `kExceptHistogramOrTimers` | RocksDB的数据统计级别。可选值为`kExceptHistogramOrTimers`（禁用计时器统计，跳过柱状图统计）、`kExceptTimers`（跳过计时器统计）、`kExceptDetailedTimers`（收集除互斥锁和压缩花费时间之外的所有统计数据）、`kExceptTimeForMutex`收集除互斥锁花费时间之外的所有统计数据）和`kAll`（收集所有统计数据）。 | |`enable_rocksdb_prefix_filtering` | `false` | 是否启用prefix bloom filter (内存充裕时可以打开，提升图遍历速度)。 | |`enable_rocksdb_whole_key_filtering` | `true` | 是否启用whole key bloom filter。 | -|`rocksdb_filtering_prefix_length` | `12` | 每个key的prefix长度。可选值为`12`（分片ID+点ID）和`16`（分片ID+点ID+标签ID/边类型ID）。单位：字节。 | +|`rocksdb_filtering_prefix_length` | `12` | 每个key的prefix长度。可选值为`12`（分片ID+点ID）和`16`（分片ID+点ID+TagID/Edge typeID）。单位：字节。 | |`enable_partitioned_index_filter`|- |设置为`true`可以降低bloom过滤器占用的内存大小，但是在某些随机寻道（random-seek）的情况下，可能会降低读取性能。| ## rocksdb options配置 diff --git a/docs-2.0/8.service-tuning/2.graph-modeling.md b/docs-2.0/8.service-tuning/2.graph-modeling.md index 8e24a597974..fd6c5029aa8 100644 --- a/docs-2.0/8.service-tuning/2.graph-modeling.md +++ b/docs-2.0/8.service-tuning/2.graph-modeling.md @@ -34,7 +34,7 @@ Nebula Graph {{ nebula.release }} 是强 schema 的系统，这意味着业务 ### 广度优先大于深度优先 -- Nebula Graph 基于图拓扑结构进行深度图遍历的性能较低，广度优先遍历以及获取属性的性能较好。例如，模型a包括姓名、年龄、眼睛颜色三种属性，建议创建一个标签`person`，然后为它添加姓名、年龄、眼睛颜色的属性。如果创建一个包含眼睛颜色的标签和一个边类型`has`，然后创建一个边用来表示人拥有的眼睛颜色，这种建模方法会降低遍历性能。 +- Nebula Graph 基于图拓扑结构进行深度图遍历的性能较低，广度优先遍历以及获取属性的性能较好。例如，模型a包括姓名、年龄、眼睛颜色三种属性，建议创建一个Tag`person`，然后为它添加姓名、年龄、眼睛颜色的属性。如果创建一个包含眼睛颜色的Tag和一个Edge type`has`，然后创建一个边用来表示人拥有的眼睛颜色，这种建模方法会降低遍历性能。 - “通过边属性获取边”的性能与“通过点属性获取点”的性能是接近的。在一些数据库中，会建议将边上的属性重新建模为中间节点的属性：例如 `(src)-[edge {P1, P2}]->(dst)`，`edge` 上有属性 `P1, P2`，会建议建模为 `(src)-[edge1]->(i_node {P1, P2})-[edge2]->(dst)`。在 Nebula Graph {{ nebula.release }} 中可以直接使用 `(src)-[edge {P1, P2}]->(dst)`，减少遍历深度有助于性能。 @@ -50,9 +50,9 @@ Nebula Graph {{ nebula.release }} 是强 schema 的系统，这意味着业务 因此，通常同一条边没有必要反向再冗余插入一次。 -### 合理设置标签属性 +### 合理设置Tag属性 -在图建模中，请将一组类似的平级属性放入同一个标签，即按不同概念进行分组。 +在图建模中，请将一组类似的平级属性放入同一个Tag，即按不同概念进行分组。 ### 正确使用索引 diff --git a/docs-2.0/8.service-tuning/super-node.md b/docs-2.0/8.service-tuning/super-node.md index 3d5c0c14a12..c07551331d4 100644 --- a/docs-2.0/8.service-tuning/super-node.md +++ b/docs-2.0/8.service-tuning/super-node.md @@ -44,7 +44,7 @@ Nebula Graph {{ nebula.release }} 属性索引的设计复用了存储模块 Roc 例如，`(机场)<-[depart]-(航班)`场景，每个架次航班的离港，都建模为一条航班和机场之间的边。那么大型机场的离港航班会极多。 -根据不同的`航空公司`将 `depart` 这个边类型拆分更细的边类型，如 `depart_ceair`, `depart_csair` 等。在查询（图遍历）时，指定离港的航空公司。 +根据不同的`航空公司`将 `depart` 这个Edge type拆分更细的Edge type，如 `depart_ceair`, `depart_csair` 等。在查询（图遍历）时，指定离港的航空公司。 - 切分顶点本身 diff --git a/docs-2.0/nebula-algorithm.md b/docs-2.0/nebula-algorithm.md index f4c87ca4e2c..0548f1cf59b 100644 --- a/docs-2.0/nebula-algorithm.md +++ b/docs-2.0/nebula-algorithm.md @@ -105,7 +105,7 @@ Nebula Algorithm实现图计算的流程如下： ### 直接提交算法包 !!! note - 使用封装好的算法包有一定的局限性，例如落库到Nebula Graph时，落库的图空间中创建的标签的属性名称必须和代码内预设的名称保持一致。如果用户有开发能力，推荐使用第一种方法。 + 使用封装好的算法包有一定的局限性，例如落库到Nebula Graph时，落库的图空间中创建的Tag的属性名称必须和代码内预设的名称保持一致。如果用户有开发能力，推荐使用第一种方法。 1. 设置[配置文件](https://github.com/vesoft-inc/nebula-spark-utils/blob/master/nebula-algorithm/src/main/resources/application.conf)。 @@ -140,9 +140,9 @@ Nebula Algorithm实现图计算的流程如下： metaAddress: "192.168.*.10:9559" # Nebula Graph图空间名称 space: basketballplayer - # Nebula Graph边类型, 多个labels时，多个边的数据将合并。 + # Nebula Graph Edge type, 多个labels时，多个边的数据将合并。 labels: ["serve"] - # Nebula Graph每个边类型的属性名称，此属性将作为算法的权重列，请确保和边类型对应。 + # Nebula Graph每个Edge type的属性名称，此属性将作为算法的权重列，请确保和Edge type对应。 weightCols: ["start_year"] } @@ -158,10 +158,10 @@ Nebula Algorithm实现图计算的流程如下： metaAddress: "192.168.*.12:9559" user:root pswd:nebula - # 在提交图计算任务之前需要自行创建图空间及标签 + # 在提交图计算任务之前需要自行创建图空间及Tag # Nebula Graph图空间名称 space:nb - # Nebula Graph标签名称，图计算结果会写入该标签。标签中的属性名称固定如下： + # Nebula Graph Tag名称，图计算结果会写入该Tag。Tag中的属性名称固定如下： # PageRank：pagerank # Louvain：louvain # ConnectedComponent：cc diff --git a/docs-2.0/nebula-exchange/about-exchange/ex-ug-what-is-exchange.md b/docs-2.0/nebula-exchange/about-exchange/ex-ug-what-is-exchange.md index 938dd8639b7..2e15802b21c 100644 --- a/docs-2.0/nebula-exchange/about-exchange/ex-ug-what-is-exchange.md +++ b/docs-2.0/nebula-exchange/about-exchange/ex-ug-what-is-exchange.md @@ -32,7 +32,7 @@ Exchange具有以下优点： - 异步操作：会在源数据中生成一条插入语句，发送给Graph服务，最后再执行插入操作。 -- 灵活性强：支持同时导入多个标签和边类型，不同标签和边类型可以是不同的数据来源或格式。 +- 灵活性强：支持同时导入多个Tag和Edge type，不同Tag和Edge type可以是不同的数据来源或格式。 - 统计功能：使用Apache Spark™中的累加器统计插入操作的成功和失败次数。 diff --git a/docs-2.0/nebula-exchange/parameter-reference/ex-ug-parameter.md b/docs-2.0/nebula-exchange/parameter-reference/ex-ug-parameter.md index 7028781425d..2c34ccf898c 100644 --- a/docs-2.0/nebula-exchange/parameter-reference/ex-ug-parameter.md +++ b/docs-2.0/nebula-exchange/parameter-reference/ex-ug-parameter.md @@ -68,7 +68,7 @@ |参数|数据类型|默认值|是否必须|说明| |:---|:---|:---|:---|:---| -|`tags.name`|string|-|是|Nebula Graph中定义的标签名称。| +|`tags.name`|string|-|是|Nebula Graph中定义的Tag名称。| |`tags.type.source`|string|-|是|指定数据源。例如`csv`。| |`tags.type.sink`|string|`client`|是|指定导入方式，可选值为`client`和`SST`（不支持）。| |`tags.fields`|list\[string\]|-|是|属性对应的列的表头或列名。如果有表头或列名，请直接使用该名称。如果CSV文件没有表头，用`[_c0, _c1, _c2]`的形式表示第一列、第二列、第三列，以此类推。| @@ -156,7 +156,7 @@ |参数|数据类型|默认值|是否必须|说明| |:---|:---|:---|:---|:---| -|`edges.name`| string|-|是|Nebula Graph中定义的边类型名称。| +|`edges.name`| string|-|是|Nebula Graph中定义的Edge type名称。| |`edges.type.source`|string|-|是|指定数据源。例如`csv`。| |`edges.type.sink`|string|`client`|是|指定导入方式，可选值为`client`和`SST`（不支持）。| |`edges.fields`|list\[string\]|-|是|属性对应的列的表头或列名。如果有表头或列名，请直接使用该名称。如果CSV文件没有表头，用`[_c0, _c1, _c2]`的形式表示第一列、第二列、第三列，以此类推。| diff --git a/docs-2.0/nebula-exchange/use-exchange/.ex-ug-import-from-sst.md b/docs-2.0/nebula-exchange/use-exchange/.ex-ug-import-from-sst.md index f210fd9be12..1d404b8a230 100644 --- a/docs-2.0/nebula-exchange/use-exchange/.ex-ug-import-from-sst.md +++ b/docs-2.0/nebula-exchange/use-exchange/.ex-ug-import-from-sst.md @@ -16,8 +16,8 @@ RocksDB 提供了一系列 API 用于创建及导入 SST 文件，有助于快 2. sstProcessor 按照 Nebula Graph 要求的格式生成 SST 文件，存储到本地，并上传到 HDFS。SST 文件主要包含点和边两类数据，其中， - - 表示点的键包括：分区信息、点 ID（VID）、标签类型信息和标签版本信息。 - - 表示边的键包括：分区信息、起点和终点 ID（`rsc_vid` 和 `dst_vid`）、边类型信息、边排序信息和边版本信息。 + - 表示点的键包括：分区信息、点 ID（VID）、Tag类型信息和Tag版本信息。 + - 表示边的键包括：分区信息、起点和终点 ID（`rsc_vid` 和 `dst_vid`）、Edge type信息、边排序信息和边版本信息。 - 对应的值主要包含各个属性键值对序列化信息。 3. SstFileWriter 创建 SST 文件：Exchange 会创建一个 SstFileWriter 对象，然后打开一个文件并插入数据。生成 SST 文件时，行数据必须严格按照增序进行写入。 @@ -43,7 +43,7 @@ RocksDB 提供了一系列 API 用于创建及导入 SST 文件，有助于快 - 环境里必须部署 HDFS。 - 在配置文件中，必须做以下修改： - - 源数据的标签和边类型配置：`tags.type.sink` 和 `edges.type.sink` 必须配置为 `sst`。 + - 源数据的Tag和Edge type配置：`tags.type.sink` 和 `edges.type.sink` 必须配置为 `sst`。 - Nebula Graph 相关配置里，需要添加 Nebula Graph 数据库 Meta 服务的 IP 地址和端口，并添加 SST 文件在本地和 HDFS 的存储路径。 ```conf diff --git a/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-csv.md b/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-csv.md index 6954b61b723..a5181075853 100644 --- a/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-csv.md +++ b/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-csv.md @@ -36,7 +36,7 @@ - 已经安装Spark。 -- 了解Nebula Graph中创建Schema的信息，包括标签和边类型的名称、属性等。 +- 了解Nebula Graph中创建Schema的信息，包括Tag和Edge type的名称、属性等。 - 如果文件存储在HDFS上，需要确认Hadoop服务运行正常。 @@ -52,10 +52,10 @@ | 要素 | 名称 | 属性 | | :--- | :--- | :--- | - | 标签（Tag） | `player` | `name string, age int` | - | 标签（Tag） | `team` | `name string` | - | 边类型（Edge Type） | `follow` | `degree int` | - | 边类型（Edge Type） | `serve` | `start_year int, end_year int` | + | Tag | `player` | `name string, age int` | + | Tag | `team` | `name string` | + | Edge Type | `follow` | `degree int` | + | Edge Type | `serve` | `start_year int, end_year int` | 2. 使用Nebula Console创建一个图空间**basketballplayer**，并创建一个Schema，如下所示。 @@ -69,16 +69,16 @@ ## 选择图空间basketballplayer nebula> USE basketballplayer; - ## 创建标签player + ## 创建Tag player nebula> CREATE TAG player(name string, age int); - ## 创建标签team + ## 创建Tag team nebula> CREATE TAG team(name string); - ## 创建边类型follow + ## 创建Edge type follow nebula> CREATE EDGE follow(degree int); - ## 创建边类型serve + ## 创建Edge type serve nebula> CREATE EDGE serve(start_year int, end_year int); ``` @@ -155,9 +155,9 @@ # 处理点 tags: [ - # 设置标签player相关信息。 + # 设置Tag player相关信息。 { - # 指定Nebula Graph中定义的标签名称。 + # 指定Nebula Graph中定义的Tag名称。 name: player type: { # 指定数据源，使用CSV。 @@ -203,9 +203,9 @@ partition: 32 } - # 设置标签team相关信息。 + # 设置Tag team相关信息。 { - # 指定Nebula Graph中定义的标签名称。 + # 指定Nebula Graph中定义的Tag名称。 name: team type: { # 指定数据源，使用CSV。 @@ -256,9 +256,9 @@ ] # 处理边 edges: [ - # 设置边类型follow相关信息。 + # 设置Edge type follow相关信息。 { - # 指定Nebula Graph中定义的边类型名称。 + # 指定Nebula Graph中定义的Edge type名称。 name: follow type: { # 指定数据源，使用CSV。 @@ -310,9 +310,9 @@ partition: 32 } - # 设置边类型serve相关信息。 + # 设置Edge type serve相关信息。 { - # 指定Nebula Graph中定义的边类型名称。 + # 指定Nebula Graph中定义的Edge type名称。 name: serve type: { # 指定数据源，使用CSV。 diff --git a/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-hbase.md b/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-hbase.md index 354fff6dbea..734b552b1a6 100644 --- a/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-hbase.md +++ b/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-hbase.md @@ -73,7 +73,7 @@ ROW COLUMN+CELL - 已经安装Spark。 -- 了解Nebula Graph中创建Schema的信息，包括标签和边类型的名称、属性等。 +- 了解Nebula Graph中创建Schema的信息，包括Tag和Edge type的名称、属性等。 - 已经安装并开启Hadoop服务。 @@ -87,10 +87,10 @@ ROW COLUMN+CELL | 要素 | 名称 | 属性 | | :--- | :--- | :--- | - | 标签（Tag） | `player` | `name string, age int` | - | 标签（Tag） | `team` | `name string` | - | 边类型（Edge Type） | `follow` | `degree int` | - | 边类型（Edge Type） | `serve` | `start_year int, end_year int` | + | Tag | `player` | `name string, age int` | + | Tag | `team` | `name string` | + | Edge Type | `follow` | `degree int` | + | Edge Type | `serve` | `start_year int, end_year int` | 2. 在Nebula Graph中创建一个图空间**basketballplayer**，并创建一个Schema，如下所示。 @@ -104,16 +104,16 @@ ROW COLUMN+CELL ## 选择图空间basketballplayer nebula> USE basketballplayer; - ## 创建标签player + ## 创建Tag player nebula> CREATE TAG player(name string, age int); - ## 创建标签team + ## 创建Tag team nebula> CREATE TAG team(name string); - ## 创建边类型follow + ## 创建Edge type follow nebula> CREATE EDGE follow(degree int); - ## 创建边类型serve + ## 创建Edge type serve nebula> CREATE EDGE serve(start_year int, end_year int); ``` @@ -172,10 +172,10 @@ ROW COLUMN+CELL } # 处理点 tags: [ - # 设置标签player相关信息。 + # 设置Tag player相关信息。 # 如果需要将rowkey设置为数据源，请填写“rowkey”,列族内的列请填写实际列名。 { - # Nebula Graph中对应的标签名称。 + # Nebula Graph中对应的Tag名称。 name: player type: { # 指定数据源文件格式，设置为HBase。 @@ -207,7 +207,7 @@ ROW COLUMN+CELL # Spark 分区数量 partition: 32 } - # 设置标签team相关信息。 + # 设置Tag team相关信息。 { name: team type: { @@ -231,9 +231,9 @@ ROW COLUMN+CELL # 处理边数据 edges: [ - # 设置边类型follow相关信息 + # 设置Edge type follow相关信息 { - # Nebula Graph中对应的边类型名称。 + # Nebula Graph中对应的Edge type名称。 name: follow type: { @@ -275,7 +275,7 @@ ROW COLUMN+CELL partition: 32 } - # 设置边类型serve相关信息 + # 设置Edge type serve相关信息 { name: serve type: { diff --git a/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-hive.md b/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-hive.md index b019a6adc47..f2439934f49 100644 --- a/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-hive.md +++ b/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-hive.md @@ -78,7 +78,7 @@ scala> spark.sql("describe basketball.serve").show - 已经安装Spark。 -- 了解Nebula Graph中创建Schema的信息，包括标签和边类型的名称、属性等。 +- 了解Nebula Graph中创建Schema的信息，包括Tag和Edge type的名称、属性等。 - 已经安装并开启Hadoop服务，并已启动Hive Metastore数据库（本示例中为 MySQL）。 @@ -92,10 +92,10 @@ scala> spark.sql("describe basketball.serve").show | 要素 | 名称 | 属性 | | :--- | :--- | :--- | - | 标签（Tag） | `player` | `name string, age int` | - | 标签（Tag） | `team` | `name string` | - | 边类型（Edge Type） | `follow` | `degree int` | - | 边类型（Edge Type） | `serve` | `start_year int, end_year int` | + | Tag | `player` | `name string, age int` | + | Tag | `team` | `name string` | + | Edge Type | `follow` | `degree int` | + | Edge Type | `serve` | `start_year int, end_year int` | 2. 在Nebula Graph中创建一个图空间**basketballplayer**，并创建一个Schema，如下所示。 @@ -109,16 +109,16 @@ scala> spark.sql("describe basketball.serve").show ## 选择图空间basketballplayer nebula> USE basketballplayer; - ## 创建标签player + ## 创建Tag player nebula> CREATE TAG player(name string, age int); - ## 创建标签team + ## 创建Tag team nebula> CREATE TAG team(name string); - ## 创建边类型follow + ## 创建Edge type follow nebula> CREATE EDGE follow(degree int); - ## 创建边类型serve + ## 创建Edge type serve nebula> CREATE EDGE serve(start_year int, end_year int); ``` @@ -211,9 +211,9 @@ scala> sql("select playerid, teamid, start_year, end_year from basketball.serve" } # 处理点 tags: [ - # 设置标签player相关信息。 + # 设置Tag player相关信息。 { - # Nebula Graph中对应的标签名称。 + # Nebula Graph中对应的Tag名称。 name: player type: { # 指定数据源文件格式，设置为hive。 @@ -243,7 +243,7 @@ scala> sql("select playerid, teamid, start_year, end_year from basketball.serve" # Spark 分区数量 partition: 32 } - # 设置标签team相关信息。 + # 设置Tag team相关信息。 { name: team type: { @@ -264,9 +264,9 @@ scala> sql("select playerid, teamid, start_year, end_year from basketball.serve" # 处理边数据 edges: [ - # 设置边类型follow相关信息 + # 设置Edge type follow相关信息 { - # Nebula Graph中对应的边类型名称。 + # Nebula Graph中对应的Edge type名称。 name: follow type: { @@ -304,7 +304,7 @@ scala> sql("select playerid, teamid, start_year, end_year from basketball.serve" partition: 32 } - # 设置边类型serve相关信息 + # 设置Edge type serve相关信息 { name: serve type: { diff --git a/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-json.md b/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-json.md index 1421314236d..e30ddf1d1fc 100644 --- a/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-json.md +++ b/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-json.md @@ -68,7 +68,7 @@ - 已经安装Spark。 -- 了解Nebula Graph中创建Schema的信息，包括标签和边类型的名称、属性等。 +- 了解Nebula Graph中创建Schema的信息，包括Tag和Edge type的名称、属性等。 - 如果文件存储在HDFS上，需要确认Hadoop服务运行正常。 @@ -84,10 +84,10 @@ | 要素 | 名称 | 属性 | | :--- | :--- | :--- | - | 标签（Tag） | `player` | `name string, age int` | - | 标签（Tag） | `team` | `name string` | - | 边类型（Edge Type） | `follow` | `degree int` | - | 边类型（Edge Type） | `serve` | `start_year int, end_year int` | + | Tag | `player` | `name string, age int` | + | Tag | `team` | `name string` | + | Edge Type | `follow` | `degree int` | + | Edge Type | `serve` | `start_year int, end_year int` | 2. 使用Nebula Console创建一个图空间**basketballplayer**，并创建一个Schema，如下所示。 @@ -101,16 +101,16 @@ ## 选择图空间basketballplayer nebula> USE basketballplayer; - ## 创建标签player + ## 创建Tag player nebula> CREATE TAG player(name string, age int); - ## 创建标签team + ## 创建Tag team nebula> CREATE TAG team(name string); - ## 创建边类型follow + ## 创建Edge type follow nebula> CREATE EDGE follow(degree int); - ## 创建边类型serve + ## 创建Edge type serve nebula> CREATE EDGE serve(start_year int, end_year int); ``` @@ -183,9 +183,9 @@ # 处理点 tags: [ - # 设置标签player相关信息。 + # 设置Tag player相关信息。 { - # 指定Nebula Graph中定义的标签名称。 + # 指定Nebula Graph中定义的Tag名称。 name: player type: { # 指定数据源，使用JSON。 @@ -223,9 +223,9 @@ partition: 32 } - # 设置标签team相关信息。 + # 设置Tag team相关信息。 { - # 指定Nebula Graph中定义的标签名称。 + # 指定Nebula Graph中定义的Tag名称。 name: team type: { # 指定数据源，使用JSON。 @@ -269,9 +269,9 @@ ] # 处理边 edges: [ - # 设置边类型follow相关信息。 + # 设置Edge type follow相关信息。 { - # 指定Nebula Graph中定义的边类型名称。 + # 指定Nebula Graph中定义的Edge type名称。 name: follow type: { # 指定数据源，使用JSON。 @@ -316,9 +316,9 @@ partition: 32 } - # 设置边类型serve相关信息。 + # 设置Edge type serve相关信息。 { - # 指定Nebula Graph中定义的边类型名称。 + # 指定Nebula Graph中定义的Edge type名称。 name: serve type: { # 指定数据源，使用JSON。 diff --git a/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-kafka.md b/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-kafka.md index 0019162b65b..5cf35342fc6 100644 --- a/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-kafka.md +++ b/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-kafka.md @@ -28,7 +28,7 @@ - 已经安装Spark。 -- 了解Nebula Graph中创建Schema的信息，包括标签和边类型的名称、属性等。 +- 了解Nebula Graph中创建Schema的信息，包括Tag和Edge type的名称、属性等。 - 已经安装并开启Kafka服务。 @@ -42,10 +42,10 @@ | 要素 | 名称 | 属性 | | :--- | :--- | :--- | - | 标签（Tag） | `player` | `name string, age int` | - | 标签（Tag） | `team` | `name string` | - | 边类型（Edge Type） | `follow` | `degree int` | - | 边类型（Edge Type） | `serve` | `start_year int, end_year int` | + | Tag | `player` | `name string, age int` | + | Tag | `team` | `name string` | + | Edge Type | `follow` | `degree int` | + | Edge Type | `serve` | `start_year int, end_year int` | 2. 在Nebula Graph中创建一个图空间**basketballplayer**，并创建一个Schema，如下所示。 @@ -59,16 +59,16 @@ ## 选择图空间basketballplayer nebula> USE basketballplayer; - ## 创建标签player + ## 创建Tag player nebula> CREATE TAG player(name string, age int); - ## 创建标签team + ## 创建Tag team nebula> CREATE TAG team(name string); - ## 创建边类型follow + ## 创建Edge type follow nebula> CREATE EDGE follow(degree int); - ## 创建边类型serve + ## 创建Edge type serve nebula> CREATE EDGE serve(start_year int, end_year int); ``` @@ -127,9 +127,9 @@ } # 处理点 tags: [ - # 设置标签player相关信息。 + # 设置Tag player相关信息。 { - # Nebula Graph中对应的标签名称。 + # Nebula Graph中对应的Tag名称。 name: player type: { # 指定数据源文件格式，设置为Kafka。 @@ -162,7 +162,7 @@ # 读取消息的间隔。单位：秒。 interval.seconds: 10 } - # 设置标签team相关信息。 + # 设置Tag team相关信息。 { name: team type: { @@ -185,9 +185,9 @@ # 处理边数据 edges: [ - # 设置边类型follow相关信息 + # 设置Edge type follow相关信息 { - # Nebula Graph中对应的边类型名称。 + # Nebula Graph中对应的Edge type名称。 name: follow type: { @@ -232,7 +232,7 @@ interval.seconds: 10 } - # 设置边类型serve相关信息 + # 设置Edge type serve相关信息 { name: serve type: { diff --git a/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-mysql.md b/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-mysql.md index 8925b56aa34..39767f8950c 100644 --- a/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-mysql.md +++ b/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-mysql.md @@ -76,7 +76,7 @@ mysql> desc serve; - 已经安装Spark。 -- 了解Nebula Graph中创建Schema的信息，包括标签和边类型的名称、属性等。 +- 了解Nebula Graph中创建Schema的信息，包括Tag和Edge type的名称、属性等。 - 已经安装并开启Hadoop服务。 @@ -90,10 +90,10 @@ mysql> desc serve; | 要素 | 名称 | 属性 | | :--- | :--- | :--- | - | 标签（Tag） | `player` | `name string, age int` | - | 标签（Tag） | `team` | `name string` | - | 边类型（Edge Type） | `follow` | `degree int` | - | 边类型（Edge Type） | `serve` | `start_year int, end_year int` | + | Tag | `player` | `name string, age int` | + | Tag | `team` | `name string` | + | Edge Type | `follow` | `degree int` | + | Edge Type | `serve` | `start_year int, end_year int` | 2. 在Nebula Graph中创建一个图空间**basketballplayer**，并创建一个Schema，如下所示。 @@ -107,16 +107,16 @@ mysql> desc serve; ## 选择图空间basketballplayer nebula> USE basketballplayer; - ## 创建标签player + ## 创建Tag player nebula> CREATE TAG player(name string, age int); - ## 创建标签team + ## 创建Tag team nebula> CREATE TAG team(name string); - ## 创建边类型follow + ## 创建Edge type follow nebula> CREATE EDGE follow(degree int); - ## 创建边类型serve + ## 创建Edge type serve nebula> CREATE EDGE serve(start_year int, end_year int); ``` @@ -174,9 +174,9 @@ mysql> desc serve; } # 处理点 tags: [ - # 设置标签player相关信息。 + # 设置Tag player相关信息。 { - # Nebula Graph中对应的标签名称。 + # Nebula Graph中对应的Tag名称。 name: player type: { # 指定数据源文件格式，设置为MySQL。 @@ -211,7 +211,7 @@ mysql> desc serve; # Spark 分区数量 partition: 32 } - # 设置标签team相关信息。 + # 设置Tag team相关信息。 { name: team type: { @@ -240,9 +240,9 @@ mysql> desc serve; # 处理边数据 edges: [ - # 设置边类型follow相关信息 + # 设置Edge type follow相关信息 { - # Nebula Graph中对应的边类型名称。 + # Nebula Graph中对应的Edge type名称。 name: follow type: { @@ -285,7 +285,7 @@ mysql> desc serve; partition: 32 } - # 设置边类型serve相关信息 + # 设置Edge type serve相关信息 { name: serve type: { diff --git a/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-neo4j.md b/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-neo4j.md index 5f026279689..445b82a1f93 100644 --- a/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-neo4j.md +++ b/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-neo4j.md @@ -57,7 +57,7 @@ Exchange读取Neo4j数据时需要完成以下工作： - 已经安装Spark。 -- 了解Nebula Graph中创建Schema的信息，包括标签和边类型的名称、属性等。 +- 了解Nebula Graph中创建Schema的信息，包括Tag和Edge type的名称、属性等。 ## 操作步骤 @@ -69,10 +69,10 @@ Exchange读取Neo4j数据时需要完成以下工作： | 要素 | 名称 | 属性 | | :--- | :--- | :--- | - | 标签（Tag） | `player` | `name string, age int` | - | 标签（Tag） | `team` | `name string` | - | 边类型（Edge Type） | `follow` | `degree int` | - | 边类型（Edge Type） | `serve` | `start_year int, end_year int` | + | Tag | `player` | `name string, age int` | + | Tag | `team` | `name string` | + | Edge Type | `follow` | `degree int` | + | Edge Type | `serve` | `start_year int, end_year int` | 2. 使用Nebula Console创建一个图空间**basketballplayer**，并创建一个Schema，如下所示。 @@ -86,16 +86,16 @@ Exchange读取Neo4j数据时需要完成以下工作： ## 选择图空间basketballplayer nebula> USE basketballplayer; - ## 创建标签player + ## 创建Tag player nebula> CREATE TAG player(name string, age int); - ## 创建标签team + ## 创建Tag team nebula> CREATE TAG team(name string); - ## 创建边类型follow + ## 创建Edge type follow nebula> CREATE EDGE follow(degree int); - ## 创建边类型serve + ## 创建Edge type serve nebula> CREATE EDGE serve(start_year int, end_year int); ``` @@ -166,7 +166,7 @@ Exchange读取Neo4j数据时需要完成以下工作： tags: [ - # 设置标签player相关信息。 + # 设置Tag player相关信息。 { name: player type: { @@ -187,7 +187,7 @@ Exchange读取Neo4j数据时需要完成以下工作： batch: 1000 check_point_path: /tmp/test } - # 设置标签team相关信息。 + # 设置Tag team相关信息。 { name: team type: { @@ -212,7 +212,7 @@ Exchange读取Neo4j数据时需要完成以下工作： # 处理边数据 edges: [ - # 设置边类型follow相关信息 + # 设置Edge type follow相关信息 { name: follow type: { @@ -236,7 +236,7 @@ Exchange读取Neo4j数据时需要完成以下工作： batch: 1000 check_point_path: /tmp/test } - # 设置边类型serve相关信息 + # 设置Edge type serve相关信息 { name: serve type: { diff --git a/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-orc.md b/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-orc.md index fb5afa76229..921d20721f3 100644 --- a/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-orc.md +++ b/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-orc.md @@ -36,7 +36,7 @@ - 已经安装Spark。 -- 了解Nebula Graph中创建Schema的信息，包括标签和边类型的名称、属性等。 +- 了解Nebula Graph中创建Schema的信息，包括Tag和Edge type的名称、属性等。 - 如果文件存储在HDFS上，需要确认Hadoop服务运行正常。 @@ -52,10 +52,10 @@ | 要素 | 名称 | 属性 | | :--- | :--- | :--- | - | 标签（Tag） | `player` | `name string, age int` | - | 标签（Tag） | `team` | `name string` | - | 边类型（Edge Type） | `follow` | `degree int` | - | 边类型（Edge Type） | `serve` | `start_year int, end_year int` | + | Tag | `player` | `name string, age int` | + | Tag | `team` | `name string` | + | Edge Type | `follow` | `degree int` | + | Edge Type | `serve` | `start_year int, end_year int` | 2. 使用Nebula Console创建一个图空间**basketballplayer**，并创建一个Schema，如下所示。 @@ -69,16 +69,16 @@ ## 选择图空间basketballplayer nebula> USE basketballplayer; - ## 创建标签player + ## 创建Tag player nebula> CREATE TAG player(name string, age int); - ## 创建标签team + ## 创建Tag team nebula> CREATE TAG team(name string); - ## 创建边类型follow + ## 创建Edge type follow nebula> CREATE EDGE follow(degree int); - ## 创建边类型serve + ## 创建Edge type serve nebula> CREATE EDGE serve(start_year int, end_year int); ``` @@ -151,9 +151,9 @@ # 处理点 tags: [ - # 设置标签player相关信息。 + # 设置Tag player相关信息。 { - # 指定Nebula Graph中定义的标签名称。 + # 指定Nebula Graph中定义的Tag名称。 name: player type: { # 指定数据源，使用ORC。 @@ -191,9 +191,9 @@ partition: 32 } - # 设置标签team相关信息。 + # 设置Tag team相关信息。 { - # 指定Nebula Graph中定义的标签名称。 + # 指定Nebula Graph中定义的Tag名称。 name: team type: { # 指定数据源，使用ORC。 @@ -237,9 +237,9 @@ ] # 处理边 edges: [ - # 设置边类型follow相关信息。 + # 设置Edge type follow相关信息。 { - # 指定Nebula Graph中定义的边类型名称。 + # 指定Nebula Graph中定义的Edge type名称。 name: follow type: { # 指定数据源，使用ORC。 @@ -284,9 +284,9 @@ partition: 32 } - # 设置边类型serve相关信息。 + # 设置Edge type serve相关信息。 { - # 指定Nebula Graph中定义的边类型名称。 + # 指定Nebula Graph中定义的Edge type名称。 name: serve type: { # 指定数据源，使用ORC。 diff --git a/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-parquet.md b/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-parquet.md index 08528a0fbce..ae2fc3c939f 100644 --- a/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-parquet.md +++ b/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-parquet.md @@ -36,7 +36,7 @@ - 已经安装Spark。 -- 了解Nebula Graph中创建Schema的信息，包括标签和边类型的名称、属性等。 +- 了解Nebula Graph中创建Schema的信息，包括Tag和Edge type的名称、属性等。 - 如果文件存储在HDFS上，需要确认Hadoop服务运行正常。 @@ -52,10 +52,10 @@ | 要素 | 名称 | 属性 | | :--- | :--- | :--- | - | 标签（Tag） | `player` | `name string, age int` | - | 标签（Tag） | `team` | `name string` | - | 边类型（Edge Type） | `follow` | `degree int` | - | 边类型（Edge Type） | `serve` | `start_year int, end_year int` | + | Tag | `player` | `name string, age int` | + | Tag | `team` | `name string` | + | Edge Type | `follow` | `degree int` | + | Edge Type | `serve` | `start_year int, end_year int` | 2. 使用Nebula Console创建一个图空间**basketballplayer**，并创建一个Schema，如下所示。 @@ -69,16 +69,16 @@ ## 选择图空间basketballplayer nebula> USE basketballplayer; - ## 创建标签player + ## 创建Tag player nebula> CREATE TAG player(name string, age int); - ## 创建标签team + ## 创建Tag team nebula> CREATE TAG team(name string); - ## 创建边类型follow + ## 创建Edge type follow nebula> CREATE EDGE follow(degree int); - ## 创建边类型serve + ## 创建Edge type serve nebula> CREATE EDGE serve(start_year int, end_year int); ``` @@ -151,9 +151,9 @@ # 处理点 tags: [ - # 设置标签player相关信息。 + # 设置Tag player相关信息。 { - # 指定Nebula Graph中定义的标签名称。 + # 指定Nebula Graph中定义的Tag名称。 name: player type: { # 指定数据源，使用Parquet。 @@ -191,9 +191,9 @@ partition: 32 } - # 设置标签team相关信息。 + # 设置Tag team相关信息。 { - # 指定Nebula Graph中定义的标签名称。 + # 指定Nebula Graph中定义的Tag名称。 name: team type: { # 指定数据源，使用Parquet。 @@ -237,9 +237,9 @@ ] # 处理边 edges: [ - # 设置边类型follow相关信息。 + # 设置Edge type follow相关信息。 { - # 指定Nebula Graph中定义的边类型名称。 + # 指定Nebula Graph中定义的Edge type名称。 name: follow type: { # 指定数据源，使用Parquet。 @@ -284,9 +284,9 @@ partition: 32 } - # 设置边类型serve相关信息。 + # 设置Edge type serve相关信息。 { - # 指定Nebula Graph中定义的边类型名称。 + # 指定Nebula Graph中定义的Edge type名称。 name: serve type: { # 指定数据源，使用Parquet。 diff --git a/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-pulsar.md b/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-pulsar.md index 61f6dda0518..940bd4e69f8 100644 --- a/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-pulsar.md +++ b/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-pulsar.md @@ -28,7 +28,7 @@ - 已经安装Spark。 -- 了解Nebula Graph中创建Schema的信息，包括标签和边类型的名称、属性等。 +- 了解Nebula Graph中创建Schema的信息，包括Tag和Edge type的名称、属性等。 - 已经安装并开启Pulsar服务。 @@ -42,10 +42,10 @@ | 要素 | 名称 | 属性 | | :--- | :--- | :--- | - | 标签（Tag） | `player` | `name string, age int` | - | 标签（Tag） | `team` | `name string` | - | 边类型（Edge Type） | `follow` | `degree int` | - | 边类型（Edge Type） | `serve` | `start_year int, end_year int` | + | Tag | `player` | `name string, age int` | + | Tag | `team` | `name string` | + | Edge Type | `follow` | `degree int` | + | Edge Type | `serve` | `start_year int, end_year int` | 2. 在Nebula Graph中创建一个图空间**basketballplayer**，并创建一个Schema，如下所示。 @@ -59,16 +59,16 @@ ## 选择图空间basketballplayer nebula> USE basketballplayer; - ## 创建标签player + ## 创建Tag player nebula> CREATE TAG player(name string, age int); - ## 创建标签team + ## 创建Tag team nebula> CREATE TAG team(name string); - ## 创建边类型follow + ## 创建Edge type follow nebula> CREATE EDGE follow(degree int); - ## 创建边类型serve + ## 创建Edge type serve nebula> CREATE EDGE serve(start_year int, end_year int); ``` @@ -127,9 +127,9 @@ } # 处理点 tags: [ - # 设置标签player相关信息。 + # 设置Tag player相关信息。 { - # Nebula Graph中对应的标签名称。 + # Nebula Graph中对应的Tag 名称。 name: player type: { # 指定数据源文件格式，设置为Pulsar。 @@ -166,7 +166,7 @@ # 读取消息的间隔。单位：秒。 interval.seconds: 10 } - # 设置标签team相关信息。 + # 设置Tag team相关信息。 { name: team type: { @@ -192,9 +192,9 @@ # 处理边数据 edges: [ - # 设置边类型follow相关信息 + # 设置Edge type follow相关信息 { - # Nebula Graph中对应的边类型名称。 + # Nebula Graph中对应的Edge type名称。 name: follow type: { @@ -243,7 +243,7 @@ interval.seconds: 10 } - # 设置边类型serve相关信息 + # 设置Edge type serve相关信息 { name: serve type: { diff --git a/docs-2.0/nebula-flink/nf-ug-customize-sink.md b/docs-2.0/nebula-flink/nf-ug-customize-sink.md index 41deba1a3ce..090331aa246 100644 --- a/docs-2.0/nebula-flink/nf-ug-customize-sink.md +++ b/docs-2.0/nebula-flink/nf-ug-customize-sink.md @@ -162,14 +162,14 @@ Flink 将处理完成的数据 sink 到 Nebula Graph 数据库时，需要将 Fl - Nebula Graph 图数据库的账号及其密码。 - `VertexExecutionOptions` 需要配置： - 需要写入点数据的 Nebula Graph 图数据库中的图空间名称。 - - 需要写入的标签（点类型）名称。 - - 需要写入的标签属性。 + - 需要写入的Tag（点类型）名称。 + - 需要写入的Tag属性。 - 需要写入的点 VID 所在 Flink 数据流 Row 中的索引。 - 单次写入 Nebula Graph 的数据量限值，默认为 2000。 - `EdgeExecutionOptions` 需要配置： - 需要写入边数据的 Nebula Graph 图数据库中的图空间名称。 - - 需要写入的边类型。 - - 需要写入的边类型属性。 + - 需要写入的Edge type。 + - 需要写入的Edge type属性。 - 需要写入的边起点 VID（src_Id）所在 Flink 数据流 Row 中的索引。 - 需要写入的边终点 VID（dst_Id）所在 Flink 数据流 Row 中的索引。 - 需要写入的边 rank 所在 Flink 数据流 Row 中的索引。如果不配置，则写入边数据时不带 rank 信息。 @@ -179,8 +179,8 @@ Flink 将处理完成的数据 sink 到 Nebula Graph 数据库时，需要将 Fl - Graph 服务为本地单副本部署，使用默认端口 - 图空间名称：`flinkSink` -- 标签：`player` -- 标签属性：`name` 和 `age` +- Tag：`player` +- Tag属性：`name` 和 `age` 以下为自定义 NebulaSink 的代码示例。 diff --git a/docs-2.0/nebula-flink/nf-ug-customize-source.md b/docs-2.0/nebula-flink/nf-ug-customize-source.md index 3d2918c80e3..94cf7afae54 100644 --- a/docs-2.0/nebula-flink/nf-ug-customize-source.md +++ b/docs-2.0/nebula-flink/nf-ug-customize-source.md @@ -40,23 +40,23 @@ NebulaSource 的实现类图如下所示。 - Nebula Graph 图数据库的账号及其密码。 - `VertexExecutionOptions` 需要配置： - 需要读取点数据的 Nebula Graph 图数据库中的图空间名称。 - - 需要读取的标签（点类型）名称。一次只能一个标签。 - - 要读取的标签属性。 - - 是否读取指定标签的所有属性，默认为 `false`。如果配置为 `true` 则标签属性的配置无效。 + - 需要读取的Tag（点类型）名称。一次只能一个Tag。 + - 要读取的Tag属性。 + - 是否读取指定Tag的所有属性，默认为 `false`。如果配置为 `true` 则Tag属性的配置无效。 - 单次读取的数据量限值，默认为 2000 个点数据。 - `EdgeExecutionOptions` 需要配置： - 需要读取边数据的 Nebula Graph 图数据库中的图空间名称。 - - 需要读取的边类型。一次只能一个边类型。 - - 需要读取的边类型属性。 - - 是否读取指定边类型的所有属性，默认为 `false`。如果配置为 `true` 则边类型属性的配置无效。 + - 需要读取的Edge type。一次只能一个Edge type。 + - 需要读取的Edge type属性。 + - 是否读取指定Edge type的所有属性，默认为 `false`。如果配置为 `true` 则Edge type属性的配置无效。 - 单次读取的数据量限值，默认值为 2000 个边数据。 假设需要读取点数据的 Nebula Graph 图数据库信息如下： - Meta 服务为本地单副本部署，使用默认端口 - 图空间名称：`flinkSource` -- 标签：`player` -- 标签属性：`name` 和 `age` +- Tag：`player` +- Tag属性：`name` 和 `age` - 单次最多读取 100 个点数据 以下为自定义 NebulaSource 的代码示例。 diff --git a/docs-2.0/nebula-importer/config-with-header.md b/docs-2.0/nebula-importer/config-with-header.md index 924ecef5520..b9450ea1015 100644 --- a/docs-2.0/nebula-importer/config-with-header.md +++ b/docs-2.0/nebula-importer/config-with-header.md @@ -62,9 +62,9 @@ !!! note 除了`:LABEL`列之外的所有列都可以按任何顺序排序，因此针对较大的CSV文件，用户可以灵活地设置header来选择需要的列。 -对于标签或边类型的属性，格式为`.:`，说明如下： +对于Tag或Edge type的属性，格式为`.:`，说明如下： -- ``：标签或者边类型的名称。 +- ``：Tag或者Edge type的名称。 - ``：属性名称。 @@ -173,7 +173,7 @@ files: # Schema的类型为edge。 type: edge edge: - # 边类型名称。 + # Edge type名称。 name: follow # 是否包含rank。 diff --git a/docs-2.0/nebula-importer/config-without-header.md b/docs-2.0/nebula-importer/config-without-header.md index aa665002b61..aee021f2ea5 100644 --- a/docs-2.0/nebula-importer/config-without-header.md +++ b/docs-2.0/nebula-importer/config-without-header.md @@ -126,12 +126,12 @@ files: # 点ID的数据类型，可选值为int和string，分别对应Nebula Graph中的INT64和FIXED_STRING。 type: string - # 标签设置。 + # Tag设置。 tags: - # 标签名称。 + # Tag名称。 - name: student - # 标签内的属性设置。 + # Tag内的属性设置。 props: # 属性名称。 - name: name @@ -163,7 +163,7 @@ files: # Schema的类型为edge。 type: edge edge: - # 边类型名称。 + # Edge type名称。 name: follow # 是否包含rank。 @@ -187,7 +187,7 @@ files: # rank值对应CSV文件中列的序号。如果没有设置index，请务必在第三列设置rank的值。之后的列依次设置各属性。 index: 2 - # 边类型内的属性设置。 + # Edge type内的属性设置。 props: # 属性名称。 - name: degree diff --git a/docs-2.0/nebula-importer/use-importer.md b/docs-2.0/nebula-importer/use-importer.md index 68f2499fcf5..e522685f0f4 100644 --- a/docs-2.0/nebula-importer/use-importer.md +++ b/docs-2.0/nebula-importer/use-importer.md @@ -24,7 +24,7 @@ Importer适用于将本地CSV文件的内容导入至Nebula Graph中。 - [源码编译安装](../4.deployment-and-installation/2.compile-and-install-nebula-graph/1.install-nebula-graph-by-compiling-the-source-code.md) -- Nebula Graph中已创建Schema，包括图空间、标签和边类型，或者通过参数`clientSettings.postStart.commands`设置。 +- Nebula Graph中已创建Schema，包括图空间、Tag和Edge type，或者通过参数`clientSettings.postStart.commands`设置。 - 运行Importer的机器已部署Golang环境。详情请参见[Golang 环境搭建](https://github.com/vesoft-inc/nebula-importer/blob/release-v2.0.0-ga/docs/golang-install.md)。 @@ -249,8 +249,8 @@ schema: |`files.schema.type`|-|是|Schema的类型，可选值为`vertex`和`edge`。| |`files.schema.vertex.vid.type`|-|否|点ID的数据类型，可选值为`int`和`string`。| |`files.schema.vertex.vid.index`|-|否|点ID对应CSV文件中列的序号。| -|`files.schema.vertex.tags.name`|-|是|标签名称。| -|`files.schema.vertex.tags.props.name`|-|是|标签属性名称，必须和Nebula Graph中的标签属性一致。| +|`files.schema.vertex.tags.name`|-|是|Tag名称。| +|`files.schema.vertex.tags.props.name`|-|是|Tag属性名称，必须和Nebula Graph中的Tag属性一致。| |`files.schema.vertex.tags.props.type`|-|否|属性数据类型，支持`bool`、`int`、`float`、`double`、`timestamp`和`string`。| |`files.schema.vertex.tags.props.index`|-|否|属性对应CSV文件中列的序号。| @@ -284,13 +284,13 @@ schema: |参数|默认值|是否必须|说明| |:---|:---|:---|:---| |`files.schema.type`|-|是|Schema的类型，可选值为`vertex`和`edge`。| -|`files.schema.edge.name`|-|是|边类型名称。| +|`files.schema.edge.name`|-|是|Edge type名称。| |`files.schema.edge.srcVID.type`|-|否|边的起始点ID的数据类型。| |`files.schema.edge.srcVID.index`|-|否|边的起始点ID对应CSV文件中列的序号。| |`files.schema.edge.dstVID.type`|-|否|边的目的点ID的数据类型。| |`files.schema.edge.dstVID.index`|-|否|边的目的点ID对应CSV文件中列的序号。| |`files.schema.edge.rank.index`|-|否|边的rank值对应CSV文件中列的序号。| -|`files.schema.edge.props.name`|-|是|边类型属性名称，必须和Nebula Graph中的边类型属性一致。| +|`files.schema.edge.props.name`|-|是|Edge type属性名称，必须和Nebula Graph中的Edge type属性一致。| |`files.schema.edge.props.type`|-|否|属性类型，支持`bool`、`int`、`float`、`double`、`timestamp`和`string`。| |`files.schema.edge.props.index`|-|否|属性对应CSV文件中列的序号。| diff --git a/docs-2.0/nebula-spark-connector.md b/docs-2.0/nebula-spark-connector.md index a29bf5a2cd4..53c2a82a33d 100644 --- a/docs-2.0/nebula-spark-connector.md +++ b/docs-2.0/nebula-spark-connector.md @@ -4,7 +4,7 @@ Nebula Spark Connector是一个Spark连接器，提供通过Spark标准形式读 - Reader - 提供一个Spark SQL接口，用户可以使用该接口编程读取Nebula Graph图数据，单次读取一个点或边类型的数据，并将读取的结果组装成Spark的DataFrame。 + 提供一个Spark SQL接口，用户可以使用该接口编程读取Nebula Graph图数据，单次读取一个点或Edge type的数据，并将读取的结果组装成Spark的DataFrame。 - Writer @@ -128,7 +128,7 @@ val edge = spark.read.nebula(config, nebulaReadEdgeConfig).loadEdgesToDF() |参数|是否必须|说明| |:---|:---|:---| |`withSpace` |是| Nebula Graph图空间名称。 | - |`withLabel` |是| Nebula Graph图空间内的标签或边类型名称。 | + |`withLabel` |是| Nebula Graph图空间内的Tag或Edge type名称。 | |`withNoColumn` |否| 是否不读取属性。默认值为`false`，表示读取属性。取值为`true`时，表示不读取属性，此时`withReturnCols`配置无效。 | |`withReturnCols` |否| 配置要读取的点或边的属性集。格式为`List(property1,property2,...)`，默认值为`List()`，表示读取全部属性。 | |`withLimit` |否| 配置Nebula Java Storage Client一次从服务端读取的数据行数。默认值为1000。 | @@ -189,10 +189,10 @@ df.write.nebula(config, nebulaWriteEdgeConfig).writeEdges() |参数|是否必须|说明| |:---|:---|:---| |`withSpace` |是| Nebula Graph图空间名称。 | - |`withTag` |是| 写入点时需要关联的标签名称。 | + |`withTag` |是| 写入点时需要关联的Tag名称。 | |`withVidField` |是| DataFrame中作为点ID的列。 | |`withVidPolicy` |否| 写入点ID时，采用的映射函数，Nebula Graph 2.0仅支持HASH。默认不做映射。 | - |`withVidAsProp` |否| DataFrame中作为点ID的列是否也作为属性写入。默认值为`false`。如果配置为`true`，请确保标签中有和`VidField`相同的属性名。 | + |`withVidAsProp` |否| DataFrame中作为点ID的列是否也作为属性写入。默认值为`false`。如果配置为`true`，请确保Tag中有和`VidField`相同的属性名。 | |`withUser` |否| Nebula Graph用户名。若未开启[身份验证](7.data-security/1.authentication/1.authentication.md)，无需配置用户名和密码。 | |`withPasswd` |否| Nebula Graph用户名对应的密码。 | |`withBatch` |是| 一次写入的数据行数。默认值为`1000`. | @@ -202,15 +202,15 @@ df.write.nebula(config, nebulaWriteEdgeConfig).writeEdges() |参数|是否必须|说明| |:---|:---|:---| |`withSpace` |是| Nebula Graph图空间名称。 | - |`withEdge` |是| 写入边时需要关联的边类型名称。 | + |`withEdge` |是| 写入边时需要关联的Edge type名称。 | |`withSrcIdField` |是| DataFrame中作为起始点的列。 | |`withSrcPolicy` |否| 写入起始点时，采用的映射函数，Nebula Graph 2.0仅支持HASH。默认不做映射。 | |`withDstIdField` |是| DataFrame中作为目的点的列。 | |`withDstPolicy` |否| 写入目的点时，采用的映射函数，Nebula Graph 2.0仅支持HASH。默认不做映射。 | |`withRankField` |否| DataFrame中作为rank的列。默认不写入rank。 | - |`withSrcAsProperty` |否| DataFrame中作为起始点的列是否也作为属性写入。默认值为`false`。如果配置为`true`，请确保边类型中有和`SrcIdField`相同的属性名。 | - |`withDstAsProperty` |否| DataFrame中作为目的点的列是否也作为属性写入。默认值为`false`。如果配置为`true`，请确保边类型中有和`DstIdField`相同的属性名。 | - |`withRankAsProperty` |否| DataFrame中作为rank的列是否也作为属性写入。默认值为`false`。如果配置为`true`，请确保边类型中有和`RankField`相同的属性名。 | + |`withSrcAsProperty` |否| DataFrame中作为起始点的列是否也作为属性写入。默认值为`false`。如果配置为`true`，请确保Edge type中有和`SrcIdField`相同的属性名。 | + |`withDstAsProperty` |否| DataFrame中作为目的点的列是否也作为属性写入。默认值为`false`。如果配置为`true`，请确保Edge type中有和`DstIdField`相同的属性名。 | + |`withRankAsProperty` |否| DataFrame中作为rank的列是否也作为属性写入。默认值为`false`。如果配置为`true`，请确保Edge type中有和`RankField`相同的属性名。 | |`withUser` |否| Nebula Graph用户名。若未开启[身份验证](7.data-security/1.authentication/1.authentication.md)，无需配置用户名和密码。 | |`withPasswd` |否| Nebula Graph用户名对应的密码。 | |`withBatch` |是| 一次写入的数据行数。默认值为`1000`. | diff --git a/docs-2.0/nebula-studio/manage-schema/st-ug-crud-edge-type.md b/docs-2.0/nebula-studio/manage-schema/st-ug-crud-edge-type.md index 87cf56b8019..42380b3fcf7 100644 --- a/docs-2.0/nebula-studio/manage-schema/st-ug-crud-edge-type.md +++ b/docs-2.0/nebula-studio/manage-schema/st-ug-crud-edge-type.md @@ -1,6 +1,6 @@ -# 操作边类型 +# 操作Edge type -在 Nebula Graph 数据库中创建图空间后，用户可能需要创建边类型。用户可以选择使用 **控制台** 或者 **Schema** 操作边类型。本文仅说明如何使用 **Schema** 操作边类型。 +在 Nebula Graph 数据库中创建图空间后，用户可能需要创建Edge type。用户可以选择使用 **控制台** 或者 **Schema** 操作Edge type。本文仅说明如何使用 **Schema** 操作Edge type。 ## 支持版本 @@ -8,7 +8,7 @@ Studio v{{ studio.base220 }} 及以后版本。请更新版本，详细操作参 ## 前提条件 -在 Studio 上操作边类型之前，用户必须确认以下信息： +在 Studio 上操作Edge type之前，用户必须确认以下信息： - Studio 已经连接到 Nebula Graph 数据库。 @@ -16,9 +16,9 @@ Studio v{{ studio.base220 }} 及以后版本。请更新版本，详细操作参 - 当前登录的账号拥有 GOD、ADMIN 或者 DBA 的权限。 -## 创建边类型 +## 创建Edge type -按以下步骤使用 **Schema** 创建边类型： +按以下步骤使用 **Schema** 创建Edge type： 1. 在工具栏中，点击 **Schema** 页签。 @@ -30,24 +30,24 @@ Studio v{{ studio.base220 }} 及以后版本。请更新版本，详细操作参 5. 在 **创建** 页面上，完成以下设置： - 1. **名称**：按提示信息输入合规的边类型名称。本示例中，输入 `serve`。 + 1. **名称**：按提示信息输入合规的Edge type名称。本示例中，输入 `serve`。 - 2. （可选）如果边类型需要属性，在 **定义属性**面板的左上角，点击勾选框，并在展开的列表中，完成以下操作： + 2. （可选）如果Edge type需要属性，在 **定义属性**面板的左上角，点击勾选框，并在展开的列表中，完成以下操作： - 输入属性名称、数据类型和默认值。 - - 如果一个边类型有多个属性，可以点击 **添加属性** 按钮，并定义属性。 + - 如果一个Edge type有多个属性，可以点击 **添加属性** 按钮，并定义属性。 - 如果要删除某个属性，在该属性所在行，点击 ![表示删除的图标](../figs/st-ug-020.png "删除") 图标。 - 3. （可选）边类型未设置索引时，用户可以设置 TTL：在 **设置TTL**面板的左上角，点击勾选框，并在展开的列表中设置 `TTL_COL` 和 `TTL_DURATION` 参数信息。关于这两个参数的详细信息，参考 [TTL 配置](../../3.ngql-guide/8.clauses-and-options/ttl-options.md "点击前往 Nebula Graph 网站")。 + 3. （可选）Edge type未设置索引时，用户可以设置 TTL：在 **设置TTL**面板的左上角，点击勾选框，并在展开的列表中设置 `TTL_COL` 和 `TTL_DURATION` 参数信息。关于这两个参数的详细信息，参考 [TTL 配置](../../3.ngql-guide/8.clauses-and-options/ttl-options.md "点击前往 Nebula Graph 网站")。 6. 完成设置后，在 **对应的nGQL语句** 面板上，用户能看到与上述配置等价的 nGQL 语句。 -![定义边类型 action 的属性](../figs/st-ug-022-1.png "定义边类型") +![定义Edge type action 的属性](../figs/st-ug-022-1.png "定义Edge type") 7. 确认无误后，点击 **+ 创建** 按钮。 - 如果边类型创建成功，**定义属性**面板会显示这个边类型的属性列表。 + 如果Edge type创建成功，**定义属性**面板会显示这个Edge type的属性列表。 -## 修改边类型 +## 修改Edge type -按以下步骤使用 **Schema** 修改边类型： +按以下步骤使用 **Schema** 修改Edge type： 1. 在工具栏中，点击 **Schema** 页签。 @@ -55,7 +55,7 @@ Studio v{{ studio.base220 }} 及以后版本。请更新版本，详细操作参 3. 在 **当前图空间** 里确认图空间名称。用户也可以通过选择图空间名称完成图空间切换。 -4. 点击 **边类型** 页签，找到需要修改的边类型，并在 **操作** 列中，点击 ![表示修改的图标](../figs/st-ug-021.png "修改") 图标。 +4. 点击 **边类型** 页签，找到需要修改的Edge type，并在 **操作** 列中，点击 ![表示修改的图标](../figs/st-ug-021.png "修改") 图标。 5. 在 **编辑** 页面，用户可以选择以下操作： @@ -68,12 +68,12 @@ Studio v{{ studio.base220 }} 及以后版本。请更新版本，详细操作参 6. 完成设置后，在 **对应的nGQL语句** 面板上，用户能看到修改后的 nGQL 语句。 -## 删除边类型 +## 删除Edge type !!! danger - 删除标签前先确认[影响](../../3.ngql-guide/10.tag-statements/2.drop-tag.md)，已删除的数据如未[备份](../../7.data-security/3.manage-snapshot.md)无法恢复。 + 删除Tag前先确认[影响](../../3.ngql-guide/10.tag-statements/2.drop-tag.md)，已删除的数据如未[备份](../../7.data-security/3.manage-snapshot.md)无法恢复。 -按以下步骤使用 **Schema** 删除边类型： +按以下步骤使用 **Schema** 删除Edge type： 1. 在工具栏中，点击 **Schema** 页签。 @@ -81,10 +81,10 @@ Studio v{{ studio.base220 }} 及以后版本。请更新版本，详细操作参 3. 在 **当前图空间** 里确认图空间名称。用户也可以通过选择图空间名称切换图空间。 -4. 点击 **边类型** 页签，找到需要修改的边类型，并在 **操作** 列中，点击 ![表示删除的图标](../figs/st-ug-017.png "删除") 图标。 +4. 点击 **边类型** 页签，找到需要修改的Edge type，并在 **操作** 列中，点击 ![表示删除的图标](../figs/st-ug-017.png "删除") 图标。 5. 在弹出的对话框中点击 **确认**。 ## 后续操作 -边类型创建成功后，用户可以在 **控制台** 上逐条插入边数据，或者使用 **导入** 功能批量插入边数据。 +Edge type创建成功后，用户可以在 **控制台** 上逐条插入边数据，或者使用 **导入** 功能批量插入边数据。 diff --git a/docs-2.0/nebula-studio/manage-schema/st-ug-crud-index.md b/docs-2.0/nebula-studio/manage-schema/st-ug-crud-index.md index d097ef9be9b..e9957dd899d 100644 --- a/docs-2.0/nebula-studio/manage-schema/st-ug-crud-index.md +++ b/docs-2.0/nebula-studio/manage-schema/st-ug-crud-index.md @@ -1,10 +1,10 @@ # 操作索引 -用户可以为标签和边类型创建索引，使得图查询时可以从拥有共同属性的同一类型的点或边开始遍历，使大型图的查询更为高效。Nebula Graph 支持两种类型的索引：标签索引和边类型索引。用户可以选择使用 **控制台** 或者 **Schema** 操作索引。本文仅说明如何使用 **Schema** 操作索引。 +用户可以为Tag和Edge type创建索引，使得图查询时可以从拥有共同属性的同一类型的点或边开始遍历，使大型图的查询更为高效。Nebula Graph 支持两种类型的索引：Tag索引和Edge type索引。用户可以选择使用 **控制台** 或者 **Schema** 操作索引。本文仅说明如何使用 **Schema** 操作索引。 !!! Note - 一般在创建了标签或者边类型之后即可创建索引，但是，索引会影响写性能，所以，建议先导入数据，再批量重建索引。关于索引的详细信息，参考[《nGQL 用户手册》](../../3.ngql-guide/14.native-index-statements/README.md "点击前往 Nebula Graph 网站")。 + 一般在创建了Tag或者Edge type之后即可创建索引，但是，索引会影响写性能，所以，建议先导入数据，再批量重建索引。关于索引的详细信息，参考[《nGQL 用户手册》](../../3.ngql-guide/14.native-index-statements/README.md "点击前往 Nebula Graph 网站")。 ## 支持版本 @@ -15,7 +15,7 @@ Studio v{{ studio.base220 }} 及以后版本。请更新版本，详细操作参 在 Studio 上操作索引之前，用户必须确认以下信息： - Studio 已经连接到 Nebula Graph 数据库。 -- 图空间、标签和边类型已经创建。 +- 图空间、Tag和Edge type已经创建。 - 当前登录的账号拥有 GOD、ADMIN 或者 DBA 的权限。 ## 创建索引 @@ -32,9 +32,9 @@ Studio v{{ studio.base220 }} 及以后版本。请更新版本，详细操作参 5. 在 **创建** 页面上，完成以下设置： - 1. **索引类型**：确认或修改索引类型，即 **标签** 或者 **边类型**。本示例中选择 **边类型**。 + 1. **索引类型**：确认或修改索引类型，即 **Tag** 或者 **Edge type**。本示例中选择 **Edge type**。 - 2. **名称**：选择要创建索引的标签或边类型名称。本示例中选择 **follow**。 + 2. **名称**：选择要创建索引的Tag或Edge type名称。本示例中选择 **follow**。 3. **索引名称**：按规定指定索引名称。本示例中输入 **follow_index**。 @@ -45,7 +45,7 @@ Studio v{{ studio.base220 }} 及以后版本。请更新版本，详细操作参 索引属性的顺序会影响 `LOOKUP` 语句的查询结果。详细信息，参考 [《nGQL 用户手册》](../../3.ngql-guide/7.general-query-statements/5.lookup.md "点击前往 Nebula Graph 网站")。 6. 完成设置后，在 **对应的 nGQL**面板，用户能看到与上述配置等价的 nGQL 语句。 -![为边类型 action 创建索引](../figs/st-ug-023-1.png "创建索引") +![为Edge type action 创建索引](../figs/st-ug-023-1.png "创建索引") 7. 确认无误后，点击 **+ 创建** 按钮。 如果索引创建成功，**定义属性**面板会显示这个索引的属性列表。 diff --git a/docs-2.0/nebula-studio/manage-schema/st-ug-crud-space.md b/docs-2.0/nebula-studio/manage-schema/st-ug-crud-space.md index e6e887a612b..86d15136a56 100644 --- a/docs-2.0/nebula-studio/manage-schema/st-ug-crud-space.md +++ b/docs-2.0/nebula-studio/manage-schema/st-ug-crud-space.md @@ -60,6 +60,6 @@ Studio v{{ studio.base220 }} 及以后版本。请更新版本，详细操作参 图空间创建成功后，用户可以开始创建或修改 Schema，包括： -- [操作标签](st-ug-crud-tag.md) -- [操作边类型](st-ug-crud-edge-type.md) +- [操作Tag](st-ug-crud-tag.md) +- [操作Edge type](st-ug-crud-edge-type.md) - [操作索引](st-ug-crud-index.md) diff --git a/docs-2.0/nebula-studio/manage-schema/st-ug-crud-tag.md b/docs-2.0/nebula-studio/manage-schema/st-ug-crud-tag.md index adb80ab8d36..98f2f18e122 100644 --- a/docs-2.0/nebula-studio/manage-schema/st-ug-crud-tag.md +++ b/docs-2.0/nebula-studio/manage-schema/st-ug-crud-tag.md @@ -1,6 +1,6 @@ -# 操作标签（点类型） +# 操作Tag（点类型） -在 Nebula Graph 数据库中创建图空间后，用户需要创建标签（点类型）。用户可以选择使用 **控制台** 或者 **Schema** 操作标签。本文仅说明如何使用 **Schema** 操作标签。 +在 Nebula Graph 数据库中创建图空间后，用户需要创建Tag（点类型）。用户可以选择使用 **控制台** 或者 **Schema** 操作Tag。本文仅说明如何使用 **Schema** 操作Tag。 ## 支持版本 @@ -8,15 +8,15 @@ Studio v{{ studio.base220 }} 及以后版本。请更新版本，详细操作参 ## 前提条件 -在 Studio 上操作标签之前，用户必须确认以下信息： +在 Studio 上操作Tag之前，用户必须确认以下信息： - Studio 已经连接到 Nebula Graph 数据库。 - 图空间已经创建。 - 当前登录的账号拥有 GOD、ADMIN 或者 DBA 的权限。 -## 创建标签 +## 创建Tag -按以下步骤使用 **Schema** 创建标签： +按以下步骤使用 **Schema** 创建Tag： 1. 在工具栏中，点击 **Schema** 页签。 @@ -28,23 +28,23 @@ Studio v{{ studio.base220 }} 及以后版本。请更新版本，详细操作参 5. 在 **创建** 页面上，完成以下设置： - a. **名称**：按提示信息输入合规的标签名称。本示例中，输入 `player` 和 `team`。 + a. **名称**：按提示信息输入合规的Tag名称。本示例中，输入 `player` 和 `team`。 - b. （可选）如果标签需要属性，在 **定义属性** 模块左上角，点击勾选框，并在展开的列表中，完成以下操作： + b. （可选）如果Tag需要属性，在 **定义属性** 模块左上角，点击勾选框，并在展开的列表中，完成以下操作： - 输入属性名称、数据类型和默认值。 - - 如果一个标签有多个属性，可以点击 **添加属性** 按钮，并定义属性。 + - 如果一个Tag有多个属性，可以点击 **添加属性** 按钮，并定义属性。 - 如果要删除某个属性，在该属性所在行，点击 ![表示删除的图标](../figs/st-ug-020.png "删除") 图标。 - c. （可选）标签未设置索引时，用户可以设置 TTL：在 **设置TTL** 模块左上角，点击勾选框，并在展开的列表中设置 `TTL_COL` 和 `TTL_DURATION` 参数信息。关于这两个参数的详细信息，参考 [TTL 配置](../../3.ngql-guide/8.clauses-and-options/ttl-options.md "点击前往 Nebula Graph 网站")。 + c. （可选）Tag未设置索引时，用户可以设置 TTL：在 **设置TTL** 模块左上角，点击勾选框，并在展开的列表中设置 `TTL_COL` 和 `TTL_DURATION` 参数信息。关于这两个参数的详细信息，参考 [TTL 配置](../../3.ngql-guide/8.clauses-and-options/ttl-options.md "点击前往 Nebula Graph 网站")。 6. 完成设置后，在 **对应的 nGQL**面板，用户能看到与上述配置等价的 nGQL 语句。 7. 确认无误后，点击 **+ 创建** 按钮。 - 如果标签创建成功，**定义属性**面板会显示这个标签的属性列表。 + 如果Tag创建成功，**定义属性**面板会显示这个Tag的属性列表。 -## 修改标签 +## 修改Tag -按以下步骤使用 **Schema** 修改标签： +按以下步骤使用 **Schema** 修改Tag： 1. 在工具栏中，点击 **Schema** 页签。 @@ -52,24 +52,24 @@ Studio v{{ studio.base220 }} 及以后版本。请更新版本，详细操作参 3. 在 **当前图空间** 里确认图空间名称。用户也可以通过选择图空间名称切换图空间。 -4. 点击 **标签** 页签，找到需要修改的标签，并在 **操作** 列中，点击 ![表示修改的图标](../figs/st-ug-021.png "修改") 图标。 +4. 点击 **标签** 页签，找到需要修改的Tag，并在 **操作** 列中，点击 ![表示修改的图标](../figs/st-ug-021.png "修改") 图标。 5. 在 **编辑** 页面，用户可以选择以下操作： - 如果要修改属性：在 **定义属性** 面板上，找到需要修改的属性，在右侧点击 **编辑**，再修改属性的数据类型和默认值。之后，点击 **确认** 或者 **取消** 完成修改。 - 如果要删除属性：在 **定义属性** 面板上，找到需要删除的属性，在右侧点击 **删除**，经确认后，删除属性。 - - 如果要添加属性：在 **定义属性**面板上，点击 **添加属性** 按钮，添加属性信息。详细操作，参考 创建标签面板。 + - 如果要添加属性：在 **定义属性**面板上，点击 **添加属性** 按钮，添加属性信息。详细操作，参考 创建Tag面板。 - 如果配置了 TTL，要修改 TTL 信息：在 **设置TTL** 面板上，修改 `TTL_COL` 和 `TTL_DURATION` 配置。 - 如果要删除已经配置的 TTL 信息：在 **设置TTL** 面板的左上角，点击勾选框，取消选择。 - 如果要配置 TTL 信息：在 **使用TTL** 面板的右上角，点击勾选框，开始设置 TTL 信息。 6. 完成设置后，在 **对应的 nGQL** 面板上，用户能看到修改后的 nGQL 语句。 -## 删除标签 +## 删除Tag !!! danger - 删除标签前先确认[影响](../../3.ngql-guide/10.tag-statements/2.drop-tag.md)，已删除的数据如未[备份](../../7.data-security/3.manage-snapshot.md)无法恢复。 + 删除Tag前先确认[影响](../../3.ngql-guide/10.tag-statements/2.drop-tag.md)，已删除的数据如未[备份](../../7.data-security/3.manage-snapshot.md)无法恢复。 -按以下步骤使用 **Schema** 删除标签： +按以下步骤使用 **Schema** 删除Tag： 1. 在工具栏中，点击 **Schema** 页签。 @@ -77,10 +77,10 @@ Studio v{{ studio.base220 }} 及以后版本。请更新版本，详细操作参 3. 在 **当前图空间** 里确认图空间名称。用户也可以通过选择图空间名称切换图空间。 -4. 点击 **标签** 页签，找到需要修改的标签，并在 **操作** 列中，点击 ![表示删除的图标](../figs/st-ug-017.png "删除") 图标。 +4. 点击 **标签** 页签，找到需要修改的Tag，并在 **操作** 列中，点击 ![表示删除的图标](../figs/st-ug-017.png "删除") 图标。 5. 在弹出的对话框中点击 **确认**。 ## 后续操作 -标签创建成功后，用户可以在 **控制台** 上逐条插入点数据，或者使用 **导入** 功能批量插入点数据。 +Tag创建成功后，用户可以在 **控制台** 上逐条插入点数据，或者使用 **导入** 功能批量插入点数据。 diff --git a/docs-2.0/nebula-studio/quick-start/st-ug-create-schema.md b/docs-2.0/nebula-studio/quick-start/st-ug-create-schema.md index 602de083201..ff7bf9f6356 100644 --- a/docs-2.0/nebula-studio/quick-start/st-ug-create-schema.md +++ b/docs-2.0/nebula-studio/quick-start/st-ug-create-schema.md @@ -26,9 +26,9 @@ 按以下步骤使用 **Schema** 创建 Schema： -1. 创建标签。详细信息，参考 [操作标签](../manage-schema/st-ug-crud-tag.md)。 +1. 创建Tag。详细信息，参考 [操作Tag](../manage-schema/st-ug-crud-tag.md)。 -2. 创建边类型。详细信息，参考 [操作边类型](../manage-schema/st-ug-crud-edge-type.md)。 +2. 创建Edge type。详细信息，参考 [操作Edge type](../manage-schema/st-ug-crud-edge-type.md)。 ## 使用控制台创建 Schema @@ -43,29 +43,29 @@ 3. 在命令行中，依次输入以下语句，并点击 ![表示运行的图标](../figs/st-ug-008.png "Run 图标") 图标。 ```nGQL - -- 创建标签 player，带有 2 个属性 + -- 创建Tag player，带有 2 个属性 CREATE TAG player(name string, age int); - -- 创建标签 team，带有 1 个属性 + -- 创建Tag team，带有 1 个属性 CREATE TAG team(name string); - -- 创建边类型 follow，带有 1 个属性 + -- 创建Edge type follow，带有 1 个属性 CREATE EDGE follow(degree int); - -- 创建边类型 serve，带有 2 个属性 + -- 创建Edge type serve，带有 2 个属性 CREATE EDGE serve(start_year int, end_year int); ``` -至此，用户已经完成了 Schema 创建。用户可以运行以下语句查看标签与边类型的定义是否正确、完整。 +至此，用户已经完成了 Schema 创建。用户可以运行以下语句查看Tag与Edge type的定义是否正确、完整。 ```nGQL --- 列出当前图空间中所有标签 +-- 列出当前图空间中所有Tag SHOW TAGS; --- 列出当前图空间中所有边类型 +-- 列出当前图空间中所有Edge type SHOW EDGES; --- 查看每种标签和边类型的结构是否正确 +-- 查看每种Tag和Edge type的结构是否正确 DESCRIBE TAG player; DESCRIBE TAG team; DESCRIBE EDGE follow; diff --git a/docs-2.0/nebula-studio/quick-start/st-ug-import-data.md b/docs-2.0/nebula-studio/quick-start/st-ug-import-data.md index 20679a9f40c..1a5f1fd4d33 100644 --- a/docs-2.0/nebula-studio/quick-start/st-ug-import-data.md +++ b/docs-2.0/nebula-studio/quick-start/st-ug-import-data.md @@ -45,22 +45,22 @@ 在同一个图空间中，VID 始终唯一，不可重复。关于 VID 的信息，参考 [Nebula Graph 的点ID](../../1.introduction/3.vid.md) "点击进入 Nebula Graph 用户手册")。 8. 在 **TAG 1** 部分，完成以下操作： - 3. 在 **TAG** 下拉列表中，选择数据源对应的标签名称。在本示例中，`vertex_player.csv` 文件对应选择 **player**；`vertex_team.csv` 文件对应选择 **team**。 + 3. 在 **TAG** 下拉列表中，选择数据源对应的Tag名称。在本示例中，`vertex_player.csv` 文件对应选择 **player**；`vertex_team.csv` 文件对应选择 **team**。 - 4. 在显示的属性列表中，点击 **选择**，为标签属性绑定源数据。在本示例中，`player` 标签的 `name` 属性对应 `vertex_player.csv` 文件中的 **Column 2** 列，**类型** 为 **string**，`age` 属性对应文件中的 **Column 1** 列，**类型** 为 **int**；`team` 标签的 `name` 属性对应 `vertex_team.csv` 文件中的 **Column 1** 列，**类型** 为 **string**。 + 4. 在显示的属性列表中，点击 **选择**，为Tag属性绑定源数据。在本示例中，`player` 标签的 `name` 属性对应 `vertex_player.csv` 文件中的 **Column 2** 列，**类型** 为 **string**，`age` 属性对应文件中的 **Column 1** 列，**类型** 为 **int**；`team` 标签的 `name` 属性对应 `vertex_team.csv` 文件中的 **Column 1** 列，**类型** 为 **string**。 ![course类点对应的属性数据源](../figs/st-ug-010-1.png "为点属性选择数据源") -9. （可选）如果有多个标签数据文件，重复步骤 5 到步骤 8。 +9. （可选）如果有多个Tag数据文件，重复步骤 5 到步骤 8。 10. 完成配置后，点击 **下一步**。 - 界面提示 **配置验证成功**，表示标签数据源绑定成功。 + 界面提示 **配置验证成功**，表示Tag数据源绑定成功。 11. 在 **关联边** 页面，点击 **+ 绑定数据源** 按钮，在对话框中选择边数据文件，并点击 **确认** 按钮。如本示例中的 `edge_follow.csv` 文件。 -12. 在 **Edge X** 页签的 **类型** 下拉列表中，选择边类型名称。本示例中，选择 **follow**。 +12. 在 **Edge X** 页签的 **类型** 下拉列表中，选择Edge type名称。本示例中，选择 **follow**。 -13. 根据边类型的属性，从 `edge_follow.csv` 文件中选择相应的数据列。其中，**srcId** 和 **dstId** 分别表示边的起点与终点，所选择的数据及处理方式必须与相应的 VID 保持一致。本示例中，**srcId** 对应的是表示起点球员的 VID，**dstId** 对应的是表示终点球员的 VID。**rank** 为选填项，可以忽略。 +13. 根据Edge type的属性，从 `edge_follow.csv` 文件中选择相应的数据列。其中，**srcId** 和 **dstId** 分别表示边的起点与终点，所选择的数据及处理方式必须与相应的 VID 保持一致。本示例中，**srcId** 对应的是表示起点球员的 VID，**dstId** 对应的是表示终点球员的 VID。**rank** 为选填项，可以忽略。 ![actions 边对应的属性数据源](../figs/st-ug-011-1.png "为边属性选择数据源") diff --git a/docs-2.0/nebula-studio/quick-start/st-ug-plan-schema.md b/docs-2.0/nebula-studio/quick-start/st-ug-plan-schema.md index cac4802b2d7..fa051d918db 100644 --- a/docs-2.0/nebula-studio/quick-start/st-ug-plan-schema.md +++ b/docs-2.0/nebula-studio/quick-start/st-ug-plan-schema.md @@ -4,9 +4,9 @@ Schema 至少要包含以下要素： -* 标签（Tag，即点类型），以及每种标签的属性。 +* Tag，以及每种Tag的属性。 -* 边类型（Edge Type），以及每种边类型的属性。 +* Edge Type，以及每种Edge type的属性。 用户可以下载Nebula Graph示例数据集[basketballplayer](https://docs-cdn.nebula-graph.com.cn/dataset/dataset.zip "点击下载") ，本文将通过该实例说明如何规划 Schema。 @@ -14,10 +14,10 @@ | 类型 | 名称 | 属性名（数据类型） | 说明 | | :--- | :--- | :---| :--- | -| 标签 | **player** | - `name` （`string`）
- `age` （`int`） | 表示球员。 | -| 标签 | **team** | - `name` （`string`） | 表示球队。 | -| 边类型 | **serve** | - `start_year` （`int`）
- `end_year` （`int`） | 表示球员的行为。
该行为将球员和球队联系起来，方向是从球员到球队。 | -| 边类型 | **follow** | - `degree`（`int`） | 表示球员的行为。
该行为将两个球员联系起来，方向是从一个球员到另一个球员。 | +| Tag | **player** | - `name` （`string`）
- `age` （`int`） | 表示球员。 | +| Tag | **team** | - `name` （`string`） | 表示球队。 | +| Edge type | **serve** | - `start_year` （`int`）
- `end_year` （`int`） | 表示球员的行为。
该行为将球员和球队联系起来，方向是从球员到球队。 | +| Edge type | **follow** | - `degree`（`int`） | 表示球员的行为。
该行为将两个球员联系起来，方向是从一个球员到另一个球员。 | 下图说明示例中 **player** 类点与 **team** 类点之间如何发生关系（**serve**/**follow**）。 diff --git a/docs-2.0/nebula-studio/st-ug-toc.md b/docs-2.0/nebula-studio/st-ug-toc.md index cd788ba434e..cc3881a3608 100644 --- a/docs-2.0/nebula-studio/st-ug-toc.md +++ b/docs-2.0/nebula-studio/st-ug-toc.md @@ -19,8 +19,8 @@ - 操作指南 - 管理 Schema - [操作图空间](manage-schema/st-ug-crud-space.md) - - [操作标签](manage-schema/st-ug-crud-tag.md) - - [操作边类型](manage-schema/st-ug-crud-edge-type.md) + - [操作Tag](manage-schema/st-ug-crud-tag.md) + - [操作Edge type](manage-schema/st-ug-crud-edge-type.md) - [操作索引](manage-schema/st-ug-crud-index.md) - 使用图探索[TODO] - 使用控制台 diff --git a/docs-2.0/nebula-studio/use-console/st-ug-open-in-explorer.md b/docs-2.0/nebula-studio/use-console/st-ug-open-in-explorer.md index 471451b7d94..c5df830b6e6 100644 --- a/docs-2.0/nebula-studio/use-console/st-ug-open-in-explorer.md +++ b/docs-2.0/nebula-studio/use-console/st-ug-open-in-explorer.md @@ -41,9 +41,9 @@ Studio v{{ studio.base220 }} 及以后版本。请更新版本，详细操作参 5. 在弹出对话框中，完成如下配置： - 1. 点击 **边类型**。 + 1. 点击 **Edge type**。 - 2. 在 **Edge Type** 字段，填写边类型名称。在本示例中，填写 `serve`。 + 2. 在 **Edge Type** 字段，填写Edge type名称。在本示例中，填写 `serve`。 3. 在 **Src ID** 字段，选择查询结果中代表边起点 VID 的列名。在本示例中，选择 `serve._src`。 @@ -53,7 +53,7 @@ Studio v{{ studio.base220 }} 及以后版本。请更新版本，详细操作参 6. 完成配置后，点击 **导入** 按钮。 - ![填写边类型名称，选择代表边起点和终点 VID 的列名](../figs/st-ug-041-1.png "配置边类型信息") + ![填写Edge type名称，选择代表边起点和终点 VID 的列名](../figs/st-ug-041-1.png "配置Edge type信息") 6. 如果 **图探索** 页面此前已有数据，在弹出的窗口中选择数据插入方式： diff --git a/docs-2.0/spark-connector/reader/sc-ug-reader-example.md b/docs-2.0/spark-connector/reader/sc-ug-reader-example.md index 4e6361f228c..f763e7d98ff 100644 --- a/docs-2.0/spark-connector/reader/sc-ug-reader-example.md +++ b/docs-2.0/spark-connector/reader/sc-ug-reader-example.md @@ -15,7 +15,7 @@ - 已经获取 Nebula Graph 数据库的以下信息： - 图空间名称和分区数量（如果创建图空间时未设置分区数量，则默认使用 100） - - 标签和边类型的名称以及属性 + - Tag和Edge type的名称以及属性 - Meta 服务所在机器的 IP 地址及端口号 ## 操作步骤 @@ -80,13 +80,13 @@ - `loadVerticesToDF(, )`，所有参数均为必需参数。 - - ``：配置为指定 Nebula Graph 图空间中某个标签的名称。 - - ``：配置为指定标签的属性名称，不允许为空。如果一个标签有多个属性，则以英文逗号分隔。如果指定了属性名称，表示只读取指定的属性。如果配置为 `*`，表示读取指定标签的所有属性。 + - ``：配置为指定 Nebula Graph 图空间中某个Tag的名称。 + - ``：配置为指定Tag的属性名称，不允许为空。如果一个Tag有多个属性，则以英文逗号分隔。如果指定了属性名称，表示只读取指定的属性。如果配置为 `*`，表示读取指定Tag的所有属性。 - `loadEdgesToDF(, )`，所有参数均为必需参数。 - - ``：配置为指定 Nebula Graph 图空间中某个边类型的名称。 - - ``：配置为指定边类型的属性名称，不允许为空。如果一个边类型有多个属性，则以英文逗号分隔。如果指定了属性名称，表示只读取指定的属性，如果配置为 `*` 表示读取指定边类型的所有属性。 + - ``：配置为指定 Nebula Graph 图空间中某个Edge type的名称。 + - ``：配置为指定Edge type的属性名称，不允许为空。如果一个Edge type有多个属性，则以英文逗号分隔。如果指定了属性名称，表示只读取指定的属性，如果配置为 `*` 表示读取指定Edge type的所有属性。 以下为读取结果示例。 diff --git a/docs-2.0/spark-connector/reader/sc-ug-what-is-reader.md b/docs-2.0/spark-connector/reader/sc-ug-what-is-reader.md index 5a32044e29a..8c0d2828896 100644 --- a/docs-2.0/spark-connector/reader/sc-ug-what-is-reader.md +++ b/docs-2.0/spark-connector/reader/sc-ug-what-is-reader.md @@ -1,6 +1,6 @@ # 什么是 Nebula Spark Connector Reader -Nebula Spark Connector Reader 是 Nebula Spark Connector 的组成部分，提供了 Spark SQL 接口，用户可以使用 Spark SQL 接口编程读取 Nebula Graph 图数据，单次读取一个标签或边类型的数据，并将读取的结果组装成 Spark 的 DataFrame。读出的 DataFrame 可以通过 Nebula Spark Connector Writer 写入 Nebula Graph 数据库或实现不同图空间之间的数据迁移。 +Nebula Spark Connector Reader 是 Nebula Spark Connector 的组成部分，提供了 Spark SQL 接口，用户可以使用 Spark SQL 接口编程读取 Nebula Graph 图数据，单次读取一个Tag或Edge type的数据，并将读取的结果组装成 Spark 的 DataFrame。读出的 DataFrame 可以通过 Nebula Spark Connector Writer 写入 Nebula Graph 数据库或实现不同图空间之间的数据迁移。 ## Nebula Spark Connector Reader 实现原理 diff --git a/docs-2.0/spark-connector/sc-ug-what-is-spark-connector.md b/docs-2.0/spark-connector/sc-ug-what-is-spark-connector.md index 62865fc72b2..47a4819df22 100644 --- a/docs-2.0/spark-connector/sc-ug-what-is-spark-connector.md +++ b/docs-2.0/spark-connector/sc-ug-what-is-spark-connector.md @@ -2,7 +2,7 @@ [Nebula Spark Connector](https://github.com/vesoft-inc/nebula-java/tree/v1.0/tools "点击前往 GitHub")（在本手册中简称为 Spark Connector）是一个 Spark 连接器，提供了通过 Spark 标准形式读写 Nebula Graph 数据库的能力，由以下两部分组成： -- Reader：提供了一个 Spark SQL 接口，用户可以使用 Spark SQL 接口编程读取 Nebula Graph 图数据，单次读取一个点或边类型的数据，并将读取的结果组装成 Spark 的 DataFrame。参考 [Nebula Spark Connector Reader](reader/sc-ug-what-is-reader.md)。 +- Reader：提供了一个 Spark SQL 接口，用户可以使用 Spark SQL 接口编程读取 Nebula Graph 图数据，单次读取一个点或Edge type的数据，并将读取的结果组装成 Spark 的 DataFrame。参考 [Nebula Spark Connector Reader](reader/sc-ug-what-is-reader.md)。 - Writer：提供了一个 Spark SQL 接口，用户可以使用 Spark SQL 接口编程将 DataFrame 格式的数据逐条或批量写入 Nebula Graph。参考 [Nebula Spark Connector Writer](writer/sc-ug-what-is-writer.md)。 diff --git a/docs-2.0/spark-connector/writer/sc-ug-writer-example.md b/docs-2.0/spark-connector/writer/sc-ug-writer-example.md index 5779dc90432..2846a37d760 100644 --- a/docs-2.0/spark-connector/writer/sc-ug-writer-example.md +++ b/docs-2.0/spark-connector/writer/sc-ug-writer-example.md @@ -19,8 +19,8 @@ - 在 Nebula Graph 中创建 Schema，并获取以下信息： - 图空间名称和分区数量。在本示例中，对应的信息为 `nb` 和 `100`。 - - 点的信息，包括标签和 VID 映射策略（`hash`）。 - - 边的信息，包括起点和终点对应的标签，以及 VID 映射策略（`hash`）。 + - 点的信息，包括Tag和 VID 映射策略（`hash`）。 + - 边的信息，包括起点和终点对应的Tag，以及 VID 映射策略（`hash`）。 - （可选）如果是批量写入，需要确认单次写入的最大数据量，默认为 2000。详见本文 `batchInsert` 配置项说明。 @@ -80,12 +80,12 @@ - `partitionNum`：在 Nebula Graph 中创建图空间时指定的 `partitionNum` 的值。如果未指定，这里填写 `100`。 - `writeVertices(tag: String, vertexField: String, policy: String = "")` - - `tag`：点对应的 Nebula Graph 图空间中的标签名称。 + - `tag`：点对应的 Nebula Graph 图空间中的Tag名称。 - `vertexField`：DataFrame 中可作为 Nebula Graph 点 VID 的列。例如，如果 DataFrame 有三列，分别为 a、b、c，其中 a 列作为点 VID 列，则该参数设置为 `"a"`。 - `policy`：如果 DataFrame 中 `vertexField` 列的数据类型非数值型，则需要配置 Nebula Graph 中 VID 的映射策略，即该参数设置为 `"hash"`。如果 `vertexField` 列的数据类型为整数型，则不需要配置。 - `writeEdges(edge: String, srcVertexField: String, dstVertexField: String, policy: String = "")` - - `edge`：边对应的 Nebula Graph 图空间中的边类型名称。 + - `edge`：边对应的 Nebula Graph 图空间中的Edge type名称。 - `srcVertexField` 和 `dstVertexField`：DataFrame 中可作为边起点和边终点的列。列值必须同为整数型或同为非数值型。 - `policy`：如果 DataFrame 中 `srcVertexField` 列和 `dstVertexField` 列的数据类型非数值型，则需要配置 Nebula Graph 中 VID 的映射策略，即该参数设置为 `"hash"`。如果 `srcVertexField` 列和 `dstVertexField` 列的数据类型为整数型，则不需要配置。 @@ -122,13 +122,13 @@ new NebulaBatchWriterUtils() - `batchToNebulaVertex(data: DataFrame, tag: String, vertexField: String, policy: String = "")`： - `data`：待写入 Nebula Graph 的 DataFrame 数据。 - - `tag`：Nebula Graph 图空间中对应的标签名称。 + - `tag`：Nebula Graph 图空间中对应的Tag名称。 - `vertexField`：DataFrame 中可作为 Nebula Graph 点 VID 的列。例如，如果 DataFrame 有三列，分别为 a、b、c，其中a 列作为点 VID 列，则该参数设置为 `"a"`。 - `policy`：如果 DataFrame 中 `vertexField` 列的数据类型非数值型，则需要配置 Nebula Graph 中 VID 的映射策略，即该参数设置为 `"hash"`。如果 `vertexField` 列的数据类型为整数型，则不需要配置。 - `batchToNebulaEdge(data: DataFrame,  edge: String, srcVertexField: String, dstVertexField: String, rankField: String = "",  policy: String = "")`： - `data`：待写入 Nebula Graph 的 DataFrame 数据。 - - `edge`：Nebula Graph 中对应的边类型。 + - `edge`：Nebula Graph 中对应的Edge type。 - `srcVertexField` 和 `dstVertexField`：DataFrame 中可作为边起点和边终点的列。列值必须同为整数型或同为非数值型。 - `rankField`：DataFrame 中可作为边 `rank` 值的列，可选配。 - `policy`：可选。如果 DataFrame 中 `srcVertexField` 列和 `dstVertexField` 列的数据类型非数值型，则需要配置 Nebula Graph 中 VID 的映射策略，即该参数设置为 `"hash"`。如果 `srcVertexField` 列和 `dstVertexField` 列的数据类型为整数型，则不需要配置。 diff --git a/mkdocs.yml b/mkdocs.yml index 5bb882a9f6e..31d193fd633 100755 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -170,13 +170,13 @@ nav: - DESCRIBE SPACE: 3.ngql-guide/9.space-statements/4.describe-space.md - DROP SPACE: 3.ngql-guide/9.space-statements/5.drop-space.md - - 标签语句: + - Tag语句: - CREATE TAG: 3.ngql-guide/10.tag-statements/1.create-tag.md - DROP TAG: 3.ngql-guide/10.tag-statements/2.drop-tag.md - ALTER TAG: 3.ngql-guide/10.tag-statements/3.alter-tag.md - SHOW TAGS: 3.ngql-guide/10.tag-statements/4.show-tags.md - DESCRIBE TAG: 3.ngql-guide/10.tag-statements/5.describe-tag.md - - 边类型语句: + - Edge type语句: - CREATE EDGE: 3.ngql-guide/11.edge-type-statements/1.create-edge.md - DROP EDGE: 3.ngql-guide/11.edge-type-statements/2.drop-edge.md - ALTER EDGE: 3.ngql-guide/11.edge-type-statements/3.alter-edge.md @@ -288,8 +288,8 @@ nav: - 操作指南: - 管理 Schema: - 操作图空间: nebula-studio/manage-schema/st-ug-crud-space.md - - 操作标签: nebula-studio/manage-schema/st-ug-crud-tag.md - - 操作边类型: nebula-studio/manage-schema/st-ug-crud-edge-type.md + - 操作Tag: nebula-studio/manage-schema/st-ug-crud-tag.md + - 操作Edge type: nebula-studio/manage-schema/st-ug-crud-edge-type.md - 操作索引: nebula-studio/manage-schema/st-ug-crud-index.md - 使用控制台: - 控制台界面: nebula-studio/use-console/st-ug-console.md