@exasol/exasol-driver-ts
    Preparing search index...

    Interface CsvExportFormatOptions

    Options for CSV file export. See https://docs.exasol.com/db/latest/sql/export.htm

    interface CsvExportFormatOptions {
        columnDelimiter?: string;
        columnSeparator?: string;
        encoding?: Encoding;
        null?: string;
        rowSeparator?: CsvExportRowSeparator;
        withColumnNames?: boolean;
    }
    Index
    columnDelimiter? columnSeparator? encoding? null? rowSeparator? withColumnNames?
    columnDelimiter?: string

    Defines the field delimiter for CSV files.

    By default, the double quote character " is used. You can specify any string as a delimiter, either as plain text ('"'), as a hexadecimal value ('0x09'), or as an ASCII abbreviation ('NUL', 'TAB', 'LF', 'CR', 'ESC').

    A plain text value is limited to 10 characters, which are automatically converted to the encoding set for the file with the ENCODING option.

    A hexadecimal value is limited to 10 bytes (not characters) and will not be converted.

    To disable field delimiters, use an empty string ('').

    columnSeparator?: string

    Defines the field separator for CSV files.

    By default, comma is used. You can specify any string as a separator, either as plain text (','), as a hexadecimal value ('0x09'), or as an ASCII abbreviation ('NUL', 'TAB', 'LF', 'CR', 'ESC').

    A plain text value is limited to 10 characters, which are automatically converted to the encoding set for the file with the ENCODING option.

    A hexadecimal value is limited to 10 bytes (not characters) and will not be converted.

    encoding?: Encoding

    Encoding of the CSV file.

    Default is UTF-8, an Encoding value.

    null?: string

    Defines the representation of NULL values.

    By default, NULL values are written as an empty string.

    rowSeparator?: CsvExportRowSeparator

    Defines the line break character between rows.

    Default: RowSeparator.LF.

    withColumnNames?: boolean

    Includes column names as the first row of the exported CSV file.

    The other format options also apply to the header row. For a query, the header can contain expressions rather than table-column names.

    Settings
    Member Visibility

    On This Page
    Properties