Class SqlServerSource
java.lang.Object
com.azure.analytics.synapse.artifacts.models.CopySource
com.azure.analytics.synapse.artifacts.models.TabularSource
com.azure.analytics.synapse.artifacts.models.SqlServerSource
A copy activity SQL server source.
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionGet the partitionOption property: The partition mechanism that will be used for Sql read in parallel.Get the partitionSettings property: The settings that will be leveraged for Sql source partitioning.Get the produceAdditionalTypes property: Which additional types to produce.Get the sqlReaderQuery property: SQL reader query.Get the sqlReaderStoredProcedureName property: Name of the stored procedure for a SQL Database source.Get the storedProcedureParameters property: Value and type setting for stored procedure parameters.setAdditionalColumns
(Object additionalColumns) Set the additionalColumns property: Specifies the additional columns to be added to source data.setMaxConcurrentConnections
(Object maxConcurrentConnections) Set the maxConcurrentConnections property: The maximum concurrent connection count for the source data store.setPartitionOption
(Object partitionOption) Set the partitionOption property: The partition mechanism that will be used for Sql read in parallel.setPartitionSettings
(SqlPartitionSettings partitionSettings) Set the partitionSettings property: The settings that will be leveraged for Sql source partitioning.setProduceAdditionalTypes
(Object produceAdditionalTypes) Set the produceAdditionalTypes property: Which additional types to produce.setQueryTimeout
(Object queryTimeout) Set the queryTimeout property: Query timeout.setSourceRetryCount
(Object sourceRetryCount) Set the sourceRetryCount property: Source retry count.setSourceRetryWait
(Object sourceRetryWait) Set the sourceRetryWait property: Source retry wait.setSqlReaderQuery
(Object sqlReaderQuery) Set the sqlReaderQuery property: SQL reader query.setSqlReaderStoredProcedureName
(Object sqlReaderStoredProcedureName) Set the sqlReaderStoredProcedureName property: Name of the stored procedure for a SQL Database source.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
-
Constructor Details
-
SqlServerSource
public SqlServerSource()
-
-
Method Details
-
getSqlReaderQuery
Get the sqlReaderQuery property: SQL reader query. Type: string (or Expression with resultType string).- Returns:
- the sqlReaderQuery value.
-
setSqlReaderQuery
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.
-
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
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.
-
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 SqlServerSource 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 SqlServerSource object itself.
-
getProduceAdditionalTypes
Get the produceAdditionalTypes property: Which additional types to produce.- Returns:
- the produceAdditionalTypes value.
-
setProduceAdditionalTypes
Set the produceAdditionalTypes property: Which additional types to produce.- Parameters:
produceAdditionalTypes
- the produceAdditionalTypes value to set.- Returns:
- the SqlServerSource object itself.
-
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
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.
-
getPartitionSettings
Get the partitionSettings property: The settings that will be leveraged for Sql source partitioning.- Returns:
- the partitionSettings value.
-
setPartitionSettings
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.
-
setQueryTimeout
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
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
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
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
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.
-