QuestDB JavaScript Client - v5.0.0
    Preparing search index...

    Interface QwpEgressQueryOptions

    interface QwpEgressQueryOptions {
        autoCredit?: boolean;
        bindCount?: number;
        bindPayload?: Uint8Array<ArrayBufferLike>;
        binds?: QwpBindSetter;
        initialCredit?: number | bigint;
        onFailoverReset?: (
            event: QwpEgressFailoverResetEvent,
        ) => void | Promise<void>;
        resetDictionary?: boolean;
        timeoutMs?: number;
    }
    Index

    Properties

    autoCredit?: boolean

    Replenishes positive initial credit by each RESULT_BATCH wire size after the async iterator advances past that batch. Defaults to true.

    bindCount?: number

    Advanced escape hatch for an already encoded bind section.

    bindPayload?: Uint8Array<ArrayBufferLike>

    Advanced escape hatch for an already encoded bind section.

    Sets typed positional parameters; index 0 maps to SQL placeholder $1.

    initialCredit?: number | bigint

    Overrides session send-ahead credit. Zero explicitly disables flow control.

    onFailoverReset?: (event: QwpEgressFailoverResetEvent) => void | Promise<void>

    Notification before this query is replayed after failover. Use it to clear results already consumed from the old connection. Overrides the session's onFailoverReset for this query; the callback is awaited before replay. The query's timeout keeps running meanwhile, and a query whose timeout expires first is not replayed.

    resetDictionary?: boolean

    Ask a capable server to reset its connection-scoped symbol dictionary. Silently omitted when the server lacks QUERY_FLAGS for rolling upgrades.

    timeoutMs?: number

    Per-query timeout overriding the session default; zero disables it.

    It bounds the whole query, measured from the query() call: waiting for a previous query to drain, any reconnect, server execution, and the time spent consuming results, which is not interrupted. Once it expires no further batch is delivered and the query is cancelled. The outcome is the server's answer: a statement that completed, or a result that ended with nothing withheld, still succeeds; otherwise iteration and completion reject with QwpEgressQueryTimeoutError. A cancellation the application requested before the timeout is reported as such. If the server has not ended the query within cancelDrainTimeoutMs, or the connection is lost, the timeout is reported at once and the query is not replayed. Capped at 2,147,483,647ms (the host timer ceiling); a larger value throws a RangeError.