Column
@quik/database / Column
Variable: Column
Column:
object
Defined in: database/src/decorators/Column.ts:583
Column decorators and utilities for database models
Type Declaration
Boolean
Boolean: (
maybeOptions?) => (target,context) =>void=BooleanColumn
Boolean column decorator that creates a boolean column.
Parameters
maybeOptions?
QBooleanColumnOptions
Boolean column configuration options
Returns
(target, context) => void
Column
Column: (
options) => (target,context) =>void=ColumnDefinition
Base column decorator factory that configures database column properties.
Parameters
options
QColumnOptions
Column configuration options
Returns
(target, context) => void
Throws
Error If the column options are invalid
CreatedAt
CreatedAt: (
maybeOptions?) => (target,context) =>void=CreatedAtColumn
CreatedAt column decorator that creates a timestamp column with current timestamp as default.
Parameters
maybeOptions?
QDateTimeColumnOptions
DateTime column configuration options
Returns
(target, context) => void
Date
Date: (
maybeOptions?) => (target,context) =>void=DateColumn
Date column decorator that creates a date column.
Parameters
maybeOptions?
QDateColumnOptions
Date column configuration options
Returns
(target, context) => void
DateTime
DateTime: (
maybeOptions?) => (target,context) =>void=DateTimeColumn
DateTime column decorator that creates a datetime column.
Parameters
maybeOptions?
QDateTimeColumnOptions
DateTime column configuration options
Returns
(target, context) => void
Decimal
Decimal: (
maybeOptions?) => (target,context) =>void=DecimalColumn
Decimal column decorator that creates a decimal column with precision and scale.
Parameters
maybeOptions?
QDecimalColumnOptions
Decimal column configuration options
Returns
(target, context) => void
DeletedAt
DeletedAt: (
maybeOptions?) => (target,context) =>void=DeletedAtColumn
DeletedAt column decorator that creates a nullable timestamp column for soft delete functionality.
Parameters
maybeOptions?
QDateTimeColumnOptions
DateTime column configuration options
Returns
(target, context) => void
Enum
Enum: <
T>(maybeOptions) => (target,context) =>void=EnumColumn
Enum column decorator that creates an enum column with specific values.
Type Parameters
T
T
Parameters
maybeOptions
QEnumColumnOptions<T>
Enum column configuration options including the enum values
Returns
(target, context) => void
Float
Float: (
maybeOptions?) => (target,context) =>void=FloatColumn
Float column decorator that creates a floating-point number column.
Parameters
maybeOptions?
QFloatColumnOptions
Float column configuration options
Returns
(target, context) => void
Integer
Integer: (
maybeOptions?) => (target,context) =>void=IntegerColumn
Integer column decorator that creates an integer column.
Parameters
maybeOptions?
QIntegerColumnOptions
Integer column configuration options
Returns
(target, context) => void
Json
Json: (
maybeOptions?) => (target,context) =>void=JsonColumn
JSON column decorator that creates a json column.
Parameters
maybeOptions?
QJsonColumnOptions
JSON column configuration options
Returns
(target, context) => void
Jsonb
Jsonb: (
maybeOptions?) => (target,context) =>void=JsonbColumn
JSONB column decorator that creates a jsonb column.
Parameters
maybeOptions?
QJsonColumnOptions
JSONB column configuration options
Returns
(target, context) => void
Password
Password: (
lengthOrOptions?,maybeOptions?) => (target,context) =>void=PasswordColumn
Password column decorator that creates a column suitable for storing hashed passwords.
Parameters
lengthOrOptions?
number | QStringColumnOptions
Column length or configuration options
maybeOptions?
QStringColumnOptions
Additional options when the first parameter is a length
Returns
(target, context) => void
PrimaryGenerated
PrimaryGenerated: (
strategyOrOptions?,maybeOptions?) => (target,context) =>void=PrimaryGeneratedColumn
Primary generated column decorator that creates an auto-generated primary key column.
Parameters
strategyOrOptions?
"uuid" | "increment" | QPrimaryGeneratedColumnNumericOptions
Generation strategy ('increment' or 'uuid') or column options
maybeOptions?
QPrimaryGeneratedColumnNumericOptions & object
Additional options when the first parameter is a strategy
Returns
(target, context) => void
PrimaryKey
PrimaryKey: (
options) => (target,context) =>void=PrimaryKeyColumn
Primary key column decorator that creates a primary key column.
Parameters
options
QColumnOptions
Column configuration options
Returns
(target, context) => void
String
String: (
lengthOrOptions?,maybeOptions?) => (target,context) =>void=StringColumn
String column decorator that creates a varchar column.
Parameters
lengthOrOptions?
number | QStringColumnOptions
Column length or configuration options
maybeOptions?
QStringColumnOptions
Additional options when the first parameter is a length
Returns
(target, context) => void
Text
Text: (
lengthOrOptions?,maybeOptions?) => (target,context) =>void=TextColumn
Text column decorator that creates a text column for storing longer strings.
Parameters
lengthOrOptions?
"short" | "long" | "medium" | QTextColumnOptions
Text size or configuration options
maybeOptions?
QTextColumnOptions
Additional options when the first parameter is a size
Returns
(target, context) => void
Timestamp
Timestamp: (
maybeOptions?) => (target,context) =>void=TimestampColumn
Timestamp column decorator that creates a timestamp column.
Parameters
maybeOptions?
QTimestampColumnOptions
Timestamp column configuration options
Returns
(target, context) => void
UpdatedAt
UpdatedAt: (
maybeOptions?) => (target,context) =>void=UpdatedAtColumn
UpdatedAt column decorator that creates a timestamp column with auto-update on record modification.
Parameters
maybeOptions?
QDateTimeColumnOptions
DateTime column configuration options
Returns
(target, context) => void
UUID
UUID: (
maybeOptions?) => (target,context) =>void=UUIDColumn
UUID column decorator that creates a uuid column.
Parameters
maybeOptions?
QStringColumnOptions
UUID Column configuration options
Returns
(target, context) => void