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

    Interface QwpIngressReplayStore

    Browser-safe abstraction; Node supplies a persistent filesystem implementation.

    interface QwpIngressReplayStore {
        acknowledgeThrough(frameSequence: bigint): Promise<void>;
        append(record: QwpIngressReplayRecord): Promise<void>;
        appendSymbolDictionary(
            startId: number,
            entries: readonly string[],
        ): Promise<void>;
        close(): Promise<void>;
        discardThrough(frameSequence: bigint): Promise<void>;
        load(): Promise<readonly QwpIngressReplayRecord[]>;
        loadReferences(): Promise<readonly QwpIngressReplayReference[]>;
        loadSymbolDictionary(): Promise<readonly string[]>;
        prepareAppendBatch(
            payloads: readonly Uint8Array<ArrayBufferLike>[],
        ): Promise<void>;
        readPayload(frameSequence: bigint): Promise<Uint8Array<ArrayBufferLike>>;
        replaceSymbolDictionary(entries: readonly string[]): Promise<void>;
    }

    Implemented by

    Index

    Methods

    acknowledgeThrough append appendSymbolDictionary? close discardThrough? load loadReferences? loadSymbolDictionary? prepareAppendBatch? readPayload? replaceSymbolDictionary?

    Methods

    • Persists new dense entries before a delta frame is made replayable.

      Parameters

      • startId: number
      • entries: readonly string[]

      Returns Promise<void>

    • Internal

      Removes a local prefix without representing it as a server ACK. Persistent stores should provide this when recovery can abandon frames.

      "Without representing it as a server ACK" is about the transport's public watermark, which the caller leaves alone. The removal itself must be as durable as acknowledgeThrough's: a discarded prefix that a later load() can still see is a prefix this client reported abandoned and then sent anyway.

      Parameters

      • frameSequence: bigint

      Returns Promise<void>

    • Internal

      Waits until every payload in one logical batch can be appended without an ACK between frames. Implementations must not mutate the journal.

      Parameters

      • payloads: readonly Uint8Array<ArrayBufferLike>[]

      Returns Promise<void>

    • Reads one previously loaded durable payload on demand.

      Parameters

      • frameSequence: bigint

      Returns Promise<Uint8Array<ArrayBufferLike>>

    • Atomically replaces an unusable dictionary after surviving committed frames prove that its complete ID space can be reconstructed.

      Parameters

      • entries: readonly string[]

      Returns Promise<void>

    Settings

    Member Visibility

    On This Page

    Methods