SqlDWSink Class

A copy activity SQL Data Warehouse sink.

Constructor

SqlDWSink(*args: Any, **kwargs: Any)

Variables

Name Description
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.
type
str

Copy sink type. Required. Default value is "SqlDWSink".

Attributes

allow_copy_command

boolean (or Expression with resultType boolean).

allow_copy_command: Any | None

allow_poly_base

boolean (or Expression with resultType boolean).

allow_poly_base: Any | None

copy_command_settings

Specifies Copy Command related settings when allowCopyCommand is true.

copy_command_settings: _models.DWCopyCommandSettings | None

poly_base_settings

Specifies PolyBase-related settings when allowPolyBase is true.

poly_base_settings: _models.PolybaseSettings | None

pre_copy_script

string (or Expression with resultType string).

pre_copy_script: Any | None

sql_writer_use_table_lock

boolean (or Expression with resultType boolean).

sql_writer_use_table_lock: Any | None

table_option

The option to handle sink table, such as autoCreate. For now only 'autoCreate' value is supported. Type: string (or Expression with resultType string).

table_option: Any | None

type

Copy sink type. Required. Default value is "SqlDWSink".

type: Literal['SqlDWSink']

upsert_settings

SQL DW upsert settings.

upsert_settings: _models.SqlDWUpsertSettings | None

write_behavior

SqlDWWriteBehaviorEnum (or Expression with resultType SqlDWWriteBehaviorEnum).

write_behavior: Any | None