ADBC JavaScript Driver Manager
    Preparing search index...

    Interface AdbcStatement

    Represents a query statement.

    An AdbcStatement is used to execute SQL queries or prepare bulk insertions. State such as the SQL query string or bound parameters is held by the statement.

    interface AdbcStatement {
        setSqlQuery(query: string): Promise<void>;
        setOption(key: string, value: string): void;
        executeQuery(): Promise<RecordBatchReader<any>>;
        executeUpdate(): Promise<number>;
        bind(data: Table): Promise<void>;
        bindStream(reader: RecordBatchReader): Promise<void>;
        close(): Promise<void>;
    }

    Implemented by

    Index

    Methods

    setSqlQuery setOption executeQuery executeUpdate bind bindStream close

    Methods

    • Set the SQL query string.

      Parameters

      • query: string

        The SQL query to execute.

      Returns Promise<void>

    • Set an option on the statement.

      Parameters

      • key: string

        The option name (e.g., "adbc.ingest.target_table").

      • value: string

        The option value.

      Returns void

    • Execute the query and return a stream of results.

      Returns Promise<RecordBatchReader<any>>

      A Promise resolving to an Apache Arrow RecordBatchReader. The reader must be consumed or closed to release resources.

    • Execute an update command (e.g., INSERT, UPDATE, DELETE) that returns no data.

      Returns Promise<number>

      A Promise resolving to the number of rows affected (if known), or -1.

    • Bind parameters or data for ingestion.

      This is used for bulk ingestion or parameterized queries.

      Parameters

      • data: Table

        Arrow Table containing the data to bind.

      Returns Promise<void>

    • Bind a stream of data for ingestion or parameterized queries.

      Streams batches one at a time to the driver, avoiding full materialization of the reader in memory.

      Parameters

      • reader: RecordBatchReader

        Arrow RecordBatchReader to bind.

      Returns Promise<void>

    • Close the statement and release resources.

      Returns Promise<void>

    Settings

    Member Visibility

    On This Page

    Methods