Interface SenderTransport

Interface for QuestDB transport implementations.
Defines the contract for different transport protocols (HTTP/HTTPS/TCP/TCPS).

interface SenderTransport {
    close(): Promise<void>;
    connect(): Promise<boolean>;
    getDefaultAutoFlushRows(): number;
    send(data: Buffer): Promise<boolean>;
}

Implemented by

TcpTransport

Index

Methods

close connect getDefaultAutoFlushRows send

Methods

close

close(): Promise<void>
Closes the connection to the database server. Should not be called on HTTP transports.

Returns Promise<void>
Promise that resolves when the connection is closed
- Defined in packages/nodejs-client/src/transport/index.ts:33

connect

connect(): Promise<boolean>
Establishes a connection to the database server. Should not be called on HTTP transports.

Returns Promise<boolean>
Promise resolving to true if connection is successful
- Defined in packages/nodejs-client/src/transport/index.ts:19

getDefaultAutoFlushRows

getDefaultAutoFlushRows(): number
Gets the default number of rows that trigger auto-flush for this transport.

Returns number
Default auto-flush row count
- Defined in packages/nodejs-client/src/transport/index.ts:39

send

send(data: Buffer): Promise<boolean>
Sends the data to the database server.
Parameters
- data: Buffer
  Buffer containing the data to send
Returns Promise<boolean>
Promise resolving to true if data was sent successfully
- Defined in packages/nodejs-client/src/transport/index.ts:26