跳到主要内容

EnumProperty

Defined in: packages/rxdb/src/entity/property-types.interface.ts:244

受控取值集合属性

Remarks​

存储形态就是字符串，和 StringProperty 在库里没有区别——enum 收窄的是 类型与元数据，不是数据库层的约束。因此已经落盘的行不会因为后来从 enum 里删掉一个值 而变得读不出来；清理历史值是迁移的事。

enum 声明为 readonly string[]，用 as const 传入才能让实体字段推断成字面量联合而非 string。

Extends​

  • IEntityObject.ISortable

Properties​

columnName?​

optional columnName?: string;

Defined in: packages/rxdb/src/entity/property-types.interface.ts:36

数据库中的列名称 没有填写就是 name 一样

Inherited from​

IEntityObject.columnName

default?​

optional default?: string | (() => string);

Defined in: packages/rxdb/src/entity/property-types.interface.ts:258

默认值

displayName?​

optional displayName?: string;

Defined in: packages/rxdb/src/entity/property-types.interface.ts:42

显示名称

Example​

"用户", "订单项"

Inherited from​

IEntityObject.displayName

encrypted?​

optional encrypted?: boolean;

Defined in: packages/rxdb/src/entity/property-types.interface.ts:83

是否为加密列（透明字段级加密）

由 @aiao/rxdb-adapter-encrypted 在写入前用 AES-GCM-256 加密、 读取后透明解密。加密列不能同时是： 主键 / 外键 / 唯一 / 可排序 / 索引 / 计算属性 / FTS 列。

Default​

false

Inherited from​

IEntityObject.encrypted

enum​

enum: readonly string[];

Defined in: packages/rxdb/src/entity/property-types.interface.ts:254

枚举选项列表 定义该字段允许的所有枚举值

Example​

['active', 'inactive', 'pending']

format?​

optional format?: SingleSelectFormat;

Defined in: packages/rxdb/src/entity/property-types.interface.ts:269

字段语义标注。枚举属性只能声明单选

Default​

{ kind: 'singleSelect' }

name​

name: Uncapitalize<string>;

Defined in: packages/rxdb/src/entity/property-types.interface.ts:30

名字 非大写开头的英文单词，只能包含英文单词和下划线

Inherited from​

IEntityObject.name

nullable?​

optional nullable?: boolean;

Defined in: packages/rxdb/src/entity/property-types.interface.ts:63

是否可以为 NULL

Default​

false

Inherited from​

IEntityObject.nullable

options?​

optional options?: Readonly<Record<string, FieldOptionDisplay>>;

Defined in: packages/rxdb/src/entity/property-types.interface.ts:273

枚举值的展示元数据，键必须是 enum 的子集

readonly?​

optional readonly?: boolean;

Defined in: packages/rxdb/src/entity/property-types.interface.ts:57

是否为只读 如果为 true 那么这个数据只有创建的时候写一次，在更新数据时，这个列的值不会被更新 如果为 false 那么在更新数据时这个列的值会被更新

Default​

false

Inherited from​

IEntityObject.readonly

required?​

optional required?: boolean;

Defined in: packages/rxdb/src/entity/property-types.interface.ts:72

是否为必填 用于前端验证 如果为 true 那么在创建数据时这个列必须提供值 空字符串，空数组都不允许，数字 0 允许

Default​

false

Inherited from​

IEntityObject.required

searchable?​

optional searchable?: boolean;

Defined in: packages/rxdb/src/entity/property-types.interface.ts:264

是否纳入全局搜索（按原始字符串索引）

Default​

false

See​

@aiao/rxdb-plugin-search

sortable?​

optional sortable?: boolean;

Defined in: packages/rxdb/src/entity/property-types.interface.ts:95

是否可排序

Default​

false

Inherited from​

ISortable.sortable

type​

type: "enum" | enum;

Defined in: packages/rxdb/src/entity/property-types.interface.ts:248

属性类型

unique?​

optional unique?: boolean;

Defined in: packages/rxdb/src/entity/property-types.interface.ts:49

是否唯一 如果为 true 那么这个数据得值不允许重复

Default​

false

Inherited from​

IEntityObject.unique