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

class TableColumn

Re-export

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

Table's columns in the database represented in this class.

Constructors

new

TableColumn(options?: TableColumnOptions)

Properties

optional

asExpression: string

Generated column expression. Supports only in MySQL.

optional

charset: string

Defines column character set.

optional

collation: string

Defines column collation.

optional

comment: string

Column's comment.

optional

default: any

Column's default value.

optional

enum: string[]

Array of possible enumerated values.

optional

enumName: string

Exact name of enum

optional

generatedType: "VIRTUAL" | "STORED"

Generated column type. Supports only in MySQL.

optional

generationStrategy: "uuid" | "increment" | "rowid"

Specifies generation strategy if this column will use auto increment. rowid option supported only in CockroachDB.

isArray: boolean

Indicates if column stores array.

isGenerated: boolean

Indicates if column is auto-generated sequence.

isNullable: boolean

Indicates if column is NULL, or is NOT NULL in the database.

isPrimary: boolean

Indicates if column is a primary key.

isUnique: boolean

Indicates if column has unique value.

length: string

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).

name: string

Column name.

optional

onUpdate: string

ON UPDATE trigger. Works only for MySQL.

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

spatialFeatureType: string

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

optional

srid: number

SRID (Spatial Reference ID (EPSG code))

type: string

Column type.

unsigned: boolean

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

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.

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 the column

Methods

clone(): TableColumn

Clones this column to a new column with exact same properties as this column has.