Class QwpSender

Browser-safe high-level QWP ingress API.

Applications normally obtain this class through create/connectQwpNodeSender or create/connectQwpBrowserSender, rather than constructing sessions and QwpTableBuffer instances themselves.

Constructors

constructor

new QwpSender(
    sessionFactory: QwpSenderSessionFactory,
    options?: QwpSenderOptions,
    constraints?: QwpSenderTransportConstraints,
): QwpSender
Parameters
- sessionFactory: QwpSenderSessionFactory
- options: QwpSenderOptions = {}
- constraints: QwpSenderTransportConstraints = {}
Returns QwpSender
- Defined in packages/client-core/src/_qwp/sender.ts:1246

Accessors

acknowledgedSequence

get acknowledgedSequence(): bigint
Highest cumulative ACK watermark, or -1n before acknowledgement.

Returns bigint
- Defined in packages/client-core/src/_qwp/sender.ts:1963

metrics

get metrics(): QwpSenderMetrics
Returns QwpSenderMetrics
- Defined in packages/client-core/src/_qwp/sender.ts:1303

publishedSequence

get publishedSequence(): bigint
Highest stable frame sequence published by this sender.

Returns bigint
- Defined in packages/client-core/src/_qwp/sender.ts:1970

Methods

arrayColumn

arrayColumn(name: string, value: undefined | null | unknown[]): QwpSender
Adds a QuestDB DOUBLE[] value with between 1 and 32 dimensions.
Parameters
- name: string
- value: undefined | null | unknown[]
Returns QwpSender
- Defined in packages/client-core/src/_qwp/sender.ts:1537

at

at(value: number | bigint, unit?: QwpTimestampUnit): Promise<void>
Parameters
- value: number | bigint
- unit: QwpTimestampUnit = "us"
Returns Promise<void>
- Defined in packages/client-core/src/_qwp/sender.ts:1911

atNow

atNow(): Promise<void>
Returns Promise<void>
- Defined in packages/client-core/src/_qwp/sender.ts:1925

binaryColumn

binaryColumn(
name: string,
value: undefined | null | Uint8Array<ArrayBufferLike>,
): QwpSender
Parameters
- name: string
- value: undefined | null | Uint8Array<ArrayBufferLike>
Returns QwpSender
- Defined in packages/client-core/src/_qwp/sender.ts:1610

booleanColumn

booleanColumn(name: string, value: undefined | null | boolean): QwpSender
Parameters
- name: string
- value: undefined | null | boolean
Returns QwpSender
- Defined in packages/client-core/src/_qwp/sender.ts:1431

byteColumn

byteColumn(name: string, value: undefined | null | number): QwpSender
Parameters
- name: string
- value: undefined | null | number
Returns QwpSender
- Defined in packages/client-core/src/_qwp/sender.ts:1459

cancelRow

cancelRow(): QwpSender
Discards the row in progress, including its table selection, so the next row starts from table() again. Rows already completed stay staged.

Returns QwpSender
- Defined in packages/client-core/src/_qwp/sender.ts:1905

charColumn

charColumn(name: string, value: undefined | null | string): QwpSender
Parameters
- name: string
- value: undefined | null | string
Returns QwpSender
- Defined in packages/client-core/src/_qwp/sender.ts:1639

close

close(): Promise<void>
Returns Promise<void>
- Defined in packages/client-core/src/_qwp/sender.ts:2045

commit

commit(): Promise<boolean>
Commits rows previously sent by transactional auto-flush. This is an ergonomic alias for flush(); pending local rows are included in the same group-closing frame.

Returns Promise<boolean>
- Defined in packages/client-core/src/_qwp/sender.ts:2011

connect

connect(): Promise<boolean>
Returns Promise<boolean>
- Defined in packages/client-core/src/_qwp/sender.ts:1297

dateColumn

dateColumn(
name: string,
millisecondsSinceEpoch: undefined | null | number | bigint,
): QwpSender
Adds a QuestDB DATE column value in milliseconds since the epoch. -9_223_372_036_854_775_808n is QuestDB's DATE NULL sentinel: it is stored as NULL and cannot be stored as an ordinary value.
Parameters
- name: string
- millisecondsSinceEpoch: undefined | null | number | bigint
Returns QwpSender
- Defined in packages/client-core/src/_qwp/sender.ts:1594

decimal128Column

decimal128Column(
    name: string,
    unscaled: undefined | null | bigint,
    scale: number,
): QwpSender
Parameters
- name: string
- unscaled: undefined | null | bigint
- scale: number
Returns QwpSender
- Defined in packages/client-core/src/_qwp/sender.ts:1829

decimal256Column

decimal256Column(
    name: string,
    unscaled: undefined | null | bigint,
    scale: number,
): QwpSender
Parameters
- name: string
- unscaled: undefined | null | bigint
- scale: number
Returns QwpSender
- Defined in packages/client-core/src/_qwp/sender.ts:1844

decimal64Column

decimal64Column(
    name: string,
    unscaled: undefined | null | bigint,
    scale: number,
): QwpSender
Parameters
- name: string
- unscaled: undefined | null | bigint
- scale: number
Returns QwpSender
- Defined in packages/client-core/src/_qwp/sender.ts:1814

decimalColumn

decimalColumn(
    name: string,
    unscaled: undefined | null | bigint | Int8Array<ArrayBufferLike>,
    scale: number,
): QwpSender
Parameters
- name: string
- unscaled: undefined | null | bigint | Int8Array<ArrayBufferLike>
- scale: number
Returns QwpSender
- Defined in packages/client-core/src/_qwp/sender.ts:1751

decimalColumnText

decimalColumnText(
name: string,
value: undefined | null | string | number,
): QwpSender
Parameters
- name: string
- value: undefined | null | string | number
Returns QwpSender
- Defined in packages/client-core/src/_qwp/sender.ts:1725

doubleColumn

doubleColumn(name: string, value: undefined | null | number): QwpSender
Parameters
- name: string
- value: undefined | null | number
Returns QwpSender
- Defined in packages/client-core/src/_qwp/sender.ts:1447

float32Column

float32Column(name: string, value: undefined | null | number): QwpSender
Parameters
- name: string
- value: undefined | null | number
Returns QwpSender
- Defined in packages/client-core/src/_qwp/sender.ts:1451

floatColumn

floatColumn(name: string, value: undefined | null | number): QwpSender
Parameters
- name: string
- value: undefined | null | number
Returns QwpSender
- Defined in packages/client-core/src/_qwp/sender.ts:1439

flush

flush(): Promise<boolean>
Publishes completed rows to the local ingress/replay boundary. This does not wait for a server ACK unless awaitServerAck or awaitDurableAck is set.

Returns Promise<boolean>
- Defined in packages/client-core/src/_qwp/sender.ts:1948

flushAndGetSequence

flushAndGetSequence(): Promise<bigint>
Publishes pending rows without waiting for their server ACK and returns the highest frame sequence produced by this call, or -1n when empty. Pass the result to waitForAcknowledged() when an explicit delivery barrier is needed.

Returns Promise<bigint>
- Defined in packages/client-core/src/_qwp/sender.ts:1958

geohashColumn

geohashColumn(
    name: string,
    value: undefined | null | bigint,
    precision: number,
): QwpSender
Parameters
- name: string
- value: undefined | null | bigint
- precision: number
Returns QwpSender
- Defined in packages/client-core/src/_qwp/sender.ts:1859

int32Column

int32Column(name: string, value: undefined | null | number): QwpSender
Adds a QuestDB INT column value. -2_147_483_648 is QuestDB's INT NULL sentinel: it is stored as NULL and cannot be stored as an ordinary value.
Parameters
- name: string
- value: undefined | null | number
Returns QwpSender
- Defined in packages/client-core/src/_qwp/sender.ts:1489

intColumn

intColumn(name: string, value: undefined | null | number): QwpSender
Parameters
- name: string
- value: undefined | null | number
Returns QwpSender
- Defined in packages/client-core/src/_qwp/sender.ts:1502

ipv4Column

ipv4Column(name: string, value: undefined | null | string | number): QwpSender
Parameters
- name: string
- value: undefined | null | string | number
Returns QwpSender
- Defined in packages/client-core/src/_qwp/sender.ts:1713

long256Column

long256Column(
    name: string,
    word0: undefined | null | bigint,
    word1: undefined | null | bigint,
    word2: undefined | null | bigint,
    word3: undefined | null | bigint,
): QwpSender
Parameters
- name: string
- word0: undefined | null | bigint
- word1: undefined | null | bigint
- word2: undefined | null | bigint
- word3: undefined | null | bigint
Returns QwpSender
- Defined in packages/client-core/src/_qwp/sender.ts:1661

longArrayColumn

longArrayColumn(name: string, value: undefined | null | unknown[]): QwpSender
Adds a protocol LONG[] column value with between 1 and 32 dimensions.

Current QuestDB servers reject LONG-array ingestion with long arrays are not supported, only double arrays. This method remains available for Java-client and protocol parity.
Parameters
- name: string
- value: undefined | null | unknown[]
Returns QwpSender
- Defined in packages/client-core/src/_qwp/sender.ts:1557

longColumn

longColumn(name: string, value: undefined | null | number | bigint): QwpSender
Adds a QuestDB LONG column value. -9_223_372_036_854_775_808n is QuestDB's LONG NULL sentinel: it is stored as NULL and cannot be stored as an ordinary value.
Parameters
- name: string
- value: undefined | null | number | bigint
Returns QwpSender
- Defined in packages/client-core/src/_qwp/sender.ts:1520

prepareForPoolRelease

prepareForPoolRelease(): Promise<void>
Internal
Flushes completed rows and resets borrower-local staging without closing the physical session. Used by the pooled QWP client when a lease returns.

Returns Promise<void>
- Defined in packages/client-core/src/_qwp/sender.ts:2056

reset

reset(): QwpSender
Returns QwpSender
- Defined in packages/client-core/src/_qwp/sender.ts:1323

shortColumn

shortColumn(name: string, value: undefined | null | number): QwpSender
Parameters
- name: string
- value: undefined | null | number
Returns QwpSender
- Defined in packages/client-core/src/_qwp/sender.ts:1472

stringColumn

stringColumn(name: string, value: undefined | null | string): QwpSender
Parameters
- name: string
- value: undefined | null | string
Returns QwpSender
- Defined in packages/client-core/src/_qwp/sender.ts:1423

symbol

symbol(name: string, value: unknown): QwpSender
Parameters
- name: string
- value: unknown
Returns QwpSender
- Defined in packages/client-core/src/_qwp/sender.ts:1408

table

table(name: string): QwpSender
Parameters
- name: string
Returns QwpSender
- Defined in packages/client-core/src/_qwp/sender.ts:1356

timestampColumn

timestampColumn(
    name: string,
    value: undefined | null | number | bigint,
    unit?: QwpTimestampUnit,
): QwpSender
Parameters
- name: string
- value: undefined | null | number | bigint
- unit: QwpTimestampUnit = "us"
Returns QwpSender
- Defined in packages/client-core/src/_qwp/sender.ts:1573

uuidColumn

uuidColumn(
name: string,
value: undefined | null | string | Uint8Array<ArrayBufferLike>,
): QwpSender
Parameters
- name: string
- value: undefined | null | string | Uint8Array<ArrayBufferLike>
Returns QwpSender
- Defined in packages/client-core/src/_qwp/sender.ts:1649

waitForAcknowledged

waitForAcknowledged(targetSequence: bigint, timeoutMs?: number): Promise<void>
Independently waits until the cumulative ACK watermark covers a frame.
Parameters
- targetSequence: bigint
- OptionaltimeoutMs: number
Returns Promise<void>
- Defined in packages/client-core/src/_qwp/sender.ts:1977

writer

writer<
    Schema extends
        Readonly<Record<string, QwpWriterColumn<unknown, boolean>>>,
>(
    tableName: string,
    schema: Schema,
): QwpTableWriter<Schema>
Compiles an immutable table schema into an atomic object-row writer. The returned writer remains usable after this sender is reset.
Type Parameters
- Schema extends Readonly<Record<string, QwpWriterColumn<unknown, boolean>>>
Parameters
- tableName: string
- schema: Schema
Returns QwpTableWriter<Schema>
- Defined in packages/client-core/src/_qwp/sender.ts:1343

Class QwpSender

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns QwpSender

Accessors

acknowledgedSequence

Returns bigint

metrics

Returns QwpSenderMetrics

publishedSequence

Returns bigint

Methods

arrayColumn

Parameters

Returns QwpSender

at

Parameters

Returns Promise<void>

atNow

Returns Promise<void>

binaryColumn

Parameters

Returns QwpSender

booleanColumn

Parameters

Returns QwpSender

byteColumn

Parameters

Returns QwpSender

cancelRow

Returns QwpSender

charColumn

Parameters

Returns QwpSender

close

Returns Promise<void>

commit

Returns Promise<boolean>

connect

Returns Promise<boolean>

dateColumn

Parameters

Returns QwpSender

decimal128Column

Parameters

Returns QwpSender

decimal256Column

Parameters

Returns QwpSender

decimal64Column

Parameters

Returns QwpSender

decimalColumn

Parameters

Returns QwpSender

decimalColumnText

Parameters

Returns QwpSender

doubleColumn

Parameters

Returns QwpSender

float32Column

Parameters

Returns QwpSender

floatColumn

Parameters

Returns QwpSender

flush

Returns Promise<boolean>

flushAndGetSequence

Returns Promise<bigint>

geohashColumn

Parameters

Returns QwpSender

int32Column