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

    Interface QwpBrowserEgressOptions

    Browser WebSocket options plus protocol-level egress topology routing.

    interface QwpBrowserEgressOptions {
        auth?: QwpBrowserSessionAuthentication | QwpBrowserAuthProvider;
        closeTimeoutMs?: number;
        compression?: QwpEgressCompression;
        compressionLevel?: number;
        connectTimeoutMs?: number;
        failoverUrls?: readonly (string | URL)[];
        ingressNegotiationTimeoutMs?: number;
        maxBatchRows?: number;
        protocols?: string | string[];
        requestDurableAck?: boolean;
        sendTimeoutMs?: number;
        sessionBootstrap?: QwpBrowserSessionBootstrapConfig;
        target?: QwpTarget;
        url: string | URL;
        webSocketFactory?: (
            url: string | URL,
            protocols?: string | string[],
        ) => QwpWebSocketLike;
        zone?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    auth? closeTimeoutMs? compression? compressionLevel? connectTimeoutMs? failoverUrls? ingressNegotiationTimeoutMs? maxBatchRows? protocols? requestDurableAck? sendTimeoutMs? sessionBootstrap? target? url webSocketFactory? zone?

    Properties

    auth?: QwpBrowserSessionAuthentication | QwpBrowserAuthProvider

    Authenticates every WebSocket upgrade with a credential carried in its subprotocol offer instead of a session cookie. This is how a web application served from another origin, which QuestDB lists in qwp.browser.allowed.origins, connects. Pass a fixed credential, or a QwpBrowserAuthProvider the client calls before every connect, reconnect, and failover attempt, for example to supply a refreshed OIDC access token.

    QuestDB accepts the credential only from a listed origin: a page served from QuestDB's own origin must be listed too, or keep using sessionBootstrap. It creates no session for the credential and ignores cookies on the upgrade. Use wss:: the credential travels in the opening HTTP request. Cannot be combined with sessionBootstrap.

    closeTimeoutMs?: number

    Maximum time allowed for a graceful WebSocket close. Defaults to 15s. Capped at 2,147,483,647ms (the host timer ceiling); a larger value throws a RangeError.

    compression?: QwpEgressCompression

    Requests Zstd-compressed result batches through browser-visible URL negotiation. Defaults to raw for compatibility.

    compressionLevel?: number

    Zstd level hint. Must be between 1 and 22, and only takes effect alongside compression; the default raw negotiates no compression for a level to travel on.

    connectTimeoutMs?: number

    Node TCP/TLS connection deadline, or the complete opening deadline in a browser. Defaults to 15s. Capped at 2,147,483,647ms (the host timer ceiling); a larger value throws a RangeError.

    failoverUrls?: readonly (string | URL)[]

    Additional endpoints attempted in order when the preferred endpoint fails.

    ingressNegotiationTimeoutMs?: number

    Time allowed for the optional ingress SERVER_INFO message. Defaults to 250ms; zero disables the initial wait while retaining late negotiation. Capped at 2,147,483,647ms (the host timer ceiling); a larger value throws a RangeError.

    maxBatchRows?: number

    Requests a server-side RESULT_BATCH row cap.

    protocols?: string | string[]
    requestDurableAck?: boolean

    Requests durable ingress ACKs through browser-visible WebSocket subprotocol negotiation.

    sendTimeoutMs?: number

    Maximum time a send may remain queued by the WebSocket. Defaults to 15s. Capped at 2,147,483,647ms (the host timer ceiling); a larger value throws a RangeError.

    sessionBootstrap?: QwpBrowserSessionBootstrapConfig

    Authenticates over REST before every WebSocket connection attempt so the browser can attach QuestDB's HttpOnly session cookies to the upgrade. Cannot be combined with auth.

    target?: QwpTarget

    Selects any readable node, a primary/standalone node, or a replica.

    url: string | URL
    webSocketFactory?: (
        url: string | URL,
        protocols?: string | string[],
    ) => QwpWebSocketLike

    Test or framework hook; defaults to the browser's global WebSocket.

    zone?: string

    Opaque, case-insensitive preferred zone; cross-zone fallback stays enabled.

    Settings

    Member Visibility

    On This Page

    Properties