Generated column expression. Supports only in MySQL.
Defines column character set.
Column type in the case if this column is in the closure table. Column can be ancestor or descendant in the closure tables.
Defines column collation.
Column comment. This feature is not supported by all databases.
Complete column name in the database including its embedded prefixes.
Database name in the database without embedded prefixes applied.
Gets full path to this column database name (including column database name). Full path is relevant when column is used in embeds (one or multiple nested). For example it will return "counters.subcounters.likes". If property is not in embeds then it returns just database name of the column.
Default database value.
Embedded metadata where this column metadata is. If this column is not in embed then this property value is undefined.
Entity metadata where this column metadata is.
For example for @Column() name: string in Post, entityMetadata will be metadata of Post entity.
Array of possible enumerated values.
Generated column type. Supports only in MySQL.
Specifies generation strategy if this column will use auto increment.
Database name set by entity metadata builder, not yet passed naming strategy process and without embedded prefixes.
Return type of HSTORE column. Returns value as string or as object.
Indicates if this column is an array.
Indicates if this column contains an entity creation date.
Indicates if column is discriminator. Discriminator columns are not mapped to the entity.
Indicates if this column is generated (auto increment or generated other way).
Indicates if this column is materialized path's path column. Used only in tree entities with materialized path type.
Indicates if this column is nested set's left column. Used only in tree entities with nested-set type.
Indicates if this column is nested set's right column. Used only in tree entities with nested-set type.
Indicates if column can contain nulls or not.
Indicates if this column contains an object id.
Indicates if this column is a primary key.
Indicates if column is protected from updates or not.
Indicates if column is selected by query builder or not.
Indicates if column is tree-level column. Tree-level columns are used in closure entities.
Indicates if this column contains an entity update date.
Indicates if this column contains an entity version.
Indicates if column is virtual. Virtual columns are not mapped to the entity.
Type's length in the database.
ON UPDATE trigger. Works only for MySQL.
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.
Same as property path, but dots are replaced with '_'. Used in query builder statements.
Class's property name on which this column is applied.
Gets full path to this column property (including column property name). Full path is relevant when column is used in embeds (one or multiple nested). For example it will return "counters.subcounters.likes". If property is not in embeds then it returns just property name of the column.
If this column is foreign key then it references some other column, and this property will contain reference to this column.
If column is a foreign key of some relation then this relation's metadata will be there. If this column does not have a foreign key then this property value is undefined.
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.
Target class where column decorator is used. This may not be always equal to entity metadata (for example embeds or inheritance cases).
Specifies a value transformer that is to be used to (un)marshal this column when reading or writing to the database.
The database type of the column.
Puts UNSIGNED attribute on to numeric column. Works only for MySQL.
Type's display width in the database.
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
Creates entity id map from the given entity ids array.
Extracts column value from the given entity. If column is in embedded (or recursive embedded) it extracts its value from there.
Extracts column value and returns its column name with this value in a literal object. If column is in embedded (or recursive embedded) it returns complex literal object.
Examples what this method can return depend if this column is in embeds. { id: 1 } or { title: "hello" }, { counters: { code: 1 } }, { data: { information: { counters: { code: 1 } } } }
Sets given entity's column value. Using of this method helps to set entity relation's value of the lazy and non-lazy relations.
Generated using TypeDoc
This metadata contains all information about entity's column.