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

    Interface SenderBuffer

    Buffer used by the Sender for data serialization.
    Provides methods for writing different data types into the buffer.

    interface SenderBuffer {
        arrayColumn(name: string, value: unknown[]): SenderBuffer;
        at(timestamp: number | bigint, unit?: TimestampUnit): void;
        atNow(): void;
        booleanColumn(name: string, value: boolean): SenderBuffer;
        currentPosition(): number;
        decimalColumn(
            name: string,
            unscaled: bigint | Int8Array<ArrayBufferLike>,
            scale: number,
        ): SenderBuffer;
        decimalColumnText(name: string, value: string | number): SenderBuffer;
        floatColumn(name: string, value: number): SenderBuffer;
        intColumn(name: string, value: number): SenderBuffer;
        reset(): SenderBuffer;
        stringColumn(name: string, value: string): SenderBuffer;
        symbol(name: string, value: unknown): SenderBuffer;
        table(table: string): SenderBuffer;
        timestampColumn(
            name: string,
            value: number | bigint,
            unit?: TimestampUnit,
        ): SenderBuffer;
        toBufferNew(pos?: number): Buffer<ArrayBufferLike>;
        toBufferView(pos?: number): Buffer;
    }
    Index

    Methods

    arrayColumn at atNow booleanColumn currentPosition decimalColumn decimalColumnText floatColumn intColumn reset stringColumn symbol table timestampColumn toBufferNew toBufferView

    Methods

    • Writes an array column with its values into the buffer.

      Parameters

      • name: string

        Column name

      • value: unknown[]

        Array values to write (currently supports double arrays). A null or undefined value omits the column entirely when arrays are supported; protocol v1 rejects the call for every value.

      Returns SenderBuffer

      Returns with a reference to this buffer.

      Error if arrays are not supported by the buffer implementation, or array validation fails:

      • value is not an array
      • or the shape of the array is irregular: the length of sub-arrays are different
      • or the array is not homogeneous: its elements are not all the same type

    • Closes the row after writing the designated timestamp into the buffer.

      Precision rules:

      • Protocol v2 and higher: Timestamps passed with unit 'ns' (nanoseconds) are sent with full nanosecond precision. All other timestamps are sent with microsecond precision.
      • Protocol v1: Always uses microsecond precision, even if the timestamp is specified in nanoseconds.

      Parameters

      • timestamp: number | bigint

        Designated epoch timestamp. Must be an integer or a BigInt.

      • Optionalunit: TimestampUnit

        The time unit of the timestamp. Supported values:

        • 'ns' — nanoseconds (requires BigInt)
        • 'us' — microseconds (default)
        • 'ms' — milliseconds

      Returns void

      Returns with a reference to this buffer.

      If timestamp is not an integer or BigInt.

      If unit is 'ns' but timestamp is not a BigInt.

      If unit is not one of 'ns', 'us', or 'ms'. Argument validation -- the unit and the timestamp alike -- runs before the close touches the row, so it leaves the open row unchanged and the call can be retried with a corrected argument.

      If the row has no symbol or column set. Such a row can never be closed by any argument, so it is discarded ahead of the argument checks and the next row starts from table().

      If the row cannot be closed within max_buf_size. The partial close is rewound, so the same call succeeds once a flush() frees space.

    • Writes a boolean column with its value into the buffer. Use it to insert into BOOLEAN columns.

      Parameters

      • name: string

        Column name.

      • value: boolean

        Column value, accepts only boolean values. A null or undefined value omits the column entirely (stored as NULL).

      Returns SenderBuffer

      Returns with a reference to this buffer.

    • Returns the current position of the buffer. New data will be written into the buffer starting from this position.

      Returns number

      The current write position in the buffer

    • Writes a decimal value into the buffer using its binary format.

      Use it to insert into DECIMAL database columns.

      Parameters

      • name: string

        Column name.

      • unscaled: bigint | Int8Array<ArrayBufferLike>

        The unscaled integer portion of the decimal value.

        • If a bigint is provided, it will be converted automatically.
        • If an Int8Array is provided, it must contain the two’s complement representation of the unscaled value in big-endian byte order.
        • An empty Int8Array represents a NULL value.
        • A null or undefined value omits the column entirely (stored as NULL) when decimals are supported; protocol v1/v2 reject the call for every value.
      • scale: number

        The number of fractional digits (the scale) of the decimal value.

      Returns SenderBuffer

      Returns with a reference to this buffer.

      If decimals are not supported by the buffer implementation, or validation fails. Possible validation errors:

      • unscaled length is not between 0 and 32 bytes.
      • scale is not an integer between 0 and 76.
      • unscaled contains invalid bytes.

    • Writes a decimal value into the buffer using its text format.

      Use it to insert into DECIMAL database columns.

      Parameters

      • name: string

        Column name.

      • value: string | number

        The decimal value to write.

        • Accepts either a number or a string containing a valid decimal representation.
        • String values should follow standard decimal notation (e.g., "123.45" or "-0.001").
        • A null or undefined value omits the column entirely (stored as NULL) when decimals are supported; protocol v1/v2 reject the call for every value.

      Returns SenderBuffer

      Returns with a reference to this buffer.

      Error If decimals are not supported by the buffer implementation, or validation fails. Possible validation errors:

      • The provided string is not a valid decimal representation.

    • Writes a 64-bit floating point value into the buffer. Use it to insert into DOUBLE or FLOAT database columns.

      Parameters

      • name: string

        Column name.

      • value: number

        Column value, accepts only number values. A null or undefined value omits the column entirely (stored as NULL).

      Returns SenderBuffer

      Returns with a reference to this buffer.

    • Writes a 64-bit signed integer into the buffer. Use it to insert into LONG, INT, SHORT and BYTE columns.

      Parameters

      • name: string

        Column name.

      • value: number

        Column value, accepts only number values. A null or undefined value omits the column entirely (stored as NULL).

      Returns SenderBuffer

      Returns with a reference to this buffer.

      Error if the value is not an integer

    • Writes a string column with its value into the buffer. Use it to insert into VARCHAR and STRING columns.

      Parameters

      • name: string

        Column name.

      • value: string

        Column value, accepts only string values. A null or undefined value omits the column entirely (stored as NULL).

      Returns SenderBuffer

      Returns with a reference to this buffer.

    • Writes a symbol name and value into the buffer. Use it to insert into SYMBOL columns.

      Parameters

      • name: string

        Symbol name.

      • value: unknown

        Symbol value, toString() is called to extract the actual symbol value from the parameter. A null or undefined value omits the symbol entirely (stored as NULL).

      Returns SenderBuffer

      Returns with a reference to this buffer.

    • Writes a timestamp column and its value into the buffer.

      Use this method to insert data into TIMESTAMP or TIMESTAMP_NS columns.

      Precision rules:

      • Protocol v2 and higher: Timestamps passed with unit 'ns' (nanoseconds) are sent with full nanosecond precision. All other timestamps are sent with microsecond precision.
      • Protocol v1: Always uses microsecond precision, even if the timestamp is specified in nanoseconds.

      Parameters

      • name: string

        The column name.

      • value: number | bigint

        The epoch timestamp. Must be an integer or a BigInt. A null or undefined value omits the column entirely (stored as NULL).

      • Optionalunit: TimestampUnit

        The time unit of the timestamp. Supported values:

        • 'ns' — nanoseconds (requires BigInt)
        • 'us' — microseconds (default)
        • 'ms' — milliseconds

      Returns SenderBuffer

      Returns with a reference to this buffer.

      If value is not an integer or BigInt.

      If unit is 'ns' but value is not a BigInt.

      If unit is not one of 'ns', 'us', or 'ms'. This validation runs even when value is null or undefined.

    • Returns a cropped buffer ready to send to the server, or null if there is nothing to send. The returned buffer is a copy of this buffer. It also compacts the buffer.

      Parameters

      • Optionalpos: number

        Optional position parameter

      Returns Buffer<ArrayBufferLike>

      A copy of the buffer ready to send, or null

    • Returns a cropped buffer, or null if there is nothing to send. The returned buffer is backed by this buffer instance, meaning the view can change as the buffer is mutated. Used only in tests to assert the buffer's content.

      Parameters

      • Optionalpos: number

        Optional position parameter

      Returns Buffer

      A view of the buffer

    Settings

    Member Visibility

    On This Page

    Methods