Interface ColumnInfo

Column information.

interface ColumnInfo {
    name: string;
    type: string;
    nullable?: boolean;
    defaultValue?: string;
    autoIncrement?: boolean;
    identity?: "always" | "by default";
    generated?: boolean;
    generationExpression?: string;
    generationKind?: "stored" | "virtual";
}

Properties

name type nullable? defaultValue? autoIncrement? identity? generated? generationExpression? generationKind?

Properties

name

name: string

type

type: string

The declared type on SQLite; format_type's name on PostgreSQL (character varying(20), integer[]).

Optionalnullable

nullable?: boolean

OptionaldefaultValue

defaultValue?: string

OptionalautoIncrement

autoIncrement?: boolean

The engine fills it when an insert leaves it out: SQLite's INTEGER PRIMARY KEY, a PostgreSQL identity or serial column.

Optionalidentity

identity?: "always" | "by default"

PostgreSQL: the identity column's kind.

Optionalgenerated

generated?: boolean

A generated column, whose values the engine computes.

OptionalgenerationExpression

generationExpression?: string

PostgreSQL: the generated column's expression.

OptionalgenerationKind

generationKind?: "stored" | "virtual"

PostgreSQL: how the generated column is evaluated.

Settings

Member Visibility

On This Page

Properties