接口 FieldDefinition<Name, FieldTypeDefinition>

保留字段名和 Field Type 的 schema 条目。

interface FieldDefinition<
    Name extends string = string,
    FieldTypeDefinition extends FieldTypeLike = FieldTypeLike,
> {
    allowNull?: boolean;
    autoIncrement?: boolean;
    column?: string;
    defaultValue?: FieldTypeValue<FieldTypeDefinition>;
    name: Name;
    primaryKey?: boolean;
    type?: FieldTypeDefinition;
    validators?:
        | FieldValidator<FieldTypeValue<FieldTypeDefinition>>
        | readonly FieldValidator<FieldTypeValue<FieldTypeDefinition>>[];
}

类型参数

Name extends string = string
FieldTypeDefinition extends FieldTypeLike = FieldTypeLike

层级 (查看层级一览)

SchemaFieldDefinition
- FieldDefinition

索引

属性

allowNull? autoIncrement? column? defaultValue? name primaryKey? type? validators?

属性

`可选` `只读`allowNull

allowNull?: boolean

推断后的应用层值是否包含 null。

`可选` `只读`autoIncrement

autoIncrement?: boolean

存储后端是否会在 insert 时生成此字段。

`可选` `只读`column

column?: string

存储列名；默认值为 name。

`可选` `只读`defaultValue

defaultValue?: FieldTypeValue<FieldTypeDefinition>

新建数据行省略此字段时使用的应用层值。

`只读`name

name: Name

为 schema 推断保留的逻辑属性字面量名称。

`可选` `只读`primaryKey

primaryKey?: boolean

字段是否参与主键查询。

`可选` `只读`type

type?: FieldTypeDefinition

用于值推断的具体 Field Type。

`可选` `只读`validators

validators?:
| FieldValidator<FieldTypeValue<FieldTypeDefinition>>
| readonly FieldValidator<FieldTypeValue<FieldTypeDefinition>>[]

接收推断后应用层值的 validator。