Options
All
  • Public
  • Public/Protected
  • All
Menu

Class TableColumn

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

Hierarchy

  • TableColumn

Index

Constructors

constructor

Properties

Optional asExpression

asExpression: string

Generated column expression. Supports only in MySQL.

Optional charset

charset: string

Defines column character set.

Optional collation

collation: string

Defines column collation.

Optional comment

comment: string

Column's comment.

Optional default

default: any

Column's default value.

Optional enum

enum: string[]

Array of possible enumerated values.

Optional generatedType

generatedType: "VIRTUAL" | "STORED"

Generated column type. Supports only in MySQL.

Optional generationStrategy

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

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

isArray

isArray: boolean = false

Indicates if column stores array.

isGenerated

isGenerated: boolean = false

Indicates if column is auto-generated sequence.

isNullable

isNullable: boolean = false

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

isPrimary

isPrimary: boolean = false

Indicates if column is a primary key.

isUnique

isUnique: boolean = false

Indicates if column has unique value.

length

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

name: string

Column name.

Optional onUpdate

onUpdate: string

ON UPDATE trigger. Works only for MySQL.

Optional precision

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

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

spatialFeatureType: string

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

Optional srid

srid: number

SRID (Spatial Reference ID (EPSG code))

type

type: string

Column type.

unsigned

unsigned: boolean = false

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

Optional width

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

zerofill: boolean = false

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

Generated using TypeDoc