Source: https://dev-docs.yueshu.com.cn/v5.3.2/clients/spark-connector/config/spark-options/
Documentation version: v5.3.2

# 配置类

本文介绍可用于配置悦数图数据库开发版读写操作的配置类：

- `NebulaConnectionConfig`：用于连接悦数图数据库开发版。
- `WriteNebulaNodeConfig`：用于将点写入悦数图数据库开发版。
- `WriteNebulaEdgeConfig`：用于将边写入悦数图数据库开发版。
- `ReadNebulaConfig`：用于从悦数图数据库开发版读取数据。

## `NebulaConnectionConfig`

 | 方法名 | 描述 | 是否必选 | 默认值 | 数据类型 | 引入版本
 | `withGraphAddress` | Graph 服务的 IP 地址和端口。多个条目需用英文逗号（,）分隔。例如：`ip1:port1,ip2:port2,...` | 是 | 无 | String | 5.0
 | `withUser` | 访问 Graph 服务的用户名。 | 是 | 无 | String | 5.0
 | `withPasswd` | 验证用户的密码。 | 是 | 无 | String | 5.0
 | `withTimeoutSec` | 读写请求的连接超时时间（秒）。 | 否 | 5 | Integer | 5.0
 | `withPingTimeoutSec` | 通过 ping 检测 Graph 服务的超时时间（秒）。 | 否 | 3 | Integer | 5.2
 | `withExecuteRetry` | 连接失败时的重试次数。 | 否 | 3 | Integer | 5.0
 | `withExecuteRetryIntervalMs` | 重试之间的时间间隔（毫秒）。 | 否 | 0 | Integer | 5.0
 | `withEnableTls` | 是否启用 TLS 加密。 | 否 | false | Bool | 5.1
 | `withDisableVerifyServerCert` | 是否禁用服务器证书校验。 | 否 | false | Bool | 5.1
 | `withTlsCaPath` | 用于校验服务器证书的 CA 证书文件的路径。如果`withEnableTls`设置为`true`且`withDisableVerifyServerCert`设置为`false`，则此项必填。 | 否 | 无 | String | 5.1
 | `withTlsCertPath` | 客户端证书文件的路径。如果悦数图数据库开发版的 Graph 服务的配置文件里将`tls_client_verify`设置为`true`，则此项必填。 | 否 | 无 | String | 5.1
 | `withTlsKeyPath` | 客户端私钥文件的路径。如果悦数图数据库开发版的 Graph 服务的配置文件里将`tls_client_verify`设置为`true`，则此项必填。 | 否 | 无 | String | 5.1

## `WriteNebulaNodeConfig`

 | 方法名 | 描述 | 是否必选 | 默认值 | 数据类型 | 引入版本
 | `withGraphName` | 待写入数据的图的名称。 | 是 | 无 | String | 5.0
 | `withSchema` | 包含待写入数据的图的 Schema。 | 否 | `/default_schema` | String | 5.0
 | `withDateFormat` | 当前会话的日期格式。若未指定，则使用悦数图数据库开发版中默认的日期格式。 | 否 | 无 | String | 5.1
 | `withZonedDatetimeFormat` | 当前会话的时区日期时间格式。若未指定，则使用悦数图数据库开发版中默认的时区日期时间格式。 | 否 | 无 | String | 5.0
 | `withLocalDatetimeFormat` | 当前会话的本地日期时间格式。若未指定，则使用悦数图数据库开发版中默认的本地日期时间格式。 | 否 | 无 | String | 5.0
 | `withZonedTimeFormat` | 当前会话的时区时间格式。若未指定，则使用悦数图数据库开发版中默认的时区时间格式。 | 否 | 无 | String | 5.0
 | `withLocalTimeFormat` | 当前会话的本地时间格式。若未指定，则使用悦数图数据库开发版中默认的本地时间格式。 | 否 | 无 | String | 5.0
 | `withNodeType` | 待写入数据的点类型。 | 是 | 无 | String | 5.0
 | `withWriteMode` | 写入模式。有效值为`INSERT`、`INSERTIGNORE`、`INSERTREPLACE`、`INSERTUPDATE`、`UPDATE`、`DELETE`和`DETACHDELETE`。 | 否 | `INSERT` | WriteMode | 5.0
 | `withBatchSize` | 每次最多写入的点数。 | 否 | 512 | Integer | 5.0
 | `withDisableWriteLog` | 是否在写入过程中禁用日志记录。如果设置为`true`，则成功写入时不会有日志记录。 | 否 | false | Bool | 5.0

## `WriteNebulaEdgeConfig`

 | 方法名 | 描述 | 是否必选 | 默认值 | 数据类型 | 引入版本
 | `withGraphName` | 待写入数据的图的名称。 | 是 | 无 | String | 5.0
 | `withSchema` | 包含待写入数据的图的 Schema。 | 否 | `/default_schema` | String | 5.0
 | `withDateFormat` | 当前会话的日期格式。若未指定，则使用悦数图数据库开发版中默认的日期格式。 | 否 | 无 | String | 5.1
 | `withZonedDatetimeFormat` | 当前会话的时区日期时间格式。若未指定，则使用悦数图数据库开发版中默认的时区日期时间格式。 | 否 | 无 | String | 5.0
 | `withLocalDatetimeFormat` | 当前会话的本地日期时间格式。若未指定，则使用悦数图数据库开发版中默认的本地日期时间格式。 | 否 | 无 | String | 5.0
 | `withZonedTimeFormat` | 当前会话的时区时间格式。若未指定，则使用悦数图数据库开发版中默认的时区时间格式。 | 否 | 无 | String | 5.0
 | `withLocalTimeFormat` | 当前会话的本地时间格式。若未指定，则使用悦数图数据库开发版中默认的本地时间格式。 | 否 | 无 | String | 5.0
 | `withEdgeType` | 待写入数据的边类型。 | 是 | 无 | String | 5.0
 | `withSrcPkField` | DataFrame 中用作边类型的起始点类型的主键的单一列。仅在主键由一个属性构成时使用此方法。 | 否 | 无 | String | 5.0
 | `withSrcPkFields` | DataFrame 中用作边类型的起始点类型的主键的单一或多个列。如果未指定`withSrcPkField`，则必须使用此方法。 | 否 | 无 | List | 5.0
 | `withDstPkField` | DataFrame 中用作边类型的目标点类型的主键的单一列。仅在主键由一个属性构成时使用此方法。 | 否 | 无 | String | 5.0
 | `withDstPkFields` | DataFrame 中用作边类型的目标点类型的主键的单一或多个列。如果未指定`withDstPkField`，则必须使用此方法。 | 否 | 无 | List | 5.0
 | `withSrcPkAsProperty` | 是否将用作边类型的起始点类型的主键的单一或多个列写作边类型的单一或多个属性。 | 否 | false | Bool | 5.0
 | `withDstPkAsProperty` | 是否将用作边类型的目标点类型的主键的单一或多个列写作边类型的单一或多个属性。 | 否 | false | Bool | 5.0
 | `withWriteMode` | 写入模式。有效值为`INSERT`、`INSERTIGNORE`、`INSERTREPLACE`、`INSERTUPDATE`、`UPDATE`、`DELETE`和`DETACHDELETE`。 | 否 | `INSERT` | WriteMode | 5.0
 | `withBatchSize` | 每次最多写入的边数。 | 否 | 512 | Integer | 5.0
 | `withDisableWriteLog` | 是否在写入过程中禁用日志记录。如果设置为`true`，则成功写入时不会有日志记录。 | 否 | false | Bool | 5.0

## `ReadNebulaConfig`

 | 方法名 | 描述 | 是否必选 | 默认值 | 数据类型 | 引入版本
 | `withGraphName` | 从中读取数据的图的名称。 | 是 | 无 | String | 5.0
 | `withSchema` | 包含要读取数据的图的 Schema。 | 否 | `/default_schema` | String | 5.0
 | `withTypeName` | 从中读取数据的点类型或边类型。 | 是 | 无 | String | 5.0
 | `withReturnCols` | 要读取的属性列表。
如果未指定或设置为`null`，则读取点或边类型的所有属性。
如果对点类型设置为空列表，则只读取点类型的主键的属性。
如果对边类型设置为空列表，则只读取边类型的起始点类型和目标点类型的主键的属性。 | 否 | `null` | List | 5.0
 | `withPartitionNum` | 并行读取数据的 Spark 分片数。该值不能大于图中设置的分片数。 | 否 | 10 | Integer | 5.0
 | `withBatchSize` | 每次请求中读取的最大数据条目数。 | 否 | 2000 | Integer | 5.0