SqlServerSink Class

Package:
com.azure.analytics.synapse.artifacts.models
Maven Artifact:
com.azure:azure-analytics-synapse-artifacts:1.0.0-beta.17

public final class SqlServerSink
extends CopySink

A copy activity SQL server sink.

Constructor Summary

Constructor Description
SqlServerSink()

Creates an instance of SqlServerSink class.

Method Summary

Modifier and Type Method and Description
static SqlServerSink fromJson(JsonReader jsonReader)

Reads an instance of SqlServerSink from the JsonReader.
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.
Object 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.
String getType()

Get the type property: Copy sink type.
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(Object 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.
JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from CopySink

fromJson getAdditionalProperties getMaxConcurrentConnections getSinkRetryCount getSinkRetryWait getType getWriteBatchSize getWriteBatchTimeout setAdditionalProperties setMaxConcurrentConnections setSinkRetryCount setSinkRetryWait setWriteBatchSize setWriteBatchTimeout toJson

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

SqlServerSink

public SqlServerSink()

Creates an instance of SqlServerSink class.

Method Details

fromJson

public static SqlServerSink fromJson(JsonReader jsonReader)

Reads an instance of SqlServerSink from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of SqlServerSink if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

 - If an error occurs while reading the SqlServerSink.

getPreCopyScript

public Object getPreCopyScript()

Get the preCopyScript property: SQL pre-copy script. Type: string (or Expression with resultType string).

Returns:

the preCopyScript value.

getSqlWriterStoredProcedureName

public Object getSqlWriterStoredProcedureName()

Get the sqlWriterStoredProcedureName property: SQL writer stored procedure name. Type: string (or Expression with resultType string).

Returns:

the sqlWriterStoredProcedureName value.

getSqlWriterTableType

public Object getSqlWriterTableType()

Get the sqlWriterTableType property: SQL writer table type. Type: string (or Expression with resultType string).

Returns:

the sqlWriterTableType value.

getStoredProcedureParameters

public Object getStoredProcedureParameters()

Get the storedProcedureParameters property: SQL stored procedure parameters.

Returns:

the storedProcedureParameters value.

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.

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.

getType

public String getType()

Get the type property: Copy sink type.

Overrides:

SqlServerSink.getType()

Returns:

the type value.

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:

SqlServerSink.setMaxConcurrentConnections(Object maxConcurrentConnections)

Parameters:

maxConcurrentConnections

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.

setSinkRetryCount

public SqlServerSink setSinkRetryCount(Object sinkRetryCount)

Set the sinkRetryCount property: Sink retry count. Type: integer (or Expression with resultType integer).

Overrides:

SqlServerSink.setSinkRetryCount(Object sinkRetryCount)

Parameters:

sinkRetryCount

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:

SqlServerSink.setSinkRetryWait(Object sinkRetryWait)

Parameters:

sinkRetryWait

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.

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.

setStoredProcedureParameters

public SqlServerSink setStoredProcedureParameters(Object storedProcedureParameters)

Set the storedProcedureParameters property: SQL stored procedure parameters.

Parameters:

storedProcedureParameters - the storedProcedureParameters value to set.

Returns:

the SqlServerSink object itself.

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.

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:

SqlServerSink.setWriteBatchSize(Object writeBatchSize)

Parameters:

writeBatchSize

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:

SqlServerSink.setWriteBatchTimeout(Object writeBatchTimeout)

Parameters:

writeBatchTimeout

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

SqlServerSink.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to