Writer options

The following table lists the options that you can use to configure the writer.

Option	Description	Required	Default value	Introduced in
type	The type of the writer. Valid values: node and edge.	Yes	N/A	5.0
operate_type	The operation type of the writer. Valid value: write.	Yes	N/A	5.0
graph_address	The IP address and port of the Graph service. Separate multiple entries with commas (,). For example: ip1:port1,ip2:port2,...	Yes	N/A	5.0
user	The username of the Graph service.	No	root	5.0
passwd	The password used to authenticate a user.	Yes	N/A	5.0
schema	The schema that contains the graph to which data is written.	No	/default_schema	5.0
graph_name	The name of the graph to which data is written.	Yes	N/A	5.0
date_format	The date format to be set in the session. If not specified, the date format set in NebulaGraph Database Developer Edition is used.	No	N/A	5.1
zoned_datetime_format	The zoned datetime format to be set in the session. If not specified, the zoned datetime format set in NebulaGraph Database Developer Edition is used.	No	N/A	5.0
local_datetime_format	The local datetime format to be set in the session. If not specified, the local datetime format set in NebulaGraph Database Developer Edition is used.	No	N/A	5.0
zoned_time_format	The zoned time format to be set in the session. If not specified, the zoned time format set in NebulaGraph Database Developer Edition is used.	No	N/A	5.0
local_time_format	The local time format to be set in the session. If not specified, the local time format set in NebulaGraph Database Developer Edition is used.	No	N/A	5.0
label	The name of the node type or edge type to which data is written. Required if type is set to node or edge.	No	N/A	5.0
src_pk_field	The one or more columns in the DataFrame that serve as the primary key of the source node type of the edge type. Required if type is set to edge.	No	N/A	5.0
dst_pk_field	The one or more columns in the DataFrame that serve as the primary key of the destination node type of the edge type. Required if type is set to edge.	No	N/A	5.0
src_pk_as_prop	Whether the one or more columns that serve as the primary key of the source node type of the edge type are written as one or more properties of the edge type. Required if type is set to edge.	No	N/A	5.0
dst_pk_as_prop	Whether the one or more columns that serve as the primary key of the destination node type of the edge type are written as one or more properties of the edge type. Required if type is set to edge.	No	N/A	5.0
write_mode	The write mode. Valid values: insert, insert_ignore, insert_replace, insert_update, update, delete, and detach_delete.	No	insert	5.0
batch_size	The maximum number of data entries to write in each request. Required if type is set to node or edge.	No	1000	5.0
disable_write_log	Whether to disable logging during the write process. If set to true, logging is disabled for successful writes.	No	false	5.0
timeout	The connection timeout for write requests in seconds.	No	3	5.0
execution_retry	The number of retries when a connection fails.	No	3	5.0
execution_retry_interval	The interval between retries in milliseconds.	No	0	5.0
enable_tls	Whether to enable TLS encryption.	No	false	5.1
disable_verify_server_cert	Whether to disable server certificate verification.	No	false	5.1
tlsCa	The path to the CA (Certificate Authority) certificate file, which is used to verify the server's certificate. Required if enable_tls is set to true and disable_verify_server_cert is set to false.	No	N/A	5.1
tlsCert	The path to the certificate file of the client. Required if tls_client_verify is set to true in the configuration file of NebulaGraph Database Developer Edition's Graph service.	No	N/A	5.1
tlsKey	The path to the private key file of the client. Required if tls_client_verify is set to true in the configuration file of NebulaGraph Database Developer Edition's Graph service.	No	N/A	5.1