Class AzureSqlSink
java.lang.Object
com.azure.resourcemanager.datafactory.models.CopySink
com.azure.resourcemanager.datafactory.models.AzureSqlSink
A copy activity Azure SQL sink.
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionGet the preCopyScript property: SQL pre-copy script.Get the sqlWriterStoredProcedureName property: SQL writer stored procedure name.Get the sqlWriterTableType property: SQL writer table type.Get the sqlWriterUseTableLock property: Whether to use table lock during bulk copy.Get the storedProcedureParameters property: SQL stored procedure parameters.Get the storedProcedureTableTypeParameterName property: The stored procedure parameter name of the table type.Get the tableOption property: The option to handle sink table, such as autoCreate.Get the upsertSettings property: SQL upsert settings.void
validate()
Validates the instance.withDisableMetricsCollection
(Object disableMetricsCollection) Set the disableMetricsCollection property: If true, disable data store metrics collection.withMaxConcurrentConnections
(Object maxConcurrentConnections) Set the maxConcurrentConnections property: The maximum concurrent connection count for the sink data store.withPreCopyScript
(Object preCopyScript) Set the preCopyScript property: SQL pre-copy script.withSinkRetryCount
(Object sinkRetryCount) Set the sinkRetryCount property: Sink retry count.withSinkRetryWait
(Object sinkRetryWait) Set the sinkRetryWait property: Sink retry wait.withSqlWriterStoredProcedureName
(Object sqlWriterStoredProcedureName) Set the sqlWriterStoredProcedureName property: SQL writer stored procedure name.withSqlWriterTableType
(Object sqlWriterTableType) Set the sqlWriterTableType property: SQL writer table type.withSqlWriterUseTableLock
(Object sqlWriterUseTableLock) Set the sqlWriterUseTableLock property: Whether to use table lock during bulk copy.withStoredProcedureParameters
(Object storedProcedureParameters) Set the storedProcedureParameters property: SQL stored procedure parameters.withStoredProcedureTableTypeParameterName
(Object storedProcedureTableTypeParameterName) Set the storedProcedureTableTypeParameterName property: The stored procedure parameter name of the table type.withTableOption
(Object tableOption) Set the tableOption property: The option to handle sink table, such as autoCreate.withUpsertSettings
(SqlUpsertSettings upsertSettings) Set the upsertSettings property: SQL upsert settings.withWriteBatchSize
(Object writeBatchSize) Set the writeBatchSize property: Write batch size.withWriteBatchTimeout
(Object writeBatchTimeout) Set the writeBatchTimeout property: Write batch timeout.withWriteBehavior
(Object writeBehavior) Set the writeBehavior property: Write behavior when copying data into Azure SQL.Get the writeBehavior property: Write behavior when copying data into Azure SQL.Methods inherited from class com.azure.resourcemanager.datafactory.models.CopySink
additionalProperties, disableMetricsCollection, maxConcurrentConnections, sinkRetryCount, sinkRetryWait, withAdditionalProperties, writeBatchSize, writeBatchTimeout
-
Constructor Details
-
AzureSqlSink
public AzureSqlSink()Creates an instance of AzureSqlSink class.
-
-
Method Details
-
sqlWriterStoredProcedureName
Get the sqlWriterStoredProcedureName property: SQL writer stored procedure name. Type: string (or Expression with resultType string).- Returns:
- the sqlWriterStoredProcedureName value.
-
withSqlWriterStoredProcedureName
Set the sqlWriterStoredProcedureName property: SQL writer stored procedure name. Type: string (or Expression with resultType string).- Parameters:
sqlWriterStoredProcedureName
- the sqlWriterStoredProcedureName value to set.- Returns:
- the AzureSqlSink object itself.
-
sqlWriterTableType
Get the sqlWriterTableType property: SQL writer table type. Type: string (or Expression with resultType string).- Returns:
- the sqlWriterTableType value.
-
withSqlWriterTableType
Set the sqlWriterTableType property: SQL writer table type. Type: string (or Expression with resultType string).- Parameters:
sqlWriterTableType
- the sqlWriterTableType value to set.- Returns:
- the AzureSqlSink object itself.
-
preCopyScript
Get the preCopyScript property: SQL pre-copy script. Type: string (or Expression with resultType string).- Returns:
- the preCopyScript value.
-
withPreCopyScript
Set the preCopyScript property: SQL pre-copy script. Type: string (or Expression with resultType string).- Parameters:
preCopyScript
- the preCopyScript value to set.- Returns:
- the AzureSqlSink object itself.
-
storedProcedureParameters
Get the storedProcedureParameters property: SQL stored procedure parameters.- Returns:
- the storedProcedureParameters value.
-
withStoredProcedureParameters
Set the storedProcedureParameters property: SQL stored procedure parameters.- Parameters:
storedProcedureParameters
- the storedProcedureParameters value to set.- Returns:
- the AzureSqlSink object itself.
-
storedProcedureTableTypeParameterName
Get the storedProcedureTableTypeParameterName property: The stored procedure parameter name of the table type. Type: string (or Expression with resultType string).- Returns:
- the storedProcedureTableTypeParameterName value.
-
withStoredProcedureTableTypeParameterName
public AzureSqlSink withStoredProcedureTableTypeParameterName(Object storedProcedureTableTypeParameterName) Set the storedProcedureTableTypeParameterName property: The stored procedure parameter name of the table type. Type: string (or Expression with resultType string).- Parameters:
storedProcedureTableTypeParameterName
- the storedProcedureTableTypeParameterName value to set.- Returns:
- the AzureSqlSink object itself.
-
tableOption
Get the tableOption property: The option to handle sink table, such as autoCreate. For now only 'autoCreate' value is supported. Type: string (or Expression with resultType string).- Returns:
- the tableOption value.
-
withTableOption
Set the tableOption property: The option to handle sink table, such as autoCreate. For now only 'autoCreate' value is supported. Type: string (or Expression with resultType string).- Parameters:
tableOption
- the tableOption value to set.- Returns:
- the AzureSqlSink object itself.
-
sqlWriterUseTableLock
Get the sqlWriterUseTableLock property: Whether to use table lock during bulk copy. Type: boolean (or Expression with resultType boolean).- Returns:
- the sqlWriterUseTableLock value.
-
withSqlWriterUseTableLock
Set the sqlWriterUseTableLock property: Whether to use table lock during bulk copy. Type: boolean (or Expression with resultType boolean).- Parameters:
sqlWriterUseTableLock
- the sqlWriterUseTableLock value to set.- Returns:
- the AzureSqlSink object itself.
-
writeBehavior
Get the writeBehavior property: Write behavior when copying data into Azure SQL. Type: SqlWriteBehaviorEnum (or Expression with resultType SqlWriteBehaviorEnum).- Returns:
- the writeBehavior value.
-
withWriteBehavior
Set the writeBehavior property: Write behavior when copying data into Azure SQL. Type: SqlWriteBehaviorEnum (or Expression with resultType SqlWriteBehaviorEnum).- Parameters:
writeBehavior
- the writeBehavior value to set.- Returns:
- the AzureSqlSink object itself.
-
upsertSettings
Get the upsertSettings property: SQL upsert settings.- Returns:
- the upsertSettings value.
-
withUpsertSettings
Set the upsertSettings property: SQL upsert settings.- Parameters:
upsertSettings
- the upsertSettings value to set.- Returns:
- the AzureSqlSink object itself.
-
withWriteBatchSize
Set the writeBatchSize property: Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.- Overrides:
withWriteBatchSize
in classCopySink
- Parameters:
writeBatchSize
- the writeBatchSize value to set.- Returns:
- the CopySink object itself.
-
withWriteBatchTimeout
Set the writeBatchTimeout property: Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).- Overrides:
withWriteBatchTimeout
in classCopySink
- Parameters:
writeBatchTimeout
- the writeBatchTimeout value to set.- Returns:
- the CopySink object itself.
-
withSinkRetryCount
Set the sinkRetryCount property: Sink retry count. Type: integer (or Expression with resultType integer).- Overrides:
withSinkRetryCount
in classCopySink
- Parameters:
sinkRetryCount
- the sinkRetryCount value to set.- Returns:
- the CopySink object itself.
-
withSinkRetryWait
Set the sinkRetryWait property: Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).- Overrides:
withSinkRetryWait
in classCopySink
- Parameters:
sinkRetryWait
- the sinkRetryWait value to set.- Returns:
- the CopySink object itself.
-
withMaxConcurrentConnections
Set the maxConcurrentConnections property: The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).- Overrides:
withMaxConcurrentConnections
in classCopySink
- Parameters:
maxConcurrentConnections
- the maxConcurrentConnections value to set.- Returns:
- the CopySink object itself.
-
withDisableMetricsCollection
Set the disableMetricsCollection property: If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).- Overrides:
withDisableMetricsCollection
in classCopySink
- Parameters:
disableMetricsCollection
- the disableMetricsCollection value to set.- Returns:
- the CopySink object itself.
-
validate
public void validate()Validates the instance.- Overrides:
validate
in classCopySink
- Throws:
IllegalArgumentException
- thrown if the instance is not valid.
-