Class SqlSource
- java.lang.Object
-
- com.azure.analytics.synapse.artifacts.models.CopySource
-
- com.azure.analytics.synapse.artifacts.models.TabularSource
-
- com.azure.analytics.synapse.artifacts.models.SqlSource
-
public final class SqlSource extends TabularSource
A copy activity SQL source.
-
-
Constructor Summary
Constructors Constructor Description SqlSource()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description 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
getSqlReaderQuery()
Get the sqlReaderQuery property: SQL reader query.Object
getSqlReaderStoredProcedureName()
Get the sqlReaderStoredProcedureName property: Name of the stored procedure for a SQL Database source.Map<String,StoredProcedureParameter>
getStoredProcedureParameters()
Get the storedProcedureParameters property: Value and type setting for stored procedure parameters.SqlSource
setAdditionalColumns(Object additionalColumns)
Set the additionalColumns property: Specifies the additional columns to be added to source data.SqlSource
setIsolationLevel(Object isolationLevel)
Set the isolationLevel property: Specifies the transaction locking behavior for the SQL source.SqlSource
setMaxConcurrentConnections(Object maxConcurrentConnections)
Set the maxConcurrentConnections property: The maximum concurrent connection count for the source data store.SqlSource
setPartitionOption(Object partitionOption)
Set the partitionOption property: The partition mechanism that will be used for Sql read in parallel.SqlSource
setPartitionSettings(SqlPartitionSettings partitionSettings)
Set the partitionSettings property: The settings that will be leveraged for Sql source partitioning.SqlSource
setQueryTimeout(Object queryTimeout)
Set the queryTimeout property: Query timeout.SqlSource
setSourceRetryCount(Object sourceRetryCount)
Set the sourceRetryCount property: Source retry count.SqlSource
setSourceRetryWait(Object sourceRetryWait)
Set the sourceRetryWait property: Source retry wait.SqlSource
setSqlReaderQuery(Object sqlReaderQuery)
Set the sqlReaderQuery property: SQL reader query.SqlSource
setSqlReaderStoredProcedureName(Object sqlReaderStoredProcedureName)
Set the sqlReaderStoredProcedureName property: Name of the stored procedure for a SQL Database source.SqlSource
setStoredProcedureParameters(Map<String,StoredProcedureParameter> storedProcedureParameters)
Set the storedProcedureParameters property: Value and type setting for stored procedure parameters.-
Methods inherited from class com.azure.analytics.synapse.artifacts.models.TabularSource
getAdditionalColumns, getQueryTimeout
-
Methods inherited from class com.azure.analytics.synapse.artifacts.models.CopySource
getAdditionalProperties, getMaxConcurrentConnections, getSourceRetryCount, getSourceRetryWait, setAdditionalProperties
-
-
-
-
Method Detail
-
getSqlReaderQuery
public Object getSqlReaderQuery()
Get the sqlReaderQuery property: SQL reader query. Type: string (or Expression with resultType string).- Returns:
- the sqlReaderQuery value.
-
setSqlReaderQuery
public SqlSource 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 SqlSource object itself.
-
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.
-
setSqlReaderStoredProcedureName
public SqlSource 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 SqlSource object itself.
-
getStoredProcedureParameters
public Map<String,StoredProcedureParameter> getStoredProcedureParameters()
Get the storedProcedureParameters property: Value and type setting for stored procedure parameters. Example: "{Parameter1: {value: "1", type: "int"}}".- Returns:
- the storedProcedureParameters value.
-
setStoredProcedureParameters
public SqlSource setStoredProcedureParameters(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 SqlSource object itself.
-
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.
-
setIsolationLevel
public SqlSource 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 SqlSource object itself.
-
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.
-
setPartitionOption
public SqlSource 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 SqlSource object itself.
-
getPartitionSettings
public SqlPartitionSettings getPartitionSettings()
Get the partitionSettings property: The settings that will be leveraged for Sql source partitioning.- Returns:
- the partitionSettings value.
-
setPartitionSettings
public SqlSource 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 SqlSource object itself.
-
setQueryTimeout
public SqlSource 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:
setQueryTimeout
in classTabularSource
- Parameters:
queryTimeout
- the queryTimeout value to set.- Returns:
- the TabularSource object itself.
-
setAdditionalColumns
public SqlSource 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:
setAdditionalColumns
in classTabularSource
- Parameters:
additionalColumns
- the additionalColumns value to set.- Returns:
- the TabularSource object itself.
-
setSourceRetryCount
public SqlSource setSourceRetryCount(Object sourceRetryCount)
Set the sourceRetryCount property: Source retry count. Type: integer (or Expression with resultType integer).- Overrides:
setSourceRetryCount
in classTabularSource
- Parameters:
sourceRetryCount
- the sourceRetryCount value to set.- Returns:
- the CopySource object itself.
-
setSourceRetryWait
public SqlSource 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:
setSourceRetryWait
in classTabularSource
- Parameters:
sourceRetryWait
- the sourceRetryWait value to set.- Returns:
- the CopySource object itself.
-
setMaxConcurrentConnections
public SqlSource 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:
setMaxConcurrentConnections
in classTabularSource
- Parameters:
maxConcurrentConnections
- the maxConcurrentConnections value to set.- Returns:
- the CopySource object itself.
-
-