ColumnOptions | /src/index.ts | typeorm@v0.2.23-rc10

interface ColumnOptions

implements ColumnCommonOptions

Re-export

import { type ColumnOptions } from "https://deno.land/x/typeorm@v0.2.23-rc10/src/index.ts";

Describes all column's options.

Properties

optional

type: ColumnType

Column type. Must be one of the value from the ColumnTypes class.

optional

name: string

Column name in the database.

optional

length: string | number

Column type's length. Used only on some column types. For example type = "string" and length = "100" means that ORM will create a column with type varchar(100).

optional

width: number

Column type's display width. Used only on some column types in MySQL. For example, INT(4) specifies an INT with a display width of four digits.

optional

nullable: boolean

Indicates if column's value can be set to NULL.

optional

deprecated

readonly: boolean

Indicates if column value is not updated by "save" operation. It means you'll be able to write this value only when you first time insert the object. Default value is "false".

optional

update: boolean

Indicates if column value is updated by "save" operation. If false, you'll be able to write this value only when you first time insert the object. Default value is "true".

optional

select: boolean

Indicates if column is always selected by QueryBuilder and find operations. Default value is "true".

optional

insert: boolean

Indicates if column is inserted by default. Default value is "true".

optional

default: any

Default database value.

optional

onUpdate: string

ON UPDATE trigger. Works only for MySQL.

optional

primary: boolean

Indicates if this column is a primary key. Same can be achieved when @PrimaryColumn decorator is used.

optional

unique: boolean

Specifies if column's value must be unique or not.

optional

comment: string

Column comment. Not supported by all database types.

optional

precision: number | null

The precision for a decimal (exact numeric) column (applies only for decimal column), which is the maximum number of digits that are stored for the values.

optional

scale: number

The scale for a decimal (exact numeric) column (applies only for decimal column), which represents the number of digits to the right of the decimal point and must not be greater than precision.

optional

zerofill: boolean

Puts ZEROFILL attribute on to numeric column. Works only for MySQL. If you specify ZEROFILL for a numeric column, MySQL automatically adds the UNSIGNED attribute to this column

optional

unsigned: boolean

Puts UNSIGNED attribute on to numeric column. Works only for MySQL.

optional

charset: string

Defines a column character set. Not supported by all database types.

optional

collation: string

Defines a column collation.

optional

enum: (string | number)[] | Object

Array of possible enumerated values.

optional

enumName: string

Exact name of enum

optional

asExpression: string

Generated column expression. Supports only in MySQL.

optional

generatedType: "VIRTUAL" | "STORED"

Generated column type. Supports only in MySQL.

optional

hstoreType: "object" | "string"

Return type of HSTORE column. Returns value as string or as object.

optional

array: boolean

Indicates if this column is an array. Can be simply set to true or array length can be specified. Supported only by postgres.

optional

transformer: ValueTransformer | ValueTransformer[]

Specifies a value transformer that is to be used to (un)marshal this column when reading or writing to the database.

optional

spatialFeatureType: string

Spatial Feature Type (Geometry, Point, Polygon, etc.)

optional

srid: number

SRID (Spatial Reference ID (EPSG code))