SqlDWSink interface

Package:

@azure/synapse-artifacts

A copy activity SQL Data Warehouse sink.

Extends

CopySink

Properties

allowCopyCommand	Indicates to use Copy Command to copy data into SQL Data Warehouse. Type: boolean (or Expression with resultType boolean).
allowPolyBase	Indicates to use PolyBase to copy data into SQL Data Warehouse when applicable. Type: boolean (or Expression with resultType boolean).
copyCommandSettings	Specifies Copy Command related settings when allowCopyCommand is true.
polyBaseSettings	Specifies PolyBase-related settings when allowPolyBase is true.
preCopyScript	SQL pre-copy script. Type: string (or Expression with resultType string).
tableOption	The option to handle sink table, such as autoCreate. For now only 'autoCreate' value is supported. Type: string (or Expression with resultType string).
type	Polymorphic discriminator, which specifies the different types this object can be

Inherited Properties

maxConcurrentConnections	The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).
sinkRetryCount	Sink retry count. Type: integer (or Expression with resultType integer).
sinkRetryWait	Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).
writeBatchSize	Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.
writeBatchTimeout	Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).

Property Details

allowCopyCommand

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

allowCopyCommand?: any

Property Value

any

allowPolyBase

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

allowPolyBase?: any

Property Value

any

copyCommandSettings

Specifies Copy Command related settings when allowCopyCommand is true.

copyCommandSettings?: DWCopyCommandSettings

Property Value

DWCopyCommandSettings

polyBaseSettings

Specifies PolyBase-related settings when allowPolyBase is true.

polyBaseSettings?: PolybaseSettings

Property Value

PolybaseSettings

preCopyScript

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

preCopyScript?: any

Property Value

any

tableOption

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

tableOption?: any

Property Value

any

type

Polymorphic discriminator, which specifies the different types this object can be

type: "SqlDWSink"

Property Value

"SqlDWSink"

Inherited Property Details

maxConcurrentConnections

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

maxConcurrentConnections?: any

Property Value

any

Inherited From CopySink.maxConcurrentConnections

sinkRetryCount

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

sinkRetryCount?: any

Property Value

any

Inherited From CopySink.sinkRetryCount

sinkRetryWait

Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).

sinkRetryWait?: any

Property Value

any

Inherited From CopySink.sinkRetryWait

writeBatchSize

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

writeBatchSize?: any

Property Value

any

Inherited From CopySink.writeBatchSize

writeBatchTimeout

Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).

writeBatchTimeout?: any

Property Value

any

Inherited From CopySink.writeBatchTimeout