Class SqlServerSink
- java.lang.Object
-
- com.azure.analytics.synapse.artifacts.models.CopySink
-
- com.azure.analytics.synapse.artifacts.models.SqlServerSink
-
public final class SqlServerSink extends CopySink
A copy activity SQL server sink.
-
-
Constructor Summary
Constructors Constructor Description SqlServerSink()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Object
getPreCopyScript()
Get the preCopyScript property: SQL pre-copy script.Object
getSqlWriterStoredProcedureName()
Get the sqlWriterStoredProcedureName property: SQL writer stored procedure name.Object
getSqlWriterTableType()
Get the sqlWriterTableType property: SQL writer table type.Map<String,StoredProcedureParameter>
getStoredProcedureParameters()
Get the storedProcedureParameters property: SQL stored procedure parameters.Object
getStoredProcedureTableTypeParameterName()
Get the storedProcedureTableTypeParameterName property: The stored procedure parameter name of the table type.Object
getTableOption()
Get the tableOption property: The option to handle sink table, such as autoCreate.SqlServerSink
setMaxConcurrentConnections(Object maxConcurrentConnections)
Set the maxConcurrentConnections property: The maximum concurrent connection count for the sink data store.SqlServerSink
setPreCopyScript(Object preCopyScript)
Set the preCopyScript property: SQL pre-copy script.SqlServerSink
setSinkRetryCount(Object sinkRetryCount)
Set the sinkRetryCount property: Sink retry count.SqlServerSink
setSinkRetryWait(Object sinkRetryWait)
Set the sinkRetryWait property: Sink retry wait.SqlServerSink
setSqlWriterStoredProcedureName(Object sqlWriterStoredProcedureName)
Set the sqlWriterStoredProcedureName property: SQL writer stored procedure name.SqlServerSink
setSqlWriterTableType(Object sqlWriterTableType)
Set the sqlWriterTableType property: SQL writer table type.SqlServerSink
setStoredProcedureParameters(Map<String,StoredProcedureParameter> storedProcedureParameters)
Set the storedProcedureParameters property: SQL stored procedure parameters.SqlServerSink
setStoredProcedureTableTypeParameterName(Object storedProcedureTableTypeParameterName)
Set the storedProcedureTableTypeParameterName property: The stored procedure parameter name of the table type.SqlServerSink
setTableOption(Object tableOption)
Set the tableOption property: The option to handle sink table, such as autoCreate.SqlServerSink
setWriteBatchSize(Object writeBatchSize)
Set the writeBatchSize property: Write batch size.SqlServerSink
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
-
-
-
-
Method Detail
-
getSqlWriterStoredProcedureName
public Object getSqlWriterStoredProcedureName()
Get the sqlWriterStoredProcedureName property: SQL writer stored procedure name. Type: string (or Expression with resultType string).- Returns:
- the sqlWriterStoredProcedureName value.
-
setSqlWriterStoredProcedureName
public SqlServerSink setSqlWriterStoredProcedureName(Object sqlWriterStoredProcedureName)
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 SqlServerSink object itself.
-
getSqlWriterTableType
public Object getSqlWriterTableType()
Get the sqlWriterTableType property: SQL writer table type. Type: string (or Expression with resultType string).- Returns:
- the sqlWriterTableType value.
-
setSqlWriterTableType
public SqlServerSink setSqlWriterTableType(Object sqlWriterTableType)
Set the sqlWriterTableType property: SQL writer table type. Type: string (or Expression with resultType string).- Parameters:
sqlWriterTableType
- the sqlWriterTableType value to set.- Returns:
- the SqlServerSink object itself.
-
getPreCopyScript
public Object getPreCopyScript()
Get the preCopyScript property: SQL pre-copy script. Type: string (or Expression with resultType string).- Returns:
- the preCopyScript value.
-
setPreCopyScript
public SqlServerSink setPreCopyScript(Object preCopyScript)
Set the preCopyScript property: SQL pre-copy script. Type: string (or Expression with resultType string).- Parameters:
preCopyScript
- the preCopyScript value to set.- Returns:
- the SqlServerSink object itself.
-
getStoredProcedureParameters
public Map<String,StoredProcedureParameter> getStoredProcedureParameters()
Get the storedProcedureParameters property: SQL stored procedure parameters.- Returns:
- the storedProcedureParameters value.
-
setStoredProcedureParameters
public SqlServerSink setStoredProcedureParameters(Map<String,StoredProcedureParameter> storedProcedureParameters)
Set the storedProcedureParameters property: SQL stored procedure parameters.- Parameters:
storedProcedureParameters
- the storedProcedureParameters value to set.- Returns:
- the SqlServerSink object itself.
-
getStoredProcedureTableTypeParameterName
public Object 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 SqlServerSink 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 SqlServerSink object itself.
-
getTableOption
public Object 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
public SqlServerSink setTableOption(Object tableOption)
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 SqlServerSink object itself.
-
setWriteBatchSize
public SqlServerSink setWriteBatchSize(Object writeBatchSize)
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
public SqlServerSink setWriteBatchTimeout(Object writeBatchTimeout)
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
public SqlServerSink setSinkRetryCount(Object sinkRetryCount)
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
public SqlServerSink setSinkRetryWait(Object sinkRetryWait)
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
public SqlServerSink setMaxConcurrentConnections(Object maxConcurrentConnections)
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.
-
-