跳到主要内容

StringProperty

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

变长字符串属性

Remarks​

不带长度上限：各适配器落到 TEXT（SQLite 系无长度概念，PGlite 用无约束 text）， 长度校验属于业务层。需要受控取值集合用 EnumProperty， 需要整段结构化数据用 JSONProperty，别拿字符串手动序列化。

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:211

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

format?​

optional format?: 
  | PlainTextFormat
  | MultilineTextFormat
  | RichTextFormat
  | UrlFormat
  | EmailFormat
  | PhoneFormat
  | CodeFormat
  | ColorFormat;

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

字段语义标注，只影响展示与前端控件选择，不改变运行时值类型

Default​

{ kind: 'plainText' }

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

primary?​

optional primary?: boolean;

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

是否为主键

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:218

是否纳入全局搜索（FTS5 外部内容表） 仅对 StringProperty / EnumProperty / StringArrayProperty 有效

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: "string" | string;

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

unique?​

optional unique?: boolean;

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

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

Default​

false

Inherited from​

IEntityObject.unique