SqlDWSink Class

A copy activity SQL Data Warehouse sink.

All required parameters must be populated in order to send to Azure.

Inheritance

azure.mgmt.datafactory.models._models_py3.CopySink

SqlDWSink

Constructor

SqlDWSink(*, additional_properties: Optional[Dict[str, Any]] = None, write_batch_size: Optional[Any] = None, write_batch_timeout: Optional[Any] = None, sink_retry_count: Optional[Any] = None, sink_retry_wait: Optional[Any] = None, max_concurrent_connections: Optional[Any] = None, disable_metrics_collection: Optional[Any] = None, pre_copy_script: Optional[Any] = None, allow_poly_base: Optional[Any] = None, poly_base_settings: Optional[_models.PolybaseSettings] = None, allow_copy_command: Optional[Any] = None, copy_command_settings: Optional[_models.DWCopyCommandSettings] = None, table_option: Optional[Any] = None, sql_writer_use_table_lock: Optional[Any] = None, write_behavior: Optional[Any] = None, upsert_settings: Optional[_models.SqlDWUpsertSettings] = None, **kwargs)

Variables

additional_properties

dict[str, any]

Unmatched properties from the message are deserialized to this collection.

type

str

Required. Copy sink type.Constant filled by server.

write_batch_size

any

Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.

write_batch_timeout

any

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

any

Sink retry count. Type: integer (or Expression with resultType integer).

sink_retry_wait

any

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

any

The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).

disable_metrics_collection

any

If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).

pre_copy_script

any

SQL pre-copy script. Type: string (or Expression with resultType string).

allow_poly_base

any

Indicates to use PolyBase to copy data into SQL Data Warehouse when applicable. Type: boolean (or Expression with resultType boolean).

poly_base_settings

PolybaseSettings

Specifies PolyBase-related settings when allowPolyBase is true.

allow_copy_command

any

Indicates to use Copy Command to copy data into SQL Data Warehouse. Type: boolean (or Expression with resultType boolean).

copy_command_settings

DWCopyCommandSettings

Specifies Copy Command related settings when allowCopyCommand is true.

table_option

any

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

any

Whether to use table lock during bulk copy. Type: boolean (or Expression with resultType boolean).

write_behavior

any

Write behavior when copying data into azure SQL DW. Type: SqlDWWriteBehaviorEnum (or Expression with resultType SqlDWWriteBehaviorEnum).

upsert_settings

SqlDWUpsertSettings

SQL DW upsert settings.