Package com.exasol

Interface ExaExportSpecification

  • public interface ExaExportSpecification
    This class holds all information about a user-defined EXPORT, which can be started using the EXPORT INTO SCRIPT ... statement.

    To support a user-defined EXPORT you can implement the callback method generateSqlForExportSpec(ExaExportSpecification exportSpec). Please refer to the Exasol online guide for more details.

    • Method Detail

      • hasConnectionName

        boolean hasConnectionName()
        Indicates whether the name of a connection was specified.

        The script can then obtain the connection information via ExaMetadata.getConnection(String).

        Returns:
        true, if the name of a connection was specified

      • getConnectionName

        String getConnectionName()
        Get the name of the connection.

        Use hasConnectionName() to check whether the name is set before calling this method.

        Returns:
        name of the connection, if one was specified or null otherwise

      • hasConnectionInformation

        boolean hasConnectionInformation()
        Check if the connection information was provided.

        The script can then obtain the connection information via ExaMetadata.getConnection(String).

        Returns:
        true, if connection information was provided

      • getConnectionInformation

        ExaConnectionInformation getConnectionInformation()
        Get the details of the connection information.
        Returns:
        connection information

      • getParameters

        Map<String,​String> getParameters()
        Get the export parameters
        Returns:
        parameters specified in the EXPORT statement.

      • hasTruncate

        boolean hasTruncate()
        Check if the truncation option is set.
        Returns:
        true, if TRUNCATE was specified

      • hasReplace

        boolean hasReplace()
        Check if the replacement option is set.
        Returns:
        true, if REPLACE was specified

      • hasCreatedBy

        boolean hasCreatedBy()
        This returns true if CREATED BY was specified in the EXPORT statement.
        Returns:
        true, if CREATED BY was specified

      • getCreatedBy

        String getCreatedBy()
        Get the definition for the target table creation.

        CREATED BY defines a creation string which is used to create the table on the target system before the export is started. The CREATED BY string contains a single SQL statement; multiple statements are not supported.

        Returns:
        CREATED BY statement, if one was specified or otherwise null

      • getSourceColumnNames

        List<String> getSourceColumnNames()
        Get the names of all source columns
        Returns:
        names or columns in the EXPORT statement.