@qualithm/arrow-flight-sql-js - v0.4.3
    Preparing search index...

    Class Subscription

    Real-time subscription to query results via DoExchange.

    Yields RecordBatches as they arrive from the server. Handles heartbeats automatically and can reconnect on transient connection failures.

    const subscription = client.subscribe("SELECT * FROM events")

    for await (const batch of subscription) {
      console.log(`Received ${batch.numRows} rows`)
    }

    await subscription.unsubscribe()

    Implements

    • AsyncIterable<RecordBatch>
    Index

    Constructors

    constructor

    Accessors

    batchesReceived connected id lastHeartbeatTime reconnectCount timeSinceLastHeartbeat

    Methods

    [asyncIterator] unsubscribe

    Constructors

    Accessors

    • get batchesReceived(): number

      Number of batches received

      Returns number

    • get connected(): boolean

      Whether the subscription is currently connected

      Returns boolean

    • get id(): string

      Unique ID for this subscription (assigned by server after connect)

      Returns string

    • get lastHeartbeatTime(): number

      Timestamp of the last heartbeat received from the server

      Returns number

    • get reconnectCount(): number

      Number of reconnection attempts

      Returns number

    • get timeSinceLastHeartbeat(): number

      Time in milliseconds since the last heartbeat

      Returns number

    Methods

    • Start the subscription and iterate over incoming batches

      Returns AsyncGenerator<RecordBatch<any>, void, unknown>

    • Unsubscribe and close the connection

      Returns Promise<void>

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods