Skip to content
pgxsinkit

TableSpecInput

Defined in: packages/contracts/src/config.ts:646

Properties

Section titled “Properties”

clientProjection?

Section titled “clientProjection?”

optional clientProjection?: ClientProjectionSpec

Defined in: packages/contracts/src/config.ts:650

consistencyGroup?

Section titled “consistencyGroup?”

optional consistencyGroup?: string

Defined in: packages/contracts/src/config.ts:657

Consistency group (ADR-0009 decision 2): tables sharing a group sync on one set of streams and commit atomically — every stream up-to-date, then one transaction (ADR-0056). Absent → the table is its own singleton group.

governance?

Section titled “governance?”

optional governance?: TableGovernanceSpec

Defined in: packages/contracts/src/config.ts:651

mode

Section titled “mode”

mode: TableMode

Defined in: packages/contracts/src/config.ts:647

primaryKey

Section titled “primaryKey”

primaryKey: PrimaryKeySpec

Defined in: packages/contracts/src/config.ts:648

retention?

Section titled “retention?”

optional retention?: Retention

Defined in: packages/contracts/src/config.ts:667

Retention (ADR-0021). Absent → persistent. An ephemeral table’s whole local cluster is emitted as TEMP — no durable trace. See Retention.

shape?

Section titled “shape?”

optional shape?: ShapeSpec

Defined in: packages/contracts/src/config.ts:649

subscription?

Section titled “subscription?”

optional subscription?: SubscriptionTiming

Defined in: packages/contracts/src/config.ts:662

Subscription timing (ADR-0021). Absent → eager. A lazy table is excluded from the boot subscription set and subscribed on first query-reference. See SubscriptionTiming.

writeMode?

Section titled “writeMode?”

optional writeMode?: WriteMode

Defined in: packages/contracts/src/config.ts:673

Write-mode (ADR-0022). Absent → optimistic. A pessimistic consistency group is a standing server-authoritative write-unit whose writes flush-route to the authoritative endpoint. See WriteMode.