跳到主要内容

JSONProperty

Defined in: packages/rxdb/src/entity/metadata-options.interface.ts:686

json 存储任意 JSON 结构的数据，适用于灵活的数据模型或嵌套对象

Extends​

  • IEntityObject

Properties​

columnName?​

optional columnName?: string;

Defined in: packages/rxdb/src/entity/metadata-options.interface.ts:32

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

Inherited from​

IEntityObject.columnName

default?​

optional default?: Record<string, any> | (() => Record<string, any>);

Defined in: packages/rxdb/src/entity/metadata-options.interface.ts:688

displayName?​

optional displayName?: string;

Defined in: packages/rxdb/src/entity/metadata-options.interface.ts:38

显示名称

Example​

"用户", "订单项"

Inherited from​

IEntityObject.displayName

encrypted?​

optional encrypted?: boolean;

Defined in: packages/rxdb/src/entity/metadata-options.interface.ts:79

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

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

Default​

false

Inherited from​

IEntityObject.encrypted

name​

name: Uncapitalize<string>;

Defined in: packages/rxdb/src/entity/metadata-options.interface.ts:26

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

Inherited from​

IEntityObject.name

nullable?​

optional nullable?: boolean;

Defined in: packages/rxdb/src/entity/metadata-options.interface.ts:59

是否可以为 NULL

Default​

false

Inherited from​

IEntityObject.nullable

readonly?​

optional readonly?: boolean;

Defined in: packages/rxdb/src/entity/metadata-options.interface.ts:53

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

Default​

false

Inherited from​

IEntityObject.readonly

required?​

optional required?: boolean;

Defined in: packages/rxdb/src/entity/metadata-options.interface.ts:68

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

Default​

false

Inherited from​

IEntityObject.required

type​

type: 
  | "json"
  | json;

Defined in: packages/rxdb/src/entity/metadata-options.interface.ts:687

unique?​

optional unique?: boolean;

Defined in: packages/rxdb/src/entity/metadata-options.interface.ts:45

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

Default​

false

Inherited from​

IEntityObject.unique