Toshihiko
    正在准备搜索索引...

    接口 SchemaFieldDefinition

    Toshihiko schema 中一个条目接受的通用结构。

    请在以下场景使用 FieldDefinition,适用于可复用声明需要保留字段字面量名称和具体 Field Type 的场景。这个较宽的接口也是以下类型使用的结构约束:SchemaDefinition。

    interface SchemaFieldDefinition {
        allowNull?: boolean;
        autoIncrement?: boolean;
        column?: string;
        defaultValue?: DataValue;
        name: string;
        primaryKey?: boolean;
        type?: FieldTypeLike;
        validators?: FieldValidator<never> | readonly FieldValidator<never>[];
    }

    层级 (查看层级一览)

    索引
    allowNull?: boolean

    应用层值是否可以为 null。

    autoIncrement?: boolean

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

    column?: string

    存储列名;默认值为 name。

    defaultValue?: DataValue

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

    name: string

    Yukari 数据行公开的逻辑属性名。

    primaryKey?: boolean

    字段是否参与主键查询和数据行定位。

    type?: FieldTypeLike

    值转换契约;默认值为 Type.String。

    validators?: FieldValidator<never> | readonly FieldValidator<never>[]

    写入前执行的一个 validator 或 validator 列表。