Package version:

Interface SqlDWSink

A copy activity SQL Data Warehouse sink.

interface SqlDWSink {
    allowCopyCommand?: any;
    allowPolyBase?: any;
    copyCommandSettings?: DWCopyCommandSettings;
    disableMetricsCollection?: any;
    maxConcurrentConnections?: any;
    polyBaseSettings?: PolybaseSettings;
    preCopyScript?: any;
    sinkRetryCount?: any;
    sinkRetryWait?: any;
    sqlWriterUseTableLock?: any;
    tableOption?: any;
    type: "SqlDWSink";
    upsertSettings?: SqlDWUpsertSettings;
    writeBatchSize?: any;
    writeBatchTimeout?: any;
    writeBehavior?: any;
}

Hierarchy (view full)

Properties

allowCopyCommand? allowPolyBase? copyCommandSettings? disableMetricsCollection? maxConcurrentConnections? polyBaseSettings? preCopyScript? sinkRetryCount? sinkRetryWait? sqlWriterUseTableLock? tableOption? type upsertSettings? writeBatchSize? writeBatchTimeout? writeBehavior?

Properties

OptionalallowCopyCommand

allowCopyCommand?: any

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

OptionalallowPolyBase

allowPolyBase?: any

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

OptionalcopyCommandSettings

copyCommandSettings?: DWCopyCommandSettings

Specifies Copy Command related settings when allowCopyCommand is true.

OptionaldisableMetricsCollection

disableMetricsCollection?: any

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

OptionalmaxConcurrentConnections

maxConcurrentConnections?: any

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

OptionalpolyBaseSettings

polyBaseSettings?: PolybaseSettings

Specifies PolyBase-related settings when allowPolyBase is true.

OptionalpreCopyScript

preCopyScript?: any

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

OptionalsinkRetryCount

sinkRetryCount?: any

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

OptionalsinkRetryWait

sinkRetryWait?: any

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

OptionalsqlWriterUseTableLock

sqlWriterUseTableLock?: any

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

OptionaltableOption

tableOption?: any

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

type

type

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

OptionalupsertSettings

upsertSettings?: SqlDWUpsertSettings

SQL DW upsert settings.

OptionalwriteBatchSize

writeBatchSize?: any

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

OptionalwriteBatchTimeout

writeBatchTimeout?: any

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

OptionalwriteBehavior

writeBehavior?: any

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

Settings

Member Visibility