首页
指南
API
开发
贡献
首页
指南
API
开发
贡献

CollectionRecord

数据表中的一条记录。

类型

interface CollectionRecordOptions<DataType = {}, ParentDataType = {}> {
  isNew?: boolean;
  data?: DataType;
  parentRecord?: CollectionRecord<ParentDataType>;
  /**
   * 当前记录所属的 collection name
   */
  collectionName?: string;
}

class CollectionRecord<DataType = {}, ParentDataType = {}> {
  public isNew?: boolean;
  public data?: DataType;
  public parentRecord?: CollectionRecord<ParentDataType>;
  public collectionName?: string;
  constructor(options: CollectionRecordOptions<DataType, ParentDataType>) {}

  setData(data: DataType) {
    this.data = data;
  }

  setParentRecord(parentRecord: CollectionRecord<ParentDataType>) {
    this.parentRecord = parentRecord;
  }
}

详解

CollectionRecord 基本概念

CollectionRecord 类用于提供数据记录，通常情况下对应着后端数据表中的一条记录。以用户表为例，其一条数据对应的 CollectionRecord 类如下：

const useCollectionRecord = new CollectionRecord({
  data: {
    "id": 1,
    "roleId": 10,
    "appLang": null,
    "createdById": null,
    "email": "[email protected]",
    "nickname": "Admin",
    "phone": null,
    "systemSettings": {},
    "updatedById": null,
    "username": "tachybase",
    "createdAt": "2023-12-04T09:42:52.953Z",
    "updatedAt": "2023-12-04T09:42:52.953Z",
  }
});

CollectionRecord 和 Collection 的关系

CollectionRecord 是指的数据，而 Collection 则是表结构。对于上面的用户表，其对应的 Collection 如下：

const usersCollection = new Collection({
  name: 'users',
  fields: [
    {
      type: 'bigInt',
      name: 'id',
    },
    {
      type: 'string',
      name: 'username',
    },
    {
      type: 'integer',
      name: 'age',
    },
    {
      "name": "email",
      "type": "string",
    },
    // ....
  ],
});

父子关系和关系字段

对于关系字段，例如用户和角色的关系，在用户表中会有一个 roleId 字段，其值为角色表中的 id，当我们通过 users.roleId 字段查询用户的角色时：

GET /api/users/1/roles:get/10

其中 1 为用户的 id，10 为角色的 id，我们可以得到用户的角色数据：

const roleRecord = new CollectionRecord({
  data: {
    "id": 10,
    "name": "member",
    "title": "test role",
    "strategy": {
      "actions": [
        "view",
        "update:own",
        "destroy:own",
        "create"
      ]
    },
    "createdAt": "2023-03-30T07:53:10.924Z",
    "updatedAt": "2023-12-15T02:51:43.577Z",
  }
})

其中 users id 为 1 的记录我们称之为父记录：

roleRecord.setParentRecord(userRecord);

新记录

对于新表单，我们可以通过 isNew 属性来标识：

const record = new CollectionRecord({
  isNew: true,
});

示例

基本使用

import { CollectionRecord } from '@tachybase/client';

const record = new CollectionRecord({
  data: {
    name: 'foo',
  }
});

创建空记录

import { CollectionRecord } from '@tachybase/client';

const record = new CollectionRecord({
  isNew: true,
});

设置 parentRecord

方式1: 通过构造函数设置

const parentRecord = new CollectionRecord({
  data: {
    foo: 'foo',
  }
});

const record = new CollectionRecord({
  data: {
    name: 'bar',
  },
  parentRecord,
});

方式2: 通过 setParentRecord 方法设置

const parentRecord = new CollectionRecord({
  data: {
    foo: 'foo',
  }
});

const record = new CollectionRecord({
  data: {
    name: 'bar',
  }
});

record.setParentRecord(parentRecord);