跳转到内容
byted-apaas-utils

数据对象

useUserAuth

用户级鉴权

systemUserService.useUserAuth().find(...);

useSystemAuth

系统级鉴权

systemUserService.useSystemAuth().find(...);

find

查找所有符合条件的记录

  • @param filter 筛选条件
  • @param select 需返回的字段
  • @param sort 排序字段
  • @param desc 是否降序 默认false：升序;true：降序
  • @returns 返回所有符合条件的记录
systemUserService.find(
  {
    _id: 1788099181891668,
  },
  ['_id', '_name'],
  ['_createdAt'],
  true
);

count

计算符合条件的记录数

  • @param filter 筛选条件
  • @returns 返回符合条件的记录数
systemUserService.count({
  valid: false,
});

findStream

流式查找所有符合条件的记录

  • @param param0
  • @param param0.filter 筛选条件
  • @param param0.select 需返回的字段
  • @param param0.sort 排序字段
  • @param param0.desc 是否降序 默认false：升序;true：降序
  • @param param0.handler 处理每次查询到的记录
systemUserService.findStream({
  filter: {
    _id: 1788099181891668,
  },
  select: ['_id', '_name'],
  sort: ['_createdAt'],
  desc: true,
  async handler(records) {
    // ...
  },
});

findOne

查找一个符合条件的记录

  • @param filter 筛选条件
  • @param select 需返回的字段
  • @returns 返回一个符合条件的记录
systemUserService.findOne(
  {
    _id: 1788099181891668,
  },
  ['_id', '_name']
);

findLimit

分页查找符合条件的记录

  • @param param
  • @param param.filter 筛选条件
  • @param param.select 需返回的字段
  • @param param.pageSize 每页条数
  • @param param.page 页码
  • @param param.sort 排序字段
  • @param param.desc 是否降序 默认false：升序;true：降序
  • @returns 返回符合条件的总数和当前页的记录
systemUserService
  .findLimit({
    filter: {
      _id: 1788099181891668,
    },
    select: ['_id', '_name'],
    pageSize: 10,
    page: 1,
    sort: ['_createdAt'],
    desc: true,
  })
  .then(res => {
    res.total; // 总数
    res.list; // 当前页的记录
  });

updateOneById

指定 _id 后，更新对应记录

  • @param recordMap 用于更新的一条记录，需对 _id 赋值
  • @param recordMap 用于更新的一条记录 可选
systemUserService.updateOneById({
  _id: 1660000000,
  name: 'kuke',
});


// or
systemUserService.updateOneById(1660000000, {
  gender: 'kuke',
});

updateOne

更新符合条件的一条记录

  • @param filter 筛选条件
  • @param updateData 用于更新的新数据
  • @returns 0：未找到符合条件的记录
systemUserService.updateOne(
  {
    _id: 1788099181891668,
  },
  {
    name: 'kuke',
  }
);

updateMany

根据条件批量更新记录

  • @param filter 筛选条件
  • @param updateData 用于更新的新数据
systemUserService.updateMany(
  {
    _id: 1788099181891668,
  },
  {
    name: 'kuke',
  }
);

batchUpdate

根据 _id 批量更新记录

  • @param recordMapList 多条用于更新的记录数据组成的数组，记录数据需对 _id 赋值
systemUserService.batchUpdate([
  { _id: 1001, _name: 'John', gender: 'male' },
  { _id: 1002, _name: 'Alis', gender: 'female' },
]);

create

用于创建的一条记录

  • @param recordMapList 多条用于更新的记录数据组成的数组，记录数据需对 _id 赋值
systemUserService.create({ _name: 'John', age: 19, gender: 'male' });

batchCreate

批量创建记录

  • @param recordMapList 多条用于创建的记录数据组成的数组
systemUserService.batchCreate([
  { _name: 'John', age: 19, gender: 'male' },
  { _name: 'Alis', age: 16, gender: 'female' },
]);

deleteOneById

删除记录

  • @param recordID 用于删除的一条记录的 ID 或包含 _id 的记录数据
systemUserService.deleteOneById(1788099181891668);


// or


systemUserService.deleteOneById({ _id: 1788099181891668 });

deleteOne

删除符合条件的一条记录

  • @param filter 筛选条件
  • @returns 0：未找到符合条件的记录
systemUserService.deleteOne({ _name: 'John', age: 19, gender: 'male' });

batchDelete

根据 _id 批量更新记录

  • @param recordMapList 多条用于更新的记录数据组成的数组，记录数据需对 _id 赋值
systemUserService.batchDelete([
  {
    _id: 1788099181891668,
    _name: 'John',
    age: 19,
    gender: 'male',
  },
  { _id: 1788099181891669, _name: 'Alis', age: 16, gender: 'female' },
]);


// or


systemUserService.batchDelete([1788099181891668, 1788099181891669]);

deleteMany

删除符合条件的所有记录

  • @param filter 筛选条件
systemUserService.deleteMany({
  age: 16,
  valid: false,
});