Skip to content
pgxsinkit

MutationListOptions

Defined in: packages/client/src/mutations-api.ts:37

Optional filters for MutationsApi.list / MutationsApi.subscribe.

Type Parameters

Section titled “Type Parameters”

TRegistry

Section titled “TRegistry”

TRegistry extends SyncTableRegistry

Properties

Section titled “Properties”

entityKey?

Section titled “entityKey?”

optional entityKey?: Record<string, string>

Defined in: packages/client/src/mutations-api.ts:47

Restrict to one entity — matched on the serialized entity_key_json (JSON.stringify(entityKey)), byte-for-byte against the enqueue-time serialization. For a COMPOSITE key, pass the properties in the same order pgxsinkit serialized them (a key taken from a returned MutationSummaryDetail or the write API round-trips correctly; a hand-built object with a different property order silently matches nothing).

limit?

Section titled “limit?”

optional limit?: number

Defined in: packages/client/src/mutations-api.ts:51

Cap the returned rows (applied after the enqueued_at_us ordering).

statuses?

Section titled “statuses?”

optional statuses?: readonly MutationStatus[]

Defined in: packages/client/src/mutations-api.ts:49

Restrict to a set of journal statuses.

table?

Section titled “table?”

optional table?: SyncTableName<TRegistry>

Defined in: packages/client/src/mutations-api.ts:39

Restrict to one registry table key (the table_key column).