SqlServerSink interface

Package:
@azure/arm-datafactory

A copy activity SQL server sink.

Extends
CopySink

Properties

preCopyScript

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

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

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

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

SQL stored procedure parameters.
storedProcedureTableTypeParameterName

The stored procedure parameter name of the table type. 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

Copy sink type.
upsertSettings

SQL upsert settings.
writeBehavior

Write behavior when copying data into sql server. Type: string (or Expression with resultType string).

Inherited Properties

additionalProperties

Additional properties
disableMetricsCollection

If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
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

preCopyScript

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

preCopyScript?: any

Property Value

any

sqlWriterStoredProcedureName

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

sqlWriterStoredProcedureName?: any

Property Value

any

sqlWriterTableType

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

sqlWriterTableType?: any

Property Value

any

sqlWriterUseTableLock

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

sqlWriterUseTableLock?: any

Property Value

any

storedProcedureParameters

SQL stored procedure parameters.

storedProcedureParameters?: any

Property Value

any

storedProcedureTableTypeParameterName

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

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

Copy sink type.

type: "SqlServerSink"

Property Value

"SqlServerSink"

upsertSettings

SQL upsert settings.

upsertSettings?: SqlUpsertSettings

Property Value

SqlUpsertSettings

writeBehavior

Write behavior when copying data into sql server. Type: string (or Expression with resultType string).

writeBehavior?: any

Property Value

any

Inherited Property Details

additionalProperties

Additional properties

additionalProperties?: Record<string, any>

Property Value

Record<string, any>

Inherited From CopySink.additionalProperties

disableMetricsCollection

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

disableMetricsCollection?: any

Property Value

any

Inherited From CopySink.disableMetricsCollection

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