SqlSink Class
A copy activity SQL sink.
All required parameters must be populated in order to send to server.
Constructor
SqlSink(*, additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, write_batch_size: MutableMapping[str, Any] | None = None, write_batch_timeout: MutableMapping[str, Any] | None = None, sink_retry_count: MutableMapping[str, Any] | None = None, sink_retry_wait: MutableMapping[str, Any] | None = None, max_concurrent_connections: MutableMapping[str, Any] | None = None, disable_metrics_collection: MutableMapping[str, Any] | None = None, sql_writer_stored_procedure_name: MutableMapping[str, Any] | None = None, sql_writer_table_type: MutableMapping[str, Any] | None = None, pre_copy_script: MutableMapping[str, Any] | None = None, stored_procedure_parameters: MutableMapping[str, Any] | None = None, stored_procedure_table_type_parameter_name: MutableMapping[str, Any] | None = None, table_option: MutableMapping[str, Any] | None = None, sql_writer_use_table_lock: MutableMapping[str, Any] | None = None, write_behavior: MutableMapping[str, Any] | None = None, upsert_settings: _models.SqlUpsertSettings | None = None, **kwargs: Any)Keyword-Only Parameters
| Name | Description |
|---|---|
|
additional_properties
|
Unmatched properties from the message are deserialized to this collection. Default value: None
|
|
write_batch_size
|
<xref:JSON>
Write batch size. Type: integer (or Expression with resultType integer), minimum: 0. Default value: None
|
|
write_batch_timeout
|
<xref:JSON>
Write batch timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])). Default value: None
|
|
sink_retry_count
|
<xref:JSON>
Sink retry count. Type: integer (or Expression with resultType integer). Default value: None
|
|
sink_retry_wait
|
<xref:JSON>
Sink retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])). Default value: None
|
|
max_concurrent_connections
|
<xref:JSON>
The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer). Default value: None
|
|
disable_metrics_collection
|
<xref:JSON>
If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). Default value: None
|
|
sql_writer_stored_procedure_name
|
<xref:JSON>
SQL writer stored procedure name. Type: string (or Expression with resultType string). Default value: None
|
|
sql_writer_table_type
|
<xref:JSON>
SQL writer table type. Type: string (or Expression with resultType string). Default value: None
|
|
pre_copy_script
|
<xref:JSON>
SQL pre-copy script. Type: string (or Expression with resultType string). Default value: None
|
|
stored_procedure_parameters
|
<xref:JSON>
SQL stored procedure parameters. Default value: None
|
|
stored_procedure_table_type_parameter_name
|
<xref:JSON>
The stored procedure parameter name of the table type. Type: string (or Expression with resultType string). Default value: None
|
|
table_option
|
<xref:JSON>
The option to handle sink table, such as autoCreate. For now only 'autoCreate' value is supported. Type: string (or Expression with resultType string). Default value: None
|
|
sql_writer_use_table_lock
|
<xref:JSON>
Whether to use table lock during bulk copy. Type: boolean (or Expression with resultType boolean). Default value: None
|
|
write_behavior
|
<xref:JSON>
Write behavior when copying data into sql. Type: string (or Expression with resultType string). Default value: None
|
|
upsert_settings
|
SQL upsert settings. Default value: None
|
Variables
| Name | Description |
|---|---|
|
additional_properties
|
Unmatched properties from the message are deserialized to this collection. |
|
type
|
Copy sink type. Required. |
|
write_batch_size
|
<xref:JSON>
Write batch size. Type: integer (or Expression with resultType integer), minimum: 0. |
|
write_batch_timeout
|
<xref:JSON>
Write batch timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])). |
|
sink_retry_count
|
<xref:JSON>
Sink retry count. Type: integer (or Expression with resultType integer). |
|
sink_retry_wait
|
<xref:JSON>
Sink retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])). |
|
max_concurrent_connections
|
<xref:JSON>
The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer). |
|
disable_metrics_collection
|
<xref:JSON>
If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). |
|
sql_writer_stored_procedure_name
|
<xref:JSON>
SQL writer stored procedure name. Type: string (or Expression with resultType string). |
|
sql_writer_table_type
|
<xref:JSON>
SQL writer table type. Type: string (or Expression with resultType string). |
|
pre_copy_script
|
<xref:JSON>
SQL pre-copy script. Type: string (or Expression with resultType string). |
|
stored_procedure_parameters
|
<xref:JSON>
SQL stored procedure parameters. |
|
stored_procedure_table_type_parameter_name
|
<xref:JSON>
The stored procedure parameter name of the table type. Type: string (or Expression with resultType string). |
|
table_option
|
<xref:JSON>
The option to handle sink table, such as autoCreate. For now only 'autoCreate' value is supported. Type: string (or Expression with resultType string). |
|
sql_writer_use_table_lock
|
<xref:JSON>
Whether to use table lock during bulk copy. Type: boolean (or Expression with resultType boolean). |
|
write_behavior
|
<xref:JSON>
Write behavior when copying data into sql. Type: string (or Expression with resultType string). |
|
upsert_settings
|
SQL upsert settings. |
