SqlServerSource Class

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

public final class SqlServerSource
extends TabularSource

A copy activity SQL server source.

Constructor Summary

Constructor Description
SqlServerSource()

Creates an instance of SqlServerSource class.

Method Summary

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

Reads an instance of SqlServerSource from the JsonReader.
Object getIsolationLevel()

Get the isolationLevel property: Specifies the transaction locking behavior for the SQL source.
Object getPartitionOption()

Get the partitionOption property: The partition mechanism that will be used for Sql read in parallel.
SqlPartitionSettings getPartitionSettings()

Get the partitionSettings property: The settings that will be leveraged for Sql source partitioning.
Object getProduceAdditionalTypes()

Get the produceAdditionalTypes property: Which additional types to produce.
Object getSqlReaderQuery()

Get the sqlReaderQuery property: SQL reader query.
Object getSqlReaderStoredProcedureName()

Get the sqlReaderStoredProcedureName property: Name of the stored procedure for a SQL Database source.
Object getStoredProcedureParameters()

Get the storedProcedureParameters property: Value and type setting for stored procedure parameters.
String getType()

Get the type property: Copy source type.
SqlServerSource setAdditionalColumns(Object additionalColumns)

Set the additionalColumns property: Specifies the additional columns to be added to source data.
SqlServerSource setIsolationLevel(Object isolationLevel)

Set the isolationLevel property: Specifies the transaction locking behavior for the SQL source.
SqlServerSource setMaxConcurrentConnections(Object maxConcurrentConnections)

Set the maxConcurrentConnections property: The maximum concurrent connection count for the source data store.
SqlServerSource setPartitionOption(Object partitionOption)

Set the partitionOption property: The partition mechanism that will be used for Sql read in parallel.
SqlServerSource setPartitionSettings(SqlPartitionSettings partitionSettings)

Set the partitionSettings property: The settings that will be leveraged for Sql source partitioning.
SqlServerSource setProduceAdditionalTypes(Object produceAdditionalTypes)

Set the produceAdditionalTypes property: Which additional types to produce.
SqlServerSource setQueryTimeout(Object queryTimeout)

Set the queryTimeout property: Query timeout.
SqlServerSource setSourceRetryCount(Object sourceRetryCount)

Set the sourceRetryCount property: Source retry count.
SqlServerSource setSourceRetryWait(Object sourceRetryWait)

Set the sourceRetryWait property: Source retry wait.
SqlServerSource setSqlReaderQuery(Object sqlReaderQuery)

Set the sqlReaderQuery property: SQL reader query.
SqlServerSource setSqlReaderStoredProcedureName(Object sqlReaderStoredProcedureName)

Set the sqlReaderStoredProcedureName property: Name of the stored procedure for a SQL Database source.
SqlServerSource setStoredProcedureParameters(Object storedProcedureParameters)

Set the storedProcedureParameters property: Value and type setting for stored procedure parameters.
JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from CopySource

getAdditionalProperties getMaxConcurrentConnections getSourceRetryCount getSourceRetryWait setAdditionalProperties

Methods inherited from TabularSource

fromJson getAdditionalColumns getQueryTimeout getType setAdditionalColumns setMaxConcurrentConnections setQueryTimeout setSourceRetryCount setSourceRetryWait toJson

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

SqlServerSource

public SqlServerSource()

Creates an instance of SqlServerSource class.

Method Details

fromJson

public static SqlServerSource fromJson(JsonReader jsonReader)

Reads an instance of SqlServerSource from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of SqlServerSource 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 SqlServerSource.

getIsolationLevel

public Object getIsolationLevel()

Get the isolationLevel property: Specifies the transaction locking behavior for the SQL source. Allowed values: ReadCommitted/ReadUncommitted/RepeatableRead/Serializable/Snapshot. The default value is ReadCommitted. Type: string (or Expression with resultType string).

Returns:

the isolationLevel value.

getPartitionOption

public Object getPartitionOption()

Get the partitionOption property: The partition mechanism that will be used for Sql read in parallel. Possible values include: "None", "PhysicalPartitionsOfTable", "DynamicRange".

Returns:

the partitionOption value.

getPartitionSettings

public SqlPartitionSettings getPartitionSettings()

Get the partitionSettings property: The settings that will be leveraged for Sql source partitioning.

Returns:

the partitionSettings value.

getProduceAdditionalTypes

public Object getProduceAdditionalTypes()

Get the produceAdditionalTypes property: Which additional types to produce.

Returns:

the produceAdditionalTypes value.

getSqlReaderQuery

public Object getSqlReaderQuery()

Get the sqlReaderQuery property: SQL reader query. Type: string (or Expression with resultType string).

Returns:

the sqlReaderQuery value.

getSqlReaderStoredProcedureName

public Object getSqlReaderStoredProcedureName()

Get the sqlReaderStoredProcedureName property: Name of the stored procedure for a SQL Database source. This cannot be used at the same time as SqlReaderQuery. Type: string (or Expression with resultType string).

Returns:

the sqlReaderStoredProcedureName value.

getStoredProcedureParameters

public Object getStoredProcedureParameters()

Get the storedProcedureParameters property: Value and type setting for stored procedure parameters. Example: "{Parameter1: {value: "1", type: "int"}}".

Returns:

the storedProcedureParameters value.

getType

public String getType()

Get the type property: Copy source type.

Overrides:

SqlServerSource.getType()

Returns:

the type value.

setAdditionalColumns

public SqlServerSource setAdditionalColumns(Object additionalColumns)

Set the additionalColumns property: Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

Overrides:

SqlServerSource.setAdditionalColumns(Object additionalColumns)

Parameters:

additionalColumns

setIsolationLevel

public SqlServerSource setIsolationLevel(Object isolationLevel)

Set the isolationLevel property: Specifies the transaction locking behavior for the SQL source. Allowed values: ReadCommitted/ReadUncommitted/RepeatableRead/Serializable/Snapshot. The default value is ReadCommitted. Type: string (or Expression with resultType string).

Parameters:

isolationLevel - the isolationLevel value to set.

Returns:

the SqlServerSource object itself.

setMaxConcurrentConnections

public SqlServerSource setMaxConcurrentConnections(Object maxConcurrentConnections)

Set the maxConcurrentConnections property: The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

Overrides:

SqlServerSource.setMaxConcurrentConnections(Object maxConcurrentConnections)

Parameters:

maxConcurrentConnections

setPartitionOption

public SqlServerSource setPartitionOption(Object partitionOption)

Set the partitionOption property: The partition mechanism that will be used for Sql read in parallel. Possible values include: "None", "PhysicalPartitionsOfTable", "DynamicRange".

Parameters:

partitionOption - the partitionOption value to set.

Returns:

the SqlServerSource object itself.

setPartitionSettings

public SqlServerSource setPartitionSettings(SqlPartitionSettings partitionSettings)

Set the partitionSettings property: The settings that will be leveraged for Sql source partitioning.

Parameters:

partitionSettings - the partitionSettings value to set.

Returns:

the SqlServerSource object itself.

setProduceAdditionalTypes

public SqlServerSource setProduceAdditionalTypes(Object produceAdditionalTypes)

Set the produceAdditionalTypes property: Which additional types to produce.

Parameters:

produceAdditionalTypes - the produceAdditionalTypes value to set.

Returns:

the SqlServerSource object itself.

setQueryTimeout

public SqlServerSource setQueryTimeout(Object queryTimeout)

Set the queryTimeout property: Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).

Overrides:

SqlServerSource.setQueryTimeout(Object queryTimeout)

Parameters:

queryTimeout

setSourceRetryCount

public SqlServerSource setSourceRetryCount(Object sourceRetryCount)

Set the sourceRetryCount property: Source retry count. Type: integer (or Expression with resultType integer).

Overrides:

SqlServerSource.setSourceRetryCount(Object sourceRetryCount)

Parameters:

sourceRetryCount

setSourceRetryWait

public SqlServerSource setSourceRetryWait(Object sourceRetryWait)

Set the sourceRetryWait property: Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).

Overrides:

SqlServerSource.setSourceRetryWait(Object sourceRetryWait)

Parameters:

sourceRetryWait

setSqlReaderQuery

public SqlServerSource setSqlReaderQuery(Object sqlReaderQuery)

Set the sqlReaderQuery property: SQL reader query. Type: string (or Expression with resultType string).

Parameters:

sqlReaderQuery - the sqlReaderQuery value to set.

Returns:

the SqlServerSource object itself.

setSqlReaderStoredProcedureName

public SqlServerSource setSqlReaderStoredProcedureName(Object sqlReaderStoredProcedureName)

Set the sqlReaderStoredProcedureName property: Name of the stored procedure for a SQL Database source. This cannot be used at the same time as SqlReaderQuery. Type: string (or Expression with resultType string).

Parameters:

sqlReaderStoredProcedureName - the sqlReaderStoredProcedureName value to set.

Returns:

the SqlServerSource object itself.

setStoredProcedureParameters

public SqlServerSource setStoredProcedureParameters(Object storedProcedureParameters)

Set the storedProcedureParameters property: Value and type setting for stored procedure parameters. Example: "{Parameter1: {value: "1", type: "int"}}".

Parameters:

storedProcedureParameters - the storedProcedureParameters value to set.

Returns:

the SqlServerSource object itself.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

SqlServerSource.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to