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

Class SqlDWSink

  • public final class SqlDWSink
extends CopySink
    A copy activity SQL Data Warehouse sink.

    • Constructor Detail

      • SqlDWSink

        public SqlDWSink()

    • Method Detail

      • getPreCopyScript

        public Object getPreCopyScript()
        Get the preCopyScript property: SQL pre-copy script. Type: string (or Expression with resultType string).
        Returns:
        the preCopyScript value.

      • setPreCopyScript

        public SqlDWSink setPreCopyScript​(Object preCopyScript)
        Set the preCopyScript property: SQL pre-copy script. Type: string (or Expression with resultType string).
        Parameters:
        preCopyScript - the preCopyScript value to set.
        Returns:
        the SqlDWSink object itself.

      • getAllowPolyBase

        public Object getAllowPolyBase()
        Get the allowPolyBase property: Indicates to use PolyBase to copy data into SQL Data Warehouse when applicable. Type: boolean (or Expression with resultType boolean).
        Returns:
        the allowPolyBase value.

      • setAllowPolyBase

        public SqlDWSink setAllowPolyBase​(Object allowPolyBase)
        Set the allowPolyBase property: Indicates to use PolyBase to copy data into SQL Data Warehouse when applicable. Type: boolean (or Expression with resultType boolean).
        Parameters:
        allowPolyBase - the allowPolyBase value to set.
        Returns:
        the SqlDWSink object itself.

      • getPolyBaseSettings

        public PolybaseSettings getPolyBaseSettings()
        Get the polyBaseSettings property: Specifies PolyBase-related settings when allowPolyBase is true.
        Returns:
        the polyBaseSettings value.

      • setPolyBaseSettings

        public SqlDWSink setPolyBaseSettings​(PolybaseSettings polyBaseSettings)
        Set the polyBaseSettings property: Specifies PolyBase-related settings when allowPolyBase is true.
        Parameters:
        polyBaseSettings - the polyBaseSettings value to set.
        Returns:
        the SqlDWSink object itself.

      • getAllowCopyCommand

        public Object getAllowCopyCommand()
        Get the allowCopyCommand property: Indicates to use Copy Command to copy data into SQL Data Warehouse. Type: boolean (or Expression with resultType boolean).
        Returns:
        the allowCopyCommand value.

      • setAllowCopyCommand

        public SqlDWSink setAllowCopyCommand​(Object allowCopyCommand)
        Set the allowCopyCommand property: Indicates to use Copy Command to copy data into SQL Data Warehouse. Type: boolean (or Expression with resultType boolean).
        Parameters:
        allowCopyCommand - the allowCopyCommand value to set.
        Returns:
        the SqlDWSink object itself.

      • getCopyCommandSettings

        public DWCopyCommandSettings getCopyCommandSettings()
        Get the copyCommandSettings property: Specifies Copy Command related settings when allowCopyCommand is true.
        Returns:
        the copyCommandSettings value.

      • setCopyCommandSettings

        public SqlDWSink setCopyCommandSettings​(DWCopyCommandSettings copyCommandSettings)
        Set the copyCommandSettings property: Specifies Copy Command related settings when allowCopyCommand is true.
        Parameters:
        copyCommandSettings - the copyCommandSettings value to set.
        Returns:
        the SqlDWSink object itself.

      • getTableOption

        public Object getTableOption()
        Get the tableOption property: The option to handle sink table, such as autoCreate. For now only 'autoCreate' value is supported. Type: string (or Expression with resultType string).
        Returns:
        the tableOption value.

      • setTableOption

        public SqlDWSink setTableOption​(Object tableOption)
        Set the tableOption property: The option to handle sink table, such as autoCreate. For now only 'autoCreate' value is supported. Type: string (or Expression with resultType string).
        Parameters:
        tableOption - the tableOption value to set.
        Returns:
        the SqlDWSink object itself.

      • setWriteBatchSize

        public SqlDWSink setWriteBatchSize​(Object writeBatchSize)
        Set the writeBatchSize property: Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.
        Overrides:
        setWriteBatchSize in class CopySink
        Parameters:
        writeBatchSize - the writeBatchSize value to set.
        Returns:
        the CopySink object itself.

      • setWriteBatchTimeout

        public SqlDWSink setWriteBatchTimeout​(Object writeBatchTimeout)
        Set the writeBatchTimeout property: Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).
        Overrides:
        setWriteBatchTimeout in class CopySink
        Parameters:
        writeBatchTimeout - the writeBatchTimeout value to set.
        Returns:
        the CopySink object itself.

      • setSinkRetryCount

        public SqlDWSink setSinkRetryCount​(Object sinkRetryCount)
        Set the sinkRetryCount property: Sink retry count. Type: integer (or Expression with resultType integer).
        Overrides:
        setSinkRetryCount in class CopySink
        Parameters:
        sinkRetryCount - the sinkRetryCount value to set.
        Returns:
        the CopySink object itself.

      • setSinkRetryWait

        public SqlDWSink setSinkRetryWait​(Object sinkRetryWait)
        Set the sinkRetryWait property: Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).
        Overrides:
        setSinkRetryWait in class CopySink
        Parameters:
        sinkRetryWait - the sinkRetryWait value to set.
        Returns:
        the CopySink object itself.

      • setMaxConcurrentConnections

        public SqlDWSink setMaxConcurrentConnections​(Object maxConcurrentConnections)
        Set the maxConcurrentConnections property: The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).
        Overrides:
        setMaxConcurrentConnections in class CopySink
        Parameters:
        maxConcurrentConnections - the maxConcurrentConnections value to set.
        Returns:
        the CopySink object itself.