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

    Interface QwpEgressSessionOptions

    interface QwpEgressSessionOptions {
        bufferPoolSize?: number;
        cancelDrainTimeoutMs?: number;
        connectionListenerInboxCapacity?: number;
        initialCredit?: number | bigint;
        maxBatchRows?: number;
        onReplayReset?: (event: QwpEgressReplayResetEvent) => void | Promise<void>;
        queryTimeoutMs?: number;
        reconnect?: false | QwpReconnectOptions;
        serverInfoTimeoutMs?: number;
    }
    Index

    Properties

    bufferPoolSize? cancelDrainTimeoutMs? connectionListenerInboxCapacity? initialCredit? maxBatchRows? onReplayReset? queryTimeoutMs? reconnect? serverInfoTimeoutMs?

    Properties

    bufferPoolSize?: number

    Maximum decoded batches waiting for a consumer. Defaults to 4.

    cancelDrainTimeoutMs?: number

    Maximum wait for a terminal response after CANCEL. Defaults to 5 seconds. Capped at 2,147,483,647ms (the host timer ceiling); a larger value throws a RangeError.

    connectionListenerInboxCapacity?: number

    Bounded inbox depth for reconnect.onEvent. Defaults to 64, matching ingress. Overflow drops the oldest pending notification.

    initialCredit?: number | bigint

    Default per-query send-ahead credit. Defaults to zero (unbounded).

    maxBatchRows?: number

    Rejects a RESULT_BATCH declaring more rows than this. The connect helpers default it to the maxBatchRows they put on the wire, so the request the client makes is also the bound it enforces; decoder scratch is sized from the declared row count and retained per pool slot, so an answer above the request would set this session's memory floor for its lifetime.

    onReplayReset?: (event: QwpEgressReplayResetEvent) => void | Promise<void>

    Optional notification immediately before an active query is re-executed. Not-yet-consumed batches are discarded automatically; callers that retain an already-consumed prefix should discard it here. Omitting this callback leaves replay enabled and is appropriate for idempotent consumers.

    queryTimeoutMs?: number

    Default per-query deadline. Zero or undefined disables query deadlines. Capped at 2,147,483,647ms (the host timer ceiling); a larger value throws a RangeError.

    reconnect?: false | QwpReconnectOptions

    Bounded failover policy. Failover and at-least-once active-query replay are enabled by default; set false to keep one fixed connection.

    serverInfoTimeoutMs?: number

    SERVER_INFO handshake deadline. Defaults to 5 seconds. Capped at 2,147,483,647ms (the host timer ceiling); a larger value throws a RangeError.

    Settings

    Member Visibility

    On This Page

    Properties