跳到主要内容

DateProperty

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

日期时间属性

Remarks​

default 除了 Date 与生成函数，还接受哨兵字符串 'CURRENT_TIMESTAMP'， 它声明的是建表时的数据库端 DEFAULT（PGlite 落成 now()），而不是一个字符串字面量。 需要跨端可比较的时间戳时用它——客户端时钟各不相同。

注意它并非所有写入路径都由数据库求值：批量 insert 显式给出每一列、绕过了 DB DEFAULT， 适配器会在那里把哨兵就地换成客户端当前时间（见 inserts_sql.ts）。 哨兵不可以出现在读回来的值里——new Date('CURRENT_TIMESTAMP') 是 Invalid Date。

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?: Date | (() => Date) | "CURRENT_TIMESTAMP";

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

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?: DateTimeFormat;

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

字段语义标注。display 只影响展示，不改变持久化精度

Default​

{ kind: 'dateTime' }

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

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

sortable?​

optional sortable?: boolean;

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

是否可排序

Default​

false

Inherited from​

ISortable.sortable

type​

type: "date" | date;

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

unique?​

optional unique?: boolean;

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

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

Default​

false

Inherited from​

IEntityObject.unique