Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add desc for flink sql #100

Merged
merged 1 commit into from
Apr 8, 2024
Merged

add desc for flink sql #100

merged 1 commit into from
Apr 8, 2024

Conversation

Nicole00
Copy link
Contributor

@Nicole00 Nicole00 commented Apr 8, 2024

descriptions for flink streaming api:

NebulaClientOptions 是连接NebulaGraph的配置,说明如下:

  • setGraphAddress: graph server address, 类型string
  • setMetaAddress: meta server address, 类型string

VertexExecutionOptions 是执行点读写的配置,说明如下:

  • setGraphSpace:graph space name
  • setTag:graph tag name
  • (写) setIdIndex:作为vertex id的flink streaming数据字段下标,类型:int,无默认值
  • (写) setFields:graph tag/edge 属性名集合,表示向这些fields中写入数据 或从NebulaGraph中读取这些属性,类型:list,无默认值
  • (写) setPositions:flink streaming 数据字段下标集合,表示将flink streaming 这些数据写入NebulaGraph,类型:list,无默认值
  • (写) setBatchSize:写入NebulaGraph时一次写入请求的数据集大小,类型:int,默认值为2000,非必须配置.
  • (读) setNoColumn:不读取属性,类型:boolean,默认值为false,非必须配置
  • (读) setFields:读取tag的指定属性集合,类型:list,无默认值。若setNoColumn为true,则该配置无效。若setNoColumn为false且setFields为空list,则读取全部属性。
  • (读) setLimit:读取tag数据时每次请求服务端拉取的数据条数,类型:int,默认值为2000,非必须配置。

EdgeExecutionOptions 是执行边读写的配置,说明如下:

  • setGraphSpace:graph space name
  • setEdge:graph edge name
  • (写) setSrcIndex:作为edge src id 的flink streaming数据字段下标,类型:int,无默认值
  • (写) setDstIndex:作为edge dst id 的flink streaming数据字段下标,类型:int,无默认值
  • (写) setRankIndex:作为edge rank 的flink streaming数据字段下标,类型:int,无默认值
  • (写) setFields:graph tag/edge 属性名集合,表示向这些fields中写入数据 或从NebulaGraph中读取这些属性,类型list,无默认值
  • (写) setPositions:flink streaming 数据字段下标集合,表示将flink streaming 这些数据写入NebulaGraph,类型list,无默认值
  • (写) setBatchSize:写入NebulaGraph时一次写入请求的数据集大小,类型int,默认为2000,非必须配置.
  • (读) setNoColumn:不读取属性,类型:boolean,默认值为false,非必须配置
  • (读) setFields:读取edge的指定属性集合,类型:list,无默认值。若setNoColumn为true,则该配置无效。若setNoColumn为false且setFields为空list,则读取全部属性。
  • (读) setLimit:读取tag数据时每次请求服务端拉取的数据条数,类型:int,默认值为2000,非必须配置。

@Nicole00 Nicole00 merged commit 94c76e2 into vesoft-inc:master Apr 8, 2024
2 checks passed
@Nicole00 Nicole00 deleted the readme branch April 8, 2024 07:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants