Class SqlDWSource


  • public final class SqlDWSource
    extends TabularSource
    A copy activity SQL Data Warehouse source.
    • Constructor Detail

      • SqlDWSource

        public SqlDWSource()
    • Method Detail

      • sqlReaderQuery

        public Object sqlReaderQuery()
        Get the sqlReaderQuery property: SQL Data Warehouse reader query. Type: string (or Expression with resultType string).
        Returns:
        the sqlReaderQuery value.
      • withSqlReaderQuery

        public SqlDWSource withSqlReaderQuery​(Object sqlReaderQuery)
        Set the sqlReaderQuery property: SQL Data Warehouse reader query. Type: string (or Expression with resultType string).
        Parameters:
        sqlReaderQuery - the sqlReaderQuery value to set.
        Returns:
        the SqlDWSource object itself.
      • sqlReaderStoredProcedureName

        public Object sqlReaderStoredProcedureName()
        Get the sqlReaderStoredProcedureName property: Name of the stored procedure for a SQL Data Warehouse source. This cannot be used at the same time as SqlReaderQuery. Type: string (or Expression with resultType string).
        Returns:
        the sqlReaderStoredProcedureName value.
      • withSqlReaderStoredProcedureName

        public SqlDWSource withSqlReaderStoredProcedureName​(Object sqlReaderStoredProcedureName)
        Set the sqlReaderStoredProcedureName property: Name of the stored procedure for a SQL Data Warehouse 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 SqlDWSource object itself.
      • storedProcedureParameters

        public Object storedProcedureParameters()
        Get the storedProcedureParameters property: Value and type setting for stored procedure parameters. Example: "{Parameter1: {value: "1", type: "int"}}". Type: object (or Expression with resultType object), itemType: StoredProcedureParameter.
        Returns:
        the storedProcedureParameters value.
      • withStoredProcedureParameters

        public SqlDWSource withStoredProcedureParameters​(Object storedProcedureParameters)
        Set the storedProcedureParameters property: Value and type setting for stored procedure parameters. Example: "{Parameter1: {value: "1", type: "int"}}". Type: object (or Expression with resultType object), itemType: StoredProcedureParameter.
        Parameters:
        storedProcedureParameters - the storedProcedureParameters value to set.
        Returns:
        the SqlDWSource 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 SqlDWSource 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 SqlDWSource 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 SqlDWSource 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 SqlDWSource object itself.
      • withQueryTimeout

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

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

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

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

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

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