Skip to main content

ColumnPlan

@webda/sql-schema

Interface: ColumnPlan

Defined in: packages/sql-schema/src/plan.ts:34

A column of a table

Properties​

enum?​

optional enum?: string[]

Defined in: packages/sql-schema/src/plan.ts:58

Allowed values (CHECK (col IN (...)))

field​

field: string

Defined in: packages/sql-schema/src/plan.ts:43

The model field the column holds: the attribute for field/reference, the link attribute field for junction attribute columns, empty for the system columns

keyPart?​

optional keyPart?: string

Defined in: packages/sql-schema/src/plan.ts:47

For a reference, owner or target column: the primary key field of the referenced model it holds

name​

name: string

Defined in: packages/sql-schema/src/plan.ts:38

Physical column name (after columnNaming)

nullable​

nullable: boolean

Defined in: packages/sql-schema/src/plan.ts:54

Whether the model allows the value to be absent. A store may still create the column nullable (see the multi-version rules of #838: NOT NULL is only applied in the contract phase)

role​

role: ColumnRole

Defined in: packages/sql-schema/src/plan.ts:48

type​

type: ColumnType

Defined in: packages/sql-schema/src/plan.ts:49