AzureSqlSink interface
A copy activity Azure SQL sink.
- Extends
Properties
pre |
SQL pre-copy script. Type: string (or Expression with resultType string). |
sql |
SQL writer stored procedure name. Type: string (or Expression with resultType string). |
sql |
SQL writer table type. Type: string (or Expression with resultType string). |
sql |
Whether to use table lock during bulk copy. Type: boolean (or Expression with resultType boolean). |
stored |
SQL stored procedure parameters. |
stored |
The stored procedure parameter name of the table type. Type: string (or Expression with resultType string). |
table |
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 |
upsert |
SQL upsert settings. |
write |
Write behavior when copying data into Azure SQL. Type: SqlWriteBehaviorEnum (or Expression with resultType SqlWriteBehaviorEnum) |
Inherited Properties
disable |
If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). |
max |
The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer). |
sink |
Sink retry count. Type: integer (or Expression with resultType integer). |
sink |
Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). |
write |
Write batch size. Type: integer (or Expression with resultType integer), minimum: 0. |
write |
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
Polymorphic discriminator, which specifies the different types this object can be
type: "AzureSqlSink"
Property Value
"AzureSqlSink"
upsertSettings
writeBehavior
Write behavior when copying data into Azure SQL. Type: SqlWriteBehaviorEnum (or Expression with resultType SqlWriteBehaviorEnum)
writeBehavior?: any
Property Value
any
Inherited Property Details
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