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

Class AzureSqlSink

  • public final class AzureSqlSink
extends CopySink
    A copy activity Azure SQL sink.

    • Constructor Detail

      • AzureSqlSink

        public AzureSqlSink()

    • Method Detail

      • getSqlWriterStoredProcedureName

        public Object getSqlWriterStoredProcedureName()
        Get the sqlWriterStoredProcedureName property: SQL writer stored procedure name. Type: string (or Expression with resultType string).
        Returns:
        the sqlWriterStoredProcedureName value.

      • setSqlWriterStoredProcedureName

        public AzureSqlSink setSqlWriterStoredProcedureName​(Object sqlWriterStoredProcedureName)
        Set the sqlWriterStoredProcedureName property: SQL writer stored procedure name. Type: string (or Expression with resultType string).
        Parameters:
        sqlWriterStoredProcedureName - the sqlWriterStoredProcedureName value to set.
        Returns:
        the AzureSqlSink object itself.

      • getSqlWriterTableType

        public Object getSqlWriterTableType()
        Get the sqlWriterTableType property: SQL writer table type. Type: string (or Expression with resultType string).
        Returns:
        the sqlWriterTableType value.

      • setSqlWriterTableType

        public AzureSqlSink setSqlWriterTableType​(Object sqlWriterTableType)
        Set the sqlWriterTableType property: SQL writer table type. Type: string (or Expression with resultType string).
        Parameters:
        sqlWriterTableType - the sqlWriterTableType value to set.
        Returns:
        the AzureSqlSink object itself.

      • 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 AzureSqlSink 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 AzureSqlSink object itself.

      • getStoredProcedureParameters

        public Map<String,​StoredProcedureParameter> getStoredProcedureParameters()
        Get the storedProcedureParameters property: SQL stored procedure parameters.
        Returns:
        the storedProcedureParameters value.

      • setStoredProcedureParameters

        public AzureSqlSink setStoredProcedureParameters​(Map<String,​StoredProcedureParameter> storedProcedureParameters)
        Set the storedProcedureParameters property: SQL stored procedure parameters.
        Parameters:
        storedProcedureParameters - the storedProcedureParameters value to set.
        Returns:
        the AzureSqlSink object itself.

      • getStoredProcedureTableTypeParameterName

        public Object getStoredProcedureTableTypeParameterName()
        Get the storedProcedureTableTypeParameterName property: The stored procedure parameter name of the table type. Type: string (or Expression with resultType string).
        Returns:
        the storedProcedureTableTypeParameterName value.

      • setStoredProcedureTableTypeParameterName

        public AzureSqlSink setStoredProcedureTableTypeParameterName​(Object storedProcedureTableTypeParameterName)
        Set the storedProcedureTableTypeParameterName property: The stored procedure parameter name of the table type. Type: string (or Expression with resultType string).
        Parameters:
        storedProcedureTableTypeParameterName - the storedProcedureTableTypeParameterName value to set.
        Returns:
        the AzureSqlSink 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 AzureSqlSink 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 AzureSqlSink object itself.

      • setWriteBatchSize

        public AzureSqlSink 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 AzureSqlSink 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 AzureSqlSink 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 AzureSqlSink 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 AzureSqlSink 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.