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

    Interface QwpSenderOptions

    Options for the browser-safe, fluent QWP sender.

    interface QwpSenderOptions {
        autoFlush?: boolean;
        autoFlushBytes?: number;
        autoFlushIntervalMs?: number;
        autoFlushRows?: number;
        awaitDurableAck?: boolean;
        awaitServerAck?: boolean;
        closeFlushTimeoutMs?: number;
        durableAckTimeoutMs?: number;
        encode?: QwpSenderEncodeOptions;
        log?: QwpSenderLogger;
        maxNameLength?: number;
        transactional?: boolean;
    }
    Index

    Properties

    autoFlush?: boolean
    autoFlushBytes?: number

    Soft threshold for estimated buffered column bytes. Zero disables the byte trigger. Defaults to zero and is clamped below a connected server's batch cap; exact encoded frames remain subject to the protocol batch limit.

    autoFlushIntervalMs?: number

    Not capped at the host timer ceiling: compared against elapsed time only.

    autoFlushRows?: number
    awaitDurableAck?: boolean

    Wait for durable upload after every successful ingress ACK. When true, this implies awaitServerAck unless awaitServerAck is explicitly false.

    awaitServerAck?: boolean

    Wait for the server's protocol ACK before flush()/commit() resolves. Defaults to false, matching the Java QWP sender's local-publication boundary. Set this to true for an acknowledgement barrier, or use flushAndGetSequence() followed by waitForAcknowledged().

    closeFlushTimeoutMs?: number

    Maximum time close() spends publishing queued rows and waiting for the server ACK watermark. Zero or a negative value skips the drain. Defaults to 5 seconds. Capped at 2,147,483,647ms (the host timer ceiling); a larger value throws a RangeError.

    durableAckTimeoutMs?: number

    Durable-upload deadline applied after each ingress ACK. Capped at 2,147,483,647ms (the host timer ceiling); a larger value throws a RangeError.

    QWP frame encoding options supported by the high-level sender.

    maxNameLength?: number

    Maximum UTF-8 byte length of table and column names. Defaults to 127.

    transactional?: boolean

    Keep auto-flushed rows in an open server-side transaction. An explicit flush()/commit() closes the transaction. QWP transactions are atomic per table, rather than across every table in a multi-table flush.