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

    Interface IExasolDriver

    Node.js driver contract including local CSV import and export.

    interface IExasolDriver {
        "[asyncDispose]"(): PromiseLike<void>;
        cancel(): Promise<void>;
        close(): Promise<void>;
        connect(): Promise<void>;
        execute(
            sqlStatement: string,
            attributes?: Partial<Attributes>,
            getCancel?: CetCancelFunction,
        ): Promise<number>;
        execute(
            sqlStatement: string,
            attributes?: Partial<Attributes>,
            getCancel?: CetCancelFunction,
            responseType?: "default",
        ): Promise<number>;
        execute(
            sqlStatement: string,
            attributes?: Partial<Attributes>,
            getCancel?: CetCancelFunction,
            responseType?: "raw",
        ): Promise<SQLResponse<SQLQueriesResponse>>;
        executeBatch(
            sqlStatements: string[],
            attributes?: Partial<Attributes>,
            getCancel?: CetCancelFunction,
        ): Promise<SQLResponse<SQLQueriesResponse>>;
        exportToCsvFile(
            source: string,
            filePath: string,
            csvOptions?: CsvExportFormatOptions,
            options?: CsvExportOptions,
        ): Promise<number>;
        importFromCsvFile(
            tableName: string,
            filePath: string,
            csvOptions?: CsvFormatOptions,
            options?: FileImportOptions,
        ): Promise<number>;
        importFromParquetFile(
            tableName: string,
            filePath: string,
            parquetOptions?: ParquetImportOptions,
            options?: FileImportOptions,
        ): Promise<number>;
        prepare(sqlStatement: string): Promise<IStatement>;
        query(
            sqlStatement: string,
            attributes?: Partial<Attributes>,
            getCancel?: CetCancelFunction,
        ): Promise<QueryResult>;
        query(
            sqlStatement: string,
            attributes?: Partial<Attributes>,
            getCancel?: CetCancelFunction,
            responseType?: "default",
        ): Promise<QueryResult>;
        query(
            sqlStatement: string,
            attributes?: Partial<Attributes>,
            getCancel?: CetCancelFunction,
            responseType?: "raw",
        ): Promise<SQLResponse<SQLQueriesResponse>>;
        sendCommand<T>(cmd: Commands): Promise<SQLResponse<T>>;
        sendCommandWithNoResult(cmd: AbortQueryCommand): Promise<void>;
    }

    Hierarchy (View Summary)

    Implemented by

    Index
    [asyncDispose] cancel close connect execute executeBatch exportToCsvFile importFromCsvFile importFromParquetFile prepare query sendCommand sendCommandWithNoResult

    • Returns PromiseLike<void>

    • Export an Exasol table or parenthesized query result to a new local CSV file.

      Node.js only.

      Parameters

      • source: string

        Source table name (optionally schema-qualified) or parenthesized query

      • filePath: string

        Path to the new local CSV file

      • OptionalcsvOptions: CsvExportFormatOptions

        Optional CSV format options

      • Optionaloptions: CsvExportOptions

        Optional export control options

      Returns Promise<number>

      Number of rows exported

    • Import data from a local CSV file into an Exasol table.

      Node.js only.

      Parameters

      • tableName: string

        Target table name (optionally schema-qualified)

      • filePath: string

        Path to the local CSV file

      • OptionalcsvOptions: CsvFormatOptions

        Optional CSV format options

      • Optionaloptions: FileImportOptions

        Optional import control options

      Returns Promise<number>

      Number of rows imported

    • Import data from a local Parquet file into an Exasol table.

      Node.js only. Requires Exasol 2025.1.9 or later.

      Parameters

      • tableName: string

        Target table name (optionally schema-qualified)

      • filePath: string

        Path to the local Parquet file

      • OptionalparquetOptions: ParquetImportOptions

        Optional Parquet import options

      • Optionaloptions: FileImportOptions

        Optional import control options

      Returns Promise<number>

      Number of rows imported

    Settings
    Member Visibility

    On This Page
    Methods