Skip to content

Commit

Permalink
vid.type added in github doc/readm (#183)
Browse files Browse the repository at this point in the history 
* Update README.md

Added doc for `schema.vertex.vid.type`.

* Update configuration-reference.md

Added type in ref docs
  • Loading branch information
@wey-gu
wey-gu committed Mar 8, 2022
1 parent bd56fb5 commit 1faf91f
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 0 deletions.
1 change: 1 addition & 0 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -209,6 +209,7 @@ schema:

* `index`: **Optional**. The column number in the CSV file. Started with 0. The default value is 0.
* `function`: **Optional**. Functions to generate the VIDs. Currently, we only support function `hash` and `uuid`.
* `type`: **Optional**. The type for VIDs. The default value is `string`.
* `prefix`: **Optional**. Add prefix to the original vid. When `function` is specified also, `prefix` is applied to the original vid before `function`.

##### `schema.vertex.tags`
Expand Down
3 changes: 3 additions & 0 deletions docs/configuration-reference.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,10 @@
| files[0].schema.edge | Edge options | - |
| files[0].schema.edge.srcVID.index | Column index of source vertex id of edge | 0 |
| files[0].schema.edge.srcVID.function | The generation function of edge source vertex id | "" |
| files[0].schema.edge.srcVID.type | Type of source vertex id of edge | 0 |
| files[0].schema.edge.dstVID.index | Column index of destination vertex id of edge | 1 |
| files[0].schema.edge.dstVID.function | The generation function of edge destination vertex id | "" |
| files[0].schema.edge.dstVID.type | Type of destination vertex id of edge | 1 |
| files[0].schema.edge.rank.index | Column index of the edge rank | 2 |
| files[0].schema.edge.name | Edge name in above space | "" |
| files[0].schema.edge.props | Properties of the edge | - |
Expand All @@ -45,6 +47,7 @@
| files[0].schema.vertex | Vertex options | - |
| files[0].schema.vertex.vid.index | Column index of vertex vid | 0 |
| files[0].schema.vertex.vid.function | The generation function of vertex vid | "" |
| files[0].schema.vertex.vid.type | The type of vertex vid | "string" |
| files[0].schema.vertex.tags | Vertex tags options | - |
| files[0].schema.vertex.tags[0].name | Vertex tag name | "" |
| files[0].schema.vertex.tags[0].props | Vertex tag's properties | - |
Expand Down

0 comments on commit 1faf91f

Please sign in to comment.