CRUD(Select)

下面以模块test-vona为例，讲解 CRUD 中 Select 的用法

基本查询

模块test-vona中定义了 ModelPost，可以这样查询Post的数据

1. select

class ServicePost {
  async select() {
    return await this.scope.model.post.select();
  }
}

2. count

class ServicePost {
  async count() {
    return await this.scope.model.post.count();
  }
}

3. get

class ServicePost {
  async get(id: TableIdentity) {
    return await this.scope.model.post.get({ id });
  }
}

4. mget

class ServicePost {
  async mget(ids: TableIdentity[]) {
    return await this.scope.model.post.mget(ids);
  }
}

Select类型定义

async select<
  T extends IModelSelectParams<TRecord>,
  ModelJoins extends TypeModelsClassLikeGeneral | undefined,
>(
  params?: T,
  options?: IModelMethodOptions,
  _modelJoins?: ModelJoins,
): Promise<TRecord[]>;

• 举例：一个相对复杂的 select 查询：

class ServicePost {
  async select() {
    return await this.scope.model.post.select({
      columns: ['id', 'title', 'userId'],
      where: {
        'id': { _gt_: 1 },
        'testVonaUser.id': 1,
      },
      joins: [['innerJoin', 'testVonaUser', ['userId', 'testVonaUser.id']]],
      offset: 0,
      limit: 20,
      orders: [['createdAt', 'desc']],
    }, {
      disableDeleted: false,
    }, 'test-vona:user');
  }
}

Select参数：Options

名称	类型	默认值	描述
disableDeleted	boolean	false	是否禁止软删除
disableCreateTime	boolean	false	是否禁止自动设置创建时间
disableUpdateTime	boolean	false	是否禁止自动设置更新时间
disableCacheQuery	boolean	false	是否禁用Cache Query
disableCacheEntity	boolean	false	是否禁用Cache Entity
iid	number	undefined	可以显式设置实例Id
deleted	boolean	undefined	可以显式设置deleted值

Select参数：Params

名称	描述
distinct	是否启用distinct
columns	需要查询的字段列表
where	条件语句
joins	关联表
orders	排序
limit	可用于分页查询
offset	可用于分页查询
include	静态关系
with	动态关系

orders

是数组类型，可以指定多个 orders：

async select() {
  return await this.scope.model.post.select({
    orders: [
      ['createdAt', 'desc'],
      ['title', 'asc'],
    ],
  });
}

joins

可以通过joins关联多个数据表

async select() {
  return await this.scope.model.post.select({
    joins: [
      ['innerJoin', 'testVonaUser', ['userId', 'testVonaUser.id']],
      ['leftJoin', 'testVonaPostContent', ['id', 'testVonaPostContent.postId']],
    ],
  });
}

joins支持类型提示，如图所示：

那么，图中所示的数据表清单来自于哪里呢？

前面提到，可以在Model中定义多个Entity之间的关系，所以，系统自动从 Model 定义的关系中提取 Entity 对应的数据表。ModelPost的关系定义如下：

@Model({
  relations: {
    postContent: $relation.hasOne('test-vona:postContent', 'postId', { columns: ['id', 'content'] }),
    user: $relation.belongsTo(ModelPost, () => ModelUser, 'userId', { autoload: true, columns: ['id', 'name'] }),
  },
})
class ModelPost {}

在一个大型的业务系统中，Model 可能并不会定义所有的关系。那么，也可以通过参数_modelJoins指定需要关联的 Models，系统从这些 Models 中提取对应的数据表

比如，模块test-vona中定义了 modelorder。那么，我们可以这样使用joins:

也可以指定多个 Models：

where