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

    Interface QwpSenderSession

    The subset of QwpIngressSession used by QwpSender.

    Only sendTables, waitForDurable, and close are required. The optional members are capabilities the sender uses when present: the *WithPublication and publish* pairs separate the local publication boundary from the server ACK, sendTablesDelta/publishTablesDelta carry incremental symbol dictionaries, and waitForAcknowledged exposes the ACK watermark. A session that implements only the required members is supported and falls back to sendTables.

    interface QwpSenderSession {
        acknowledgedFrameSequence?: bigint;
        maxBatchSizeBytes?: number;
        metrics?: QwpIngressMetrics;
        publishedFrameSequence?: bigint;
        close(code?: number, reason?: string): Promise<void>;
        publishTables(
            tables: readonly QwpTableBuffer[],
            options?: QwpIngressEncodeOptions,
        ): Promise<void>;
        publishTablesDelta(
            tables: readonly QwpTableBuffer[],
            options?: Pick<QwpIngressEncodeOptions, "gorilla" | "deferCommit">,
        ): Promise<void>;
        sendTables(
            tables: readonly QwpTableBuffer[],
            options?: QwpIngressEncodeOptions,
        ): Promise<QwpIngressResponse>;
        sendTablesDelta(
            tables: readonly QwpTableBuffer[],
            options?: Pick<QwpIngressEncodeOptions, "gorilla" | "deferCommit">,
        ): Promise<QwpIngressResponse>;
        sendTablesDeltaWithPublication(
            tables: readonly QwpTableBuffer[],
            options?: Pick<QwpIngressEncodeOptions, "gorilla" | "deferCommit">,
        ): QwpIngressSendResult;
        sendTablesWithPublication(
            tables: readonly QwpTableBuffer[],
            options?: QwpIngressEncodeOptions,
        ): QwpIngressSendResult;
        waitForAcknowledged(
            targetSequence: bigint,
            timeoutMs?: number,
        ): Promise<void>;
        waitForDurable(
            response: QwpIngressResponse,
            timeoutMs?: number,
        ): Promise<void>;
    }

    Implemented by

    Index

    Properties

    acknowledgedFrameSequence? maxBatchSizeBytes? metrics? publishedFrameSequence?

    Methods

    close publishTables? publishTablesDelta? sendTables sendTablesDelta? sendTablesDeltaWithPublication? sendTablesWithPublication? waitForAcknowledged? waitForDurable

    Properties

    acknowledgedFrameSequence?: bigint
    maxBatchSizeBytes?: number
    metrics?: QwpIngressMetrics
    publishedFrameSequence?: bigint

    Methods

    Settings

    Member Visibility

    On This Page

    Properties
    Methods