Interface IntrospectedColumn

interface IntrospectedColumn {
    allowNull: boolean;
    dbType: string;
    enumName: string | null;
    hasDefault: boolean;
    isArray: boolean;
    name: string;
    valueType: IntrospectedValueType;
}

Properties

allowNull: boolean

dbType: string

The column's database type as Dream's schema records it, e.g. bigint, timestamp without time zone[], or an enum's name.

enumName: string | null

The name of the enum the column's values belong to, or null. An enum outside the connection's default schema is named <schema>.<name>.

hasDefault: boolean

Whether an insert may leave the column out: it has a default, or the database generates its values.

isArray: boolean

name: string

The column's name, e.g. created_at.

The type of one of the column's values in types/db.ts, or 'enum' when the values are those of enumName.