Package version:

Interface AzureSqlSink

A copy activity Azure SQL sink.

interface AzureSqlSink {
    disableMetricsCollection?: any;
    maxConcurrentConnections?: any;
    preCopyScript?: any;
    sinkRetryCount?: any;
    sinkRetryWait?: any;
    sqlWriterStoredProcedureName?: any;
    sqlWriterTableType?: any;
    sqlWriterUseTableLock?: any;
    storedProcedureParameters?: any;
    storedProcedureTableTypeParameterName?: any;
    tableOption?: any;
    type: "AzureSqlSink";
    upsertSettings?: SqlUpsertSettings;
    writeBatchSize?: any;
    writeBatchTimeout?: any;
    writeBehavior?: any;
}

Hierarchy (view full)

Properties

disableMetricsCollection? maxConcurrentConnections? preCopyScript? sinkRetryCount? sinkRetryWait? sqlWriterStoredProcedureName? sqlWriterTableType? sqlWriterUseTableLock? storedProcedureParameters? storedProcedureTableTypeParameterName? tableOption? type upsertSettings? writeBatchSize? writeBatchTimeout? writeBehavior?

Properties

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).

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])).

OptionalsqlWriterStoredProcedureName

sqlWriterStoredProcedureName?: any

SQL writer stored procedure name. Type: string (or Expression with resultType string).

OptionalsqlWriterTableType

sqlWriterTableType?: any

SQL writer table type. Type: string (or Expression with resultType string).

OptionalsqlWriterUseTableLock

sqlWriterUseTableLock?: any

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

OptionalstoredProcedureParameters

storedProcedureParameters?: any

SQL stored procedure parameters.

OptionalstoredProcedureTableTypeParameterName

storedProcedureTableTypeParameterName?: any

The stored procedure parameter name of the table type. Type: string (or Expression with resultType string).

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?: SqlUpsertSettings

SQL 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. Type: SqlWriteBehaviorEnum (or Expression with resultType SqlWriteBehaviorEnum)

Settings

Member Visibility