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

    Interface QwpNodeUdpOptions

    Everything a Node QWP-over-UDP sender takes: the datagram socket and row buffering. Every datagram is self-contained and none is ever part of a transaction, so the sender's transactional and encoding options are absent.

    interface QwpNodeUdpOptions {
        autoFlush?: boolean;
        autoFlushBytes?: number;
        autoFlushIntervalMs?: number;
        autoFlushRows?: number;
        closeFlushTimeoutMs?: number;
        host: string;
        log?: QwpSenderLogger;
        maxDatagramSize?: number;
        maxNameLength?: number;
        multicastInterface?: string;
        multicastTtl?: number;
        onError?: (error: Error) => void;
        port?: number;
        socketFactory?: () => QwpNodeUdpSocketLike;
    }

    Hierarchy

    • Omit<QwpSenderOptions, "transactional" | "gorilla" | "symbolDictionary">
      • QwpNodeUdpOptions
    Index

    Properties

    autoFlush?: boolean
    autoFlushBytes?: number

    Soft threshold for estimated buffered column bytes; zero disables the byte trigger. Defaults to maxDatagramSize.

    autoFlushIntervalMs?: number

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

    autoFlushRows?: number
    closeFlushTimeoutMs?: number

    Maximum time close() spends publishing queued rows and waiting for the server ACK watermark. Zero or a negative value skips the ACK wait, but RAM-backed frames still have up to 5 seconds to reach the socket before close() reports a timeout; if the session can no longer send them at all, close() rejects with its failure. Defaults to 5 seconds. Capped at 2,147,483,647ms (the host timer ceiling); a larger value throws a RangeError.

    host: string

    Destination hostname or IPv4 address.

    maxDatagramSize?: number

    Maximum encoded datagram size. Defaults to 1400 bytes.

    maxNameLength?: number

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

    multicastInterface?: string

    Optional local IPv4 interface used for multicast traffic.

    multicastTtl?: number

    IPv4 multicast TTL from 0 through 255. Defaults to 0.

    onError?: (error: Error) => void

    Receives isolated local socket errors; UDP has no server acknowledgement.

    port?: number

    Destination port. Defaults to the Java QWP UDP port, 9007.

    socketFactory?: () => QwpNodeUdpSocketLike

    Test hook.