Interface: ColumnMeta
Interface: ColumnMeta
Section titled “Interface: ColumnMeta”Defined in: core/src/schema/columns.ts:26
Properties
Section titled “Properties”
readonlykind:ColumnKind
Defined in: core/src/schema/columns.ts:27
notNull
Section titled “notNull”
readonlynotNull:boolean
Defined in: core/src/schema/columns.ts:28
unique
Section titled “unique”
readonlyunique:boolean
Defined in: core/src/schema/columns.ts:29
hasDefault
Section titled “hasDefault”
readonlyhasDefault:boolean
Defined in: core/src/schema/columns.ts:30
defaultValue?
Section titled “defaultValue?”
readonlyoptionaldefaultValue?:unknown
Defined in: core/src/schema/columns.ts:31
refGetter?
Section titled “refGetter?”
readonlyoptionalrefGetter?: () =>AnyColumn
Defined in: core/src/schema/columns.ts:32
Returns
Section titled “Returns”onDelete?
Section titled “onDelete?”
readonlyoptionalonDelete?:OnDeleteAction
Defined in: core/src/schema/columns.ts:42
For ref() columns: what happens when the referenced parent row is
deleted. "noAction" (default) leaves the child row alone (the parent
fk becomes dangling — plasma allows this because the client’s
IndexedDB can’t enforce fkey without a cascade of its own); pick
"cascade" to also delete every referring child row, or "setNull"
to clear the ref column instead. "restrict" refuses the parent
delete outright when children still exist.
encrypted?
Section titled “encrypted?”
readonlyoptionalencrypted?:boolean
Defined in: core/src/schema/columns.ts:48
When true, this column stores an encrypted Envelope at rest. The
server never sees plaintext; the client’s sync loop encrypts on
push and decrypts on pull using a DEK the app supplies.
readonlyoptionalfile?:FileColumnMeta
Defined in: core/src/schema/columns.ts:54
For file() columns: per-column upload / validation policy. Stored
separately from the Column phantom so runtime validators can read
it without knowing the type argument.
tableName?
Section titled “tableName?”
optionaltableName?:string
Defined in: core/src/schema/columns.ts:55
columnName?
Section titled “columnName?”
optionalcolumnName?:string
Defined in: core/src/schema/columns.ts:56