defineSyncTable
defineSyncTable<
TName,TColumns,TOmittedColumns,TGovernance,TMode>(input):object&SyncTableInputGovernanceMarker<TGovernance>
Defined in: packages/contracts/src/registry.ts:604
Defines a sync table entry. Provide tableName and makeColumns — the Drizzle
pgTable (and, for readwrite mode, the _read_model view) are created here.
Access the built objects via .table and .view on the returned entry.
Type Parameters
Section titled “Type Parameters”TName extends string
TColumns
Section titled “TColumns”TColumns extends Record<string, ColumnBuilderBase<ColumnBuilderBaseConfig<ColumnType>>>
TOmittedColumns
Section titled “TOmittedColumns”TOmittedColumns extends readonly ColumnKeys<TColumns>[] = []
TGovernance
Section titled “TGovernance”TGovernance extends SyncTableInputGovernance<TColumns> | undefined = undefined
TMode extends TableMode = "readonly"
Parameters
Section titled “Parameters”Omit<SyncTableInput<TName, TColumns, TOmittedColumns>, "mode" | "governance"> & object