SqlServerSource Class

Package:
com.azure.resourcemanager.datafactory.models
Maven Artifact:
com.azure.resourcemanager:azure-resourcemanager-datafactory:1.2.0

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 isolationLevel()

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

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

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

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

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

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

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

Get the type property: Copy source type.
void validate()

Validates the instance.
SqlServerSource withAdditionalColumns(Object additionalColumns)

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

Set the disableMetricsCollection property: If true, disable data store metrics collection.
SqlServerSource withIsolationLevel(Object isolationLevel)

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

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

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

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

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

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

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

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

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

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

Set the storedProcedureParameters property: Value and type setting for stored procedure parameters.

Methods inherited from CopySource

additionalProperties disableMetricsCollection maxConcurrentConnections sourceRetryCount sourceRetryWait withAdditionalProperties

Methods inherited from TabularSource

additionalColumns fromJson queryTimeout toJson type validate withAdditionalColumns withDisableMetricsCollection withMaxConcurrentConnections withQueryTimeout withSourceRetryCount withSourceRetryWait

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.

isolationLevel

public Object isolationLevel()

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.

partitionOption

public Object partitionOption()

Get the partitionOption property: The partition mechanism that will be used for Sql read in parallel. Possible values include: "None", "PhysicalPartitionsOfTable", "DynamicRange". Type: string (or Expression with resultType string).

Returns:

the partitionOption value.

partitionSettings

public SqlPartitionSettings partitionSettings()

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

Returns:

the partitionSettings value.

produceAdditionalTypes

public Object produceAdditionalTypes()

Get the produceAdditionalTypes property: Which additional types to produce.

Returns:

the produceAdditionalTypes value.

sqlReaderQuery

public Object sqlReaderQuery()

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

Returns:

the sqlReaderQuery value.

sqlReaderStoredProcedureName

public Object sqlReaderStoredProcedureName()

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.

storedProcedureParameters

public Object storedProcedureParameters()

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

Returns:

the storedProcedureParameters value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

SqlServerSource.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

type

public String type()

Get the type property: Copy source type.

Overrides:

SqlServerSource.type()

Returns:

the type value.

validate

public void validate()

Validates the instance.

Overrides:

SqlServerSource.validate()

withAdditionalColumns

public SqlServerSource withAdditionalColumns(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.withAdditionalColumns(Object additionalColumns)

Parameters:

additionalColumns

withDisableMetricsCollection

public SqlServerSource withDisableMetricsCollection(Object disableMetricsCollection)

Set the disableMetricsCollection property: If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).

Overrides:

SqlServerSource.withDisableMetricsCollection(Object disableMetricsCollection)

Parameters:

disableMetricsCollection

withIsolationLevel

public SqlServerSource withIsolationLevel(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.

withMaxConcurrentConnections

public SqlServerSource withMaxConcurrentConnections(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.withMaxConcurrentConnections(Object maxConcurrentConnections)

Parameters:

maxConcurrentConnections

withPartitionOption

public SqlServerSource withPartitionOption(Object partitionOption)

Set the partitionOption property: The partition mechanism that will be used for Sql read in parallel. Possible values include: "None", "PhysicalPartitionsOfTable", "DynamicRange". Type: string (or Expression with resultType string).

Parameters:

partitionOption - the partitionOption value to set.

Returns:

the SqlServerSource object itself.

withPartitionSettings

public SqlServerSource withPartitionSettings(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.

withProduceAdditionalTypes

public SqlServerSource withProduceAdditionalTypes(Object produceAdditionalTypes)

Set the produceAdditionalTypes property: Which additional types to produce.

Parameters:

produceAdditionalTypes - the produceAdditionalTypes value to set.

Returns:

the SqlServerSource object itself.

withQueryTimeout

public SqlServerSource withQueryTimeout(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.withQueryTimeout(Object queryTimeout)

Parameters:

queryTimeout

withSourceRetryCount

public SqlServerSource withSourceRetryCount(Object sourceRetryCount)

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

Overrides:

SqlServerSource.withSourceRetryCount(Object sourceRetryCount)

Parameters:

sourceRetryCount

withSourceRetryWait

public SqlServerSource withSourceRetryWait(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.withSourceRetryWait(Object sourceRetryWait)

Parameters:

sourceRetryWait

withSqlReaderQuery

public SqlServerSource withSqlReaderQuery(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.

withSqlReaderStoredProcedureName

public SqlServerSource withSqlReaderStoredProcedureName(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.

withStoredProcedureParameters

public SqlServerSource withStoredProcedureParameters(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.

Applies to