Class SqlSink
java.lang.Object
com.azure.analytics.synapse.artifacts.models.CopySink
com.azure.analytics.synapse.artifacts.models.SqlSink
A copy activity 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 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.setMaxConcurrentConnections
(Object maxConcurrentConnections) Set the maxConcurrentConnections property: The maximum concurrent connection count for the sink data store.setPreCopyScript
(Object preCopyScript) Set the preCopyScript property: SQL pre-copy script.setSinkRetryCount
(Object sinkRetryCount) Set the sinkRetryCount property: Sink retry count.setSinkRetryWait
(Object sinkRetryWait) Set the sinkRetryWait property: Sink retry wait.setSqlWriterStoredProcedureName
(Object sqlWriterStoredProcedureName) Set the sqlWriterStoredProcedureName property: SQL writer stored procedure name.setSqlWriterTableType
(Object sqlWriterTableType) Set the sqlWriterTableType property: SQL writer table type.setStoredProcedureParameters
(Map<String, StoredProcedureParameter> storedProcedureParameters) Set the storedProcedureParameters property: SQL stored procedure parameters.setStoredProcedureTableTypeParameterName
(Object storedProcedureTableTypeParameterName) Set the storedProcedureTableTypeParameterName property: The stored procedure parameter name of the table type.setTableOption
(Object tableOption) Set the tableOption property: The option to handle sink table, such as autoCreate.setWriteBatchSize
(Object writeBatchSize) Set the writeBatchSize property: Write batch size.setWriteBatchTimeout
(Object writeBatchTimeout) Set the writeBatchTimeout property: Write batch timeout.Methods inherited from class com.azure.analytics.synapse.artifacts.models.CopySink
getAdditionalProperties, getMaxConcurrentConnections, getSinkRetryCount, getSinkRetryWait, getWriteBatchSize, getWriteBatchTimeout, setAdditionalProperties
-
Constructor Details
-
SqlSink
public SqlSink()
-
-
Method Details
-
getSqlWriterStoredProcedureName
Get the sqlWriterStoredProcedureName property: SQL writer stored procedure name. Type: string (or Expression with resultType string).- Returns:
- the sqlWriterStoredProcedureName value.
-
setSqlWriterStoredProcedureName
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 SqlSink object itself.
-
getSqlWriterTableType
Get the sqlWriterTableType property: SQL writer table type. Type: string (or Expression with resultType string).- Returns:
- the sqlWriterTableType value.
-
setSqlWriterTableType
Set the sqlWriterTableType property: SQL writer table type. Type: string (or Expression with resultType string).- Parameters:
sqlWriterTableType
- the sqlWriterTableType value to set.- Returns:
- the SqlSink object itself.
-
getPreCopyScript
Get the preCopyScript property: SQL pre-copy script. Type: string (or Expression with resultType string).- Returns:
- the preCopyScript value.
-
setPreCopyScript
Set the preCopyScript property: SQL pre-copy script. Type: string (or Expression with resultType string).- Parameters:
preCopyScript
- the preCopyScript value to set.- Returns:
- the SqlSink object itself.
-
getStoredProcedureParameters
Get the storedProcedureParameters property: SQL stored procedure parameters.- Returns:
- the storedProcedureParameters value.
-
setStoredProcedureParameters
public SqlSink setStoredProcedureParameters(Map<String, StoredProcedureParameter> storedProcedureParameters) Set the storedProcedureParameters property: SQL stored procedure parameters.- Parameters:
storedProcedureParameters
- the storedProcedureParameters value to set.- Returns:
- the SqlSink object itself.
-
getStoredProcedureTableTypeParameterName
Get the storedProcedureTableTypeParameterName property: The stored procedure parameter name of the table type. Type: string (or Expression with resultType string).- Returns:
- the storedProcedureTableTypeParameterName value.
-
setStoredProcedureTableTypeParameterName
public SqlSink setStoredProcedureTableTypeParameterName(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 SqlSink object itself.
-
getTableOption
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.
-
setTableOption
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 SqlSink object itself.
-
setWriteBatchSize
Set the writeBatchSize property: Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.- Overrides:
setWriteBatchSize
in classCopySink
- Parameters:
writeBatchSize
- the writeBatchSize value to set.- Returns:
- the CopySink object itself.
-
setWriteBatchTimeout
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:
setWriteBatchTimeout
in classCopySink
- Parameters:
writeBatchTimeout
- the writeBatchTimeout value to set.- Returns:
- the CopySink object itself.
-
setSinkRetryCount
Set the sinkRetryCount property: Sink retry count. Type: integer (or Expression with resultType integer).- Overrides:
setSinkRetryCount
in classCopySink
- Parameters:
sinkRetryCount
- the sinkRetryCount value to set.- Returns:
- the CopySink object itself.
-
setSinkRetryWait
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:
setSinkRetryWait
in classCopySink
- Parameters:
sinkRetryWait
- the sinkRetryWait value to set.- Returns:
- the CopySink object itself.
-
setMaxConcurrentConnections
Set the maxConcurrentConnections property: The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).- Overrides:
setMaxConcurrentConnections
in classCopySink
- Parameters:
maxConcurrentConnections
- the maxConcurrentConnections value to set.- Returns:
- the CopySink object itself.
-