Class AzureSqlSource
- 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
Constructors Constructor Description AzureSqlSource()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description 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.Map<String,StoredProcedureParameter>
storedProcedureParameters()
Get the storedProcedureParameters property: Value and type setting for stored procedure parameters.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
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(Map<String,StoredProcedureParameter> storedProcedureParameters)
Set the storedProcedureParameters property: Value and type setting for stored procedure parameters.-
Methods inherited from class com.azure.resourcemanager.datafactory.models.TabularSource
additionalColumns, queryTimeout
-
Methods inherited from class com.azure.resourcemanager.datafactory.models.CopySource
additionalProperties, disableMetricsCollection, maxConcurrentConnections, sourceRetryCount, sourceRetryWait, withAdditionalProperties
-
-
-
-
Method Detail
-
sqlReaderQuery
public Object sqlReaderQuery()
Get the sqlReaderQuery property: SQL reader query. Type: string (or Expression with resultType string).- Returns:
- the sqlReaderQuery value.
-
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.
-
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.
-
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.
-
storedProcedureParameters
public Map<String,StoredProcedureParameter> storedProcedureParameters()
Get the storedProcedureParameters property: Value and type setting for stored procedure parameters. Example: "{Parameter1: {value: "1", type: "int"}}".- Returns:
- the storedProcedureParameters value.
-
withStoredProcedureParameters
public AzureSqlSource withStoredProcedureParameters(Map<String,StoredProcedureParameter> 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.
-
produceAdditionalTypes
public Object produceAdditionalTypes()
Get the produceAdditionalTypes property: Which additional types to produce.- Returns:
- the produceAdditionalTypes value.
-
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.
-
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".- Returns:
- the partitionOption value.
-
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".- Parameters:
partitionOption
- the partitionOption value to set.- Returns:
- the AzureSqlSource object itself.
-
partitionSettings
public SqlPartitionSettings partitionSettings()
Get the partitionSettings property: The settings that will be leveraged for Sql source partitioning.- Returns:
- the partitionSettings value.
-
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.
-
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:
withQueryTimeout
in classTabularSource
- Parameters:
queryTimeout
- the queryTimeout value to set.- Returns:
- the TabularSource object itself.
-
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:
withAdditionalColumns
in classTabularSource
- Parameters:
additionalColumns
- the additionalColumns value to set.- Returns:
- the TabularSource object itself.
-
withSourceRetryCount
public AzureSqlSource withSourceRetryCount(Object sourceRetryCount)
Set the sourceRetryCount property: Source retry count. Type: integer (or Expression with resultType integer).- Overrides:
withSourceRetryCount
in classTabularSource
- Parameters:
sourceRetryCount
- the sourceRetryCount value to set.- Returns:
- the CopySource object itself.
-
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:
withSourceRetryWait
in classTabularSource
- Parameters:
sourceRetryWait
- the sourceRetryWait value to set.- Returns:
- the CopySource 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:
withMaxConcurrentConnections
in classTabularSource
- Parameters:
maxConcurrentConnections
- the maxConcurrentConnections value to set.- Returns:
- the CopySource object itself.
-
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:
withDisableMetricsCollection
in classTabularSource
- Parameters:
disableMetricsCollection
- the disableMetricsCollection value to set.- Returns:
- the CopySource object itself.
-
validate
public void validate()
Validates the instance.- Overrides:
validate
in classTabularSource
- Throws:
IllegalArgumentException
- thrown if the instance is not valid.
-
-