Flink 连接器配置

本文介绍悦数图数据库开发版 Flink 连接器的配置，包括以下类：

• ConnectionOptions：用于连接悦数图数据库开发版。
• SinkNodeOptions：用于将数据写入悦数图数据库开发版的指定点类型。
• SinkEdgeOptions：用于将数据写入悦数图数据库开发版的指定边类型。
• SourceExecutionOptions：用于从悦数图数据库开发版读取数据。包含SourceNodeOptions和SourceEdgeOptions两个类。

ConnectionOptions

方法名	描述	是否必选	默认值	数据类型	引入版本
withGraphAddress	Graph 服务的 IP 地址和端口。多个条目需用英文逗号（,）分隔。例如：ip1:port1,ip2:port2,...	是	无	String	5.2
withUser	访问 Graph 服务的用户名。	是	无	String	5.2
withPassword	验证用户的密码。	否	无	String	5.2
withAuthInfo	存储与管理认证信息的映射集合。	否	空	Map	5.2
withConnectionTimeout	连接超时时间（毫秒）	否	3000	Integer	5.2
withRequestTimeout	请求超时时间（毫秒）	否	5000	Integer	5.2
withSchema	包含待写入数据的图的 Schema。	否	无	String	5.2
withTimeZone	当前会话的时区。若未指定，则使用悦数图数据库开发版中默认的时区。	否	无	ZoneId	5.2
withDateFormat	当前会话的日期格式。若未指定，则使用悦数图数据库开发版中默认的日期格式。	否	无	String	5.2
withZonedDatetimeFormat	当前会话的时区日期时间格式。若未指定，则使用悦数图数据库开发版中默认的时区日期时间格式。	否	无	String	5.2
withLocalDatetimeFormat	当前会话的本地日期时间格式。若未指定，则使用悦数图数据库开发版中默认的本地日期时间格式。	否	无	String	5.2
withZonedTimeFormat	当前会话的时区时间格式。若未指定，则使用悦数图数据库开发版中默认的时区时间格式。	否	无	String	5.2
withLocalTimeFormat	当前会话的本地时间格式。若未指定，则使用悦数图数据库开发版中默认的本地时间格式。	否	无	String	5.2
withEnableTls	是否启用 TLS 加密。	否	false	Boolean	5.2
withDisableVerifyServerCertificate	是否禁用服务器证书校验。	否	false	Boolean	5.2
withTlsCaPath	用于校验服务器证书的 CA 证书文件的路径。如果withEnableTls设置为true且withDisableVerifyServerCertificate设置为false，则此项必填。	否	无	String	5.2
withTlsCertPath	客户端证书文件的路径。如果悦数图数据库开发版的 Graph 服务的配置文件里将tls_client_verify设置为true，则此项必填。	否	无	String	5.2
withTlsKeyPath	客户端私钥文件的路径。如果悦数图数据库开发版的 Graph 服务的配置文件里将tls_client_verify设置为true，则此项必填。	否	无	String	5.2

SinkNodeOptions

方法名	描述	是否必选	默认值	数据类型	引入版本
withGraphName	待写入数据的图的名称。	否	无	String	5.2
withNodeType	待写入数据的点类型。	否	无	String	5.2
withFlinkFields	Flink 数据流中的字段列表。	是	空	List	5.2
withNebulaFields	悦数图数据库开发版中对应的属性列表。	是	空	List	5.2
withWriteMode	写入模式。有效值为INSERT、INSERTIGNORE、INSERTREPLACE、INSERTUPDATE、UPDATE、DELETE和DETACHDELETE。	否	INSERTREPLACE	WriteModeEnum	5.2
withBatchSize	每次最多写入的点数。	否	2000	Integer	5.2
withRetryTimes	当写入数据失败时，最多重试的次数。	否	0	Integer	5.2
withIntervalMs	每次重试之间的等待时间（毫秒）。	否	0	Long	5.2
withGqlTemplate	自定义 GQL 模板。设置后，连接器将使用该模板生成写入 GQL，而非内置的生成逻辑。模板中必须包含{{ TABLE }}占位符。可用占位符包括{{ TABLE }}（TABLE 子句，必填）、{{ GRAPH }}（图名称）、{{ TYPE }}（点类型名称）。	否	无	String	5.3

SinkEdgeOptions

方法名	描述	是否必选	默认值	数据类型	引入版本
withGraphName	待写入数据的图的名称。	否	无	String	5.2
withEdgeType	待写入数据的边类型。	否	无	String	5.2
withFlinkSrcPkFields	Flink 数据流中用作边类型的起始点类型主键的字段列表。	是	空	List	5.2
withNebulaSrcPks	悦数图数据库开发版中对应的用作边类型的起始点类型的主键的属性列表。	是	空	List	5.2
withFlinkDstPkFields	Flink 数据流中用作边类型的目标点类型主键的字段列表。	是	空	List	5.2
withNebulaDstPks	悦数图数据库开发版中对应的用作边类型的目标点类型的主键的属性列表。	是	空	List	5.2
withFlinkFields	Flink 数据流中的字段列表。	是	空	List	5.2
withNebulaFields	悦数图数据库开发版中对应的属性列表。	是	空	List	5.2
withWriteMode	写入模式。有效值为INSERT、INSERTIGNORE、INSERTREPLACE、INSERTUPDATE、UPDATE、DELETE和DETACHDELETE。	否	INSERTREPLACE	WriteModeEnum	5.2
withBatchSize	每次最多写入的边数。	否	2000	Integer	5.2
withRetryTimes	当写入数据失败时，最多重试的次数。	否	0	Integer	5.2
withIntervalMs	每次重试之间的等待时间（毫秒）。	否	0	Long	5.2
withGqlTemplate	自定义 GQL 模板。设置后，连接器将使用该模板生成写入 GQL，而非内置的生成逻辑。模板中必须包含{{ TABLE }}占位符。可用占位符包括{{ TABLE }}（TABLE 子句，必填）、{{ GRAPH }}（图名称）、{{ TYPE }}（边类型名称）。	否	无	String	5.3

SourceExecutionOptions

方法名	描述	是否必选	默认值	数据类型	引入版本
withGraphName	从中读取数据的图的名称。	是	无	String	5.2
withNodeType或withEdgeType	从中读取数据的点类型或边类型。	是	无	String	5.2
withReturnCols	要读取的属性列表。 如果未指定或设置为null，则读取点或边类型的所有属性。 如果对点类型设置为空列表，则只读取点类型的主键的属性。 如果对边类型设置为空列表，则只读取边类型的起始点类型和目标点类型的主键的属性。	否	空	List	5.2
withBatchSize	每次请求中读取的最大数据条目数。	否	2000	Integer	5.2