Package com.azure.analytics.synapse.artifacts.models

Class SqlServerSource

  • public final class SqlServerSource
extends TabularSource
    A copy activity SQL server source.

    • Constructor Detail

      • SqlServerSource

        public SqlServerSource()

    • 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 SqlServerSource 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 SqlServerSource 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 SqlServerSource 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 SqlServerSource 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 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

        public Object getProduceAdditionalTypes()
        Get the produceAdditionalTypes property: Which additional types to produce.
        Returns:
        the produceAdditionalTypes value.

      • setProduceAdditionalTypes

        public SqlServerSource setProduceAdditionalTypes​(Object produceAdditionalTypes)
        Set the produceAdditionalTypes property: Which additional types to produce.
        Parameters:
        produceAdditionalTypes - the produceAdditionalTypes value to set.
        Returns:
        the SqlServerSource 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 SqlServerSource 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 SqlServerSource 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 SqlServerSource 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 SqlServerSource object itself.

      • setQueryTimeout

        public SqlServerSource 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 class TabularSource
        Parameters:
        queryTimeout - the queryTimeout value to set.
        Returns:
        the TabularSource object itself.

      • setAdditionalColumns

        public SqlServerSource 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 class TabularSource
        Parameters:
        additionalColumns - the additionalColumns value to set.
        Returns:
        the TabularSource object itself.

      • setSourceRetryCount

        public SqlServerSource setSourceRetryCount​(Object sourceRetryCount)
        Set the sourceRetryCount property: Source retry count. Type: integer (or Expression with resultType integer).
        Overrides:
        setSourceRetryCount in class TabularSource
        Parameters:
        sourceRetryCount - the sourceRetryCount value to set.
        Returns:
        the CopySource object itself.

      • setSourceRetryWait

        public SqlServerSource 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 class TabularSource
        Parameters:
        sourceRetryWait - the sourceRetryWait value to set.
        Returns:
        the CopySource object itself.

      • setMaxConcurrentConnections

        public SqlServerSource 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 class TabularSource
        Parameters:
        maxConcurrentConnections - the maxConcurrentConnections value to set.
        Returns:
        the CopySource object itself.