Interface ColumnarBatchCacheHandle`Experimental`

An identity-keyed batch cache plus the administration a host needs to audit it.

interface ColumnarBatchCacheHandle {
    clear(): Promise<void>;
    delete(identity: ColumnarBatchIdentityV1): Promise<void>;
    dispose(): void;
    key(identity: ColumnarBatchIdentityV1): Promise<`sha256:${string}`>;
    read(identity: ColumnarBatchIdentityV1, options?: ColumnarBatchCacheReadOptions): Promise<ColumnarBatchCacheReadV1>;
    records(): Promise<readonly ColumnarBatchCacheRecordV1[]>;
    write(batch: ColumnarBatchV1, options?: ColumnarBatchCacheWriteOptions): Promise<ColumnarBatchCacheWriteV1>;
}

Index

Methods

clear delete dispose key read records write

Methods

clear

clear(): Promise<void>
Experimental
Drop every entry, for sign-out and scope teardown.

Returns Promise<void>
- Defined in work/honua-sdk-js/honua-sdk-js/src/columnar/batch-cache.ts:299

delete

delete(identity): Promise<void>
Experimental
Drop the entry this identity addresses, if any.
Parameters
- identity: ColumnarBatchIdentityV1
Returns Promise<void>
- Defined in work/honua-sdk-js/honua-sdk-js/src/columnar/batch-cache.ts:295

dispose

dispose(): void
Experimental
Release retained buffers and connections; later calls settle as disposed.

Returns void
- Defined in work/honua-sdk-js/honua-sdk-js/src/columnar/batch-cache.ts:301

key

key(identity): Promise<`sha256:${string}`>
Experimental
Derive the key this identity addresses, without touching storage.
Parameters
- identity: ColumnarBatchIdentityV1
Returns Promise<`sha256:${string}`>
- Defined in work/honua-sdk-js/honua-sdk-js/src/columnar/batch-cache.ts:284

read

read(identity, options?): Promise<ColumnarBatchCacheReadV1>
Experimental
Look one batch up by identity.

Only the keyed components matter: the passed freshness.observedAt and freshness.staleAfter are never compared, because expiry is evaluated against what the producer recorded, not against what the reader guessed.
Parameters
- identity: ColumnarBatchIdentityV1
- Optionaloptions: ColumnarBatchCacheReadOptions
Returns Promise<ColumnarBatchCacheReadV1>
- Defined in work/honua-sdk-js/honua-sdk-js/src/columnar/batch-cache.ts:292

records

records(): Promise<readonly ColumnarBatchCacheRecordV1[]>
Experimental
Every valid persisted record, for enumeration in tests and diagnostics.

Returns Promise<readonly ColumnarBatchCacheRecordV1[]>
- Defined in work/honua-sdk-js/honua-sdk-js/src/columnar/batch-cache.ts:297

write

write(batch, options?): Promise<ColumnarBatchCacheWriteV1>
Experimental
Parameters
- batch: ColumnarBatchV1
- Optionaloptions: ColumnarBatchCacheWriteOptions
Returns Promise<ColumnarBatchCacheWriteV1>
- Defined in work/honua-sdk-js/honua-sdk-js/src/columnar/batch-cache.ts:293