AzureSqlSource Class

Package:

com.azure.resourcemanager.datafactory.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-datafactory:1.0.0-beta.28

• java.lang.Object
• • com.azure.resourcemanager.datafactory.models.CopySource
  • • com.azure.resourcemanager.datafactory.models.TabularSource
    • • com.azure.resourcemanager.datafactory.models.AzureSqlSource

public final class AzureSqlSource
extends TabularSource

A copy activity Azure SQL source.

Constructor Summary

Constructor	Description
AzureSqlSource()	Creates an instance of AzureSqlSource class.

Method Summary

Modifier and Type	Method and Description
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.
String	type() Get the type property: Copy source type.
void	validate() Validates the instance.
AzureSqlSource	withAdditionalColumns(Object additionalColumns) Set the additionalColumns property: Specifies the additional columns to be added to source data.
AzureSqlSource	withDisableMetricsCollection(Object disableMetricsCollection) Set the disableMetricsCollection property: If true, disable data store metrics collection.
AzureSqlSource	withIsolationLevel(Object isolationLevel) Set the isolationLevel property: Specifies the transaction locking behavior for the SQL source.
AzureSqlSource	withMaxConcurrentConnections(Object maxConcurrentConnections) Set the maxConcurrentConnections property: The maximum concurrent connection count for the source data store.
AzureSqlSource	withPartitionOption(Object partitionOption) Set the partitionOption property: The partition mechanism that will be used for Sql read in parallel.
AzureSqlSource	withPartitionSettings(SqlPartitionSettings partitionSettings) Set the partitionSettings property: The settings that will be leveraged for Sql source partitioning.
AzureSqlSource	withProduceAdditionalTypes(Object produceAdditionalTypes) Set the produceAdditionalTypes property: Which additional types to produce.
AzureSqlSource	withQueryTimeout(Object queryTimeout) Set the queryTimeout property: Query timeout.
AzureSqlSource	withSourceRetryCount(Object sourceRetryCount) Set the sourceRetryCount property: Source retry count.
AzureSqlSource	withSourceRetryWait(Object sourceRetryWait) Set the sourceRetryWait property: Source retry wait.
AzureSqlSource	withSqlReaderQuery(Object sqlReaderQuery) Set the sqlReaderQuery property: SQL reader query.
AzureSqlSource	withSqlReaderStoredProcedureName(Object sqlReaderStoredProcedureName) Set the sqlReaderStoredProcedureName property: Name of the stored procedure for a SQL Database source.
AzureSqlSource	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 queryTimeout 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

AzureSqlSource

public AzureSqlSource()

Creates an instance of AzureSqlSource class.

Method Details

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.

type

public String type()

Get the type property: Copy source type.

Overrides:

AzureSqlSource.type()

Returns:

the type value.

validate

public void validate()

Validates the instance.

Overrides:

AzureSqlSource.validate()

withAdditionalColumns

public AzureSqlSource 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:

AzureSqlSource.withAdditionalColumns(Object additionalColumns)

Parameters:

additionalColumns

withDisableMetricsCollection

public AzureSqlSource 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:

AzureSqlSource.withDisableMetricsCollection(Object disableMetricsCollection)

Parameters:

disableMetricsCollection

withIsolationLevel

public AzureSqlSource 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 AzureSqlSource object itself.

withMaxConcurrentConnections

public AzureSqlSource 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:

AzureSqlSource.withMaxConcurrentConnections(Object maxConcurrentConnections)

Parameters:

maxConcurrentConnections

withPartitionOption

public AzureSqlSource 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 AzureSqlSource object itself.

withPartitionSettings

public AzureSqlSource 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 AzureSqlSource object itself.

withProduceAdditionalTypes

public AzureSqlSource withProduceAdditionalTypes(Object produceAdditionalTypes)

Set the produceAdditionalTypes property: Which additional types to produce.

Parameters:

produceAdditionalTypes - the produceAdditionalTypes value to set.

Returns:

the AzureSqlSource object itself.

withQueryTimeout

public AzureSqlSource 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:

AzureSqlSource.withQueryTimeout(Object queryTimeout)

Parameters:

queryTimeout

withSourceRetryCount

public AzureSqlSource withSourceRetryCount(Object sourceRetryCount)

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

Overrides:

AzureSqlSource.withSourceRetryCount(Object sourceRetryCount)

Parameters:

sourceRetryCount

withSourceRetryWait

public AzureSqlSource 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:

AzureSqlSource.withSourceRetryWait(Object sourceRetryWait)

Parameters:

sourceRetryWait

withSqlReaderQuery

public AzureSqlSource 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 AzureSqlSource object itself.

withSqlReaderStoredProcedureName

public AzureSqlSource 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 AzureSqlSource object itself.

withStoredProcedureParameters

public AzureSqlSource 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 AzureSqlSource object itself.