Class: Field<Type, Optional, Custom>

Field builder class with fluent modifiers.

Type Parameters

Constructors

new Field()

new Field<Type, Optional, Custom>(type): Field<Type, Optional, Custom>

Parameters

Returns

Field<Type, Optional, Custom>

Properties

Methods

default()

default(value): this

Set a default value for this field. Can be a static value or a factory function.

Parameters

Returns

this

indexed()

indexed(): this

Mark this field as indexed (creates sorted index).

Returns

this

indexedWith()

indexedWith(type): this

Mark this field with custom index type(s).

Parameters

Returns

this

optional()

optional(): Field<Type, true, Custom>

Mark this field as optional.

Returns

Field<Type, true, Custom>

primaryKey()

primaryKey(): this

Mark this field as the primary key.

Returns

this

unique()

unique(): this

Mark this field as unique (creates unique constraint).

Returns

this

values()

values<T>(values): this

Set allowed enum values (for enum type).

Type Parameters

Parameters

Returns

this

version()

version(): this

Mark this field as a version field for optimistic locking.

Returns

this