getOverlayTable
getOverlayTable<
TRegistry,TKey>(registry,tableKey):OverlayTable<TRegistry[TKey]>
Defined in: packages/client/src/local-tables.ts:374
The <t>_overlay optimistic-intent table as a runtime Drizzle object (writable tables only — throws
for a readonly entry, which has no overlay/journal projection). Its entity columns are typed exactly
as OverlayTable describes — real per-column types under a concretely-typed registry, the open
index-signature fallback under a bare SyncTableRegistry — plus the two fixed overlay columns.
Type Parameters
Section titled “Type Parameters”TRegistry
Section titled “TRegistry”TRegistry extends SyncTableRegistry
TKey extends string
Parameters
Section titled “Parameters”registry
Section titled “registry”TRegistry
tableKey
Section titled “tableKey”TKey
Returns
Section titled “Returns”OverlayTable<TRegistry[TKey]>