QuestDB Node.js Client - v4.2.0
    Preparing search index...

    Class SenderBufferV1

    Buffer implementation for protocol version 1.
    Sends floating point numbers in their text form.

    Hierarchy

    • SenderBufferBase
      • SenderBufferV1
    Index

    Constructors

    Properties

    buffer: Buffer
    position: number
    log: Logger

    Methods

    • Resets the buffer, data sitting in the buffer will be lost.
      In other words it clears the buffer, and sets the writing position to the beginning of the buffer.

      Returns SenderBuffer

      Returns with a reference to this buffer.

    • Parameters

      • pos: number = ...

      Returns Buffer

      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

      • pos: number = ...

      Returns Buffer

      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.

    • Writes the table name into the buffer.

      Parameters

      • table: string

        Table name.

      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.

      Returns SenderBuffer

      Returns with a reference to this buffer.

    • 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.

      Returns SenderBuffer

      Returns with a reference to this buffer.

    • 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.

      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.

      Returns SenderBuffer

      Returns with a reference to this buffer.

      Error if the value is not an integer

    • 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.

      • Optionalunit: TimestampUnit = "us"

        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.

    • 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 = "us"

        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 value is not an integer or BigInt.

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

    • Closes the row without writing designated timestamp into the buffer.
      Designated timestamp will be populated by the server on this record.

      Returns void

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

      Returns number

    • Checks if the buffer has sufficient capacity for additional data and resizes if needed.

      Parameters

      • data: string[]

        Array of strings to calculate the required capacity for

      • base: number = 0

        Base number of bytes to add to the calculation

      Returns void

    • 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").

      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 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.
      • 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 between 0 and 76.
      • unscaled contains invalid bytes.
    • Writes a 64-bit floating point value into the buffer using v1 serialization (text format).
      Use it to insert into DOUBLE or FLOAT database columns.

      Parameters

      • name: string

        Column name.

      • value: number

        Column value, accepts only number values.

      Returns SenderBuffer

      Returns with a reference to this sender.

    • Parameters

      • timestamp: number | bigint
      • unit: TimestampUnit = "us"
      • designated: boolean

      Returns void