接口 Query<Name, Schema, AdapterInstance>

field

orderBy

conn

• conn(
      connection:
          | Exclude<Parameters<AdapterInstance["insert"]>[1], null>
          | null,
  ): this

  选择后续执行使用的事务连接。

  参数

  • connection: Exclude<Parameters<AdapterInstance["insert"]>[1], null> | null

    Adapter 特有的连接，或 null 时会使用 Adapter 的默认连接行为。

  返回 this

  当前 Query。

count

• count(): Promise<number>

  统计符合当前条件的数据行。

  返回 Promise<number>

  Adapter 报告的数量。

delete

• delete(): Promise<AdapterDeleteByQueryResult<AdapterInstance>>

  删除符合当前条件的数据行。

  返回 Promise<AdapterDeleteByQueryResult<AdapterInstance>>

  由 Adapter 定义的批量删除结果。

execute

• execute(
      ...arguments_: AdapterQueryExecuteArguments<AdapterInstance>,
  ): Promise<AdapterExecuteResult<AdapterInstance>>

  使用以下位置所选的连接执行 Adapter 特有的原始操作： conn。

  参数

  • ...arguments_: AdapterQueryExecuteArguments<AdapterInstance>

    由 Adapter 定义的 execute 参数。

  返回 Promise<AdapterExecuteResult<AdapterInstance>>

  由 Adapter 定义的执行结果。

fields

• fields(
      fields: string | readonly Extract<keyof RowFromSchema<Schema>, string>[],
  ): this

  替换选中的字段。

  字符串会按逗号拆分并去除空白；数组会检查 schema 字段名，而字符串仍可用于 Adapter 兼容表达式。

  参数

  • fields: string | readonly Extract<keyof RowFromSchema<Schema>, string>[]

    逗号分隔的表达式或逻辑字段名。

  返回 this

  当前 Query。

  抛出

  运行时值既不是字符串也不是数组时。

find

• find(): Promise<readonly QueriedYukari<Name, Schema, AdapterInstance>[]>

  使用当前 Query 状态查找数据行。

  默认返回 Yukari 数据行数组。传入 true 会返回通过 Field Type 序列化的普通对象。single: true 会请求一个结果，并把返回类型改为一行数据或 null；noCache: true 会通知 Adapter 绕过查询缓存。布尔值和选项对象可以按任一受支持顺序传入。

  返回 Promise<readonly QueriedYukari<Name, Schema, AdapterInstance>[]>

  默认返回多行；以下选项启用时返回一行：single: true。

  示例

  await User.where({ active: true }).find();
  await User.where({ active: true }).find(true);
  await User.where({ active: true }).find({ single: true });
  复制

• find(
      options: QueryFindManyOptions,
  ): Promise<readonly QueriedYukari<Name, Schema, AdapterInstance>[]>

  使用当前 Query 状态查找数据行。

  默认返回 Yukari 数据行数组。传入 true 会返回通过 Field Type 序列化的普通对象。single: true 会请求一个结果，并把返回类型改为一行数据或 null；noCache: true 会通知 Adapter 绕过查询缓存。布尔值和选项对象可以按任一受支持顺序传入。

  参数

  • options: QueryFindManyOptions

  返回 Promise<readonly QueriedYukari<Name, Schema, AdapterInstance>[]>

  默认返回多行；以下选项启用时返回一行：single: true。

  示例

  await User.where({ active: true }).find();
  await User.where({ active: true }).find(true);
  await User.where({ active: true }).find({ single: true });
  复制

• find(
      options: QueryFindOneOptions,
  ): Promise<QueriedYukari<Name, Schema, AdapterInstance> | null>

  使用当前 Query 状态查找数据行。

  默认返回 Yukari 数据行数组。传入 true 会返回通过 Field Type 序列化的普通对象。single: true 会请求一个结果，并把返回类型改为一行数据或 null；noCache: true 会通知 Adapter 绕过查询缓存。布尔值和选项对象可以按任一受支持顺序传入。

  参数

  • options: QueryFindOneOptions

  返回 Promise<QueriedYukari<Name, Schema, AdapterInstance> | null>

  默认返回多行；以下选项启用时返回一行：single: true。

  示例

  await User.where({ active: true }).find();
  await User.where({ active: true }).find(true);
  await User.where({ active: true }).find({ single: true });
  复制

• find(
      toJSON: false,
      options?: QueryFindManyOptions,
  ): Promise<readonly QueriedYukari<Name, Schema, AdapterInstance>[]>

  使用当前 Query 状态查找数据行。

  默认返回 Yukari 数据行数组。传入 true 会返回通过 Field Type 序列化的普通对象。single: true 会请求一个结果，并把返回类型改为一行数据或 null；noCache: true 会通知 Adapter 绕过查询缓存。布尔值和选项对象可以按任一受支持顺序传入。

  参数

  • toJSON: false
  • 可选options: QueryFindManyOptions

  返回 Promise<readonly QueriedYukari<Name, Schema, AdapterInstance>[]>

  默认返回多行；以下选项启用时返回一行：single: true。

  示例

  await User.where({ active: true }).find();
  await User.where({ active: true }).find(true);
  await User.where({ active: true }).find({ single: true });
  复制

• find(
      toJSON: false,
      options: QueryFindOneOptions,
  ): Promise<QueriedYukari<Name, Schema, AdapterInstance> | null>

  使用当前 Query 状态查找数据行。

  默认返回 Yukari 数据行数组。传入 true 会返回通过 Field Type 序列化的普通对象。single: true 会请求一个结果，并把返回类型改为一行数据或 null；noCache: true 会通知 Adapter 绕过查询缓存。布尔值和选项对象可以按任一受支持顺序传入。

  参数

  • toJSON: false
  • options: QueryFindOneOptions

  返回 Promise<QueriedYukari<Name, Schema, AdapterInstance> | null>

  默认返回多行；以下选项启用时返回一行：single: true。

  示例

  await User.where({ active: true }).find();
  await User.where({ active: true }).find(true);
  await User.where({ active: true }).find({ single: true });
  复制

• find(
      toJSON: true,
      options?: QueryFindManyOptions,
  ): Promise<readonly Partial<JsonRowFromSchema<Schema>>[]>

  使用当前 Query 状态查找数据行。

  默认返回 Yukari 数据行数组。传入 true 会返回通过 Field Type 序列化的普通对象。single: true 会请求一个结果，并把返回类型改为一行数据或 null；noCache: true 会通知 Adapter 绕过查询缓存。布尔值和选项对象可以按任一受支持顺序传入。

  参数

  • toJSON: true
  • 可选options: QueryFindManyOptions

  返回 Promise<readonly Partial<JsonRowFromSchema<Schema>>[]>

  默认返回多行；以下选项启用时返回一行：single: true。

  示例

  await User.where({ active: true }).find();
  await User.where({ active: true }).find(true);
  await User.where({ active: true }).find({ single: true });
  复制

• find(
      toJSON: true,
      options: QueryFindOneOptions,
  ): Promise<Partial<JsonRowFromSchema<Schema>> | null>

  使用当前 Query 状态查找数据行。

  默认返回 Yukari 数据行数组。传入 true 会返回通过 Field Type 序列化的普通对象。single: true 会请求一个结果，并把返回类型改为一行数据或 null；noCache: true 会通知 Adapter 绕过查询缓存。布尔值和选项对象可以按任一受支持顺序传入。

  参数

  • toJSON: true
  • options: QueryFindOneOptions

  返回 Promise<Partial<JsonRowFromSchema<Schema>> | null>

  默认返回多行；以下选项启用时返回一行：single: true。

  示例

  await User.where({ active: true }).find();
  await User.where({ active: true }).find(true);
  await User.where({ active: true }).find({ single: true });
  复制

• find(
      options: QueryFindManyOptions,
      toJSON: true,
  ): Promise<readonly Partial<JsonRowFromSchema<Schema>>[]>

  使用当前 Query 状态查找数据行。

  默认返回 Yukari 数据行数组。传入 true 会返回通过 Field Type 序列化的普通对象。single: true 会请求一个结果，并把返回类型改为一行数据或 null；noCache: true 会通知 Adapter 绕过查询缓存。布尔值和选项对象可以按任一受支持顺序传入。

  参数

  • options: QueryFindManyOptions
  • toJSON: true

  返回 Promise<readonly Partial<JsonRowFromSchema<Schema>>[]>

  默认返回多行；以下选项启用时返回一行：single: true。

  示例

  await User.where({ active: true }).find();
  await User.where({ active: true }).find(true);
  await User.where({ active: true }).find({ single: true });
  复制

• find(
      options: QueryFindOneOptions,
      toJSON: false,
  ): Promise<QueriedYukari<Name, Schema, AdapterInstance> | null>

  使用当前 Query 状态查找数据行。

  默认返回 Yukari 数据行数组。传入 true 会返回通过 Field Type 序列化的普通对象。single: true 会请求一个结果，并把返回类型改为一行数据或 null；noCache: true 会通知 Adapter 绕过查询缓存。布尔值和选项对象可以按任一受支持顺序传入。

  参数

  • options: QueryFindOneOptions
  • toJSON: false

  返回 Promise<QueriedYukari<Name, Schema, AdapterInstance> | null>

  默认返回多行；以下选项启用时返回一行：single: true。

  示例

  await User.where({ active: true }).find();
  await User.where({ active: true }).find(true);
  await User.where({ active: true }).find({ single: true });
  复制

• find(
      options: QueryFindOneOptions,
      toJSON: true,
  ): Promise<Partial<JsonRowFromSchema<Schema>> | null>

  使用当前 Query 状态查找数据行。

  默认返回 Yukari 数据行数组。传入 true 会返回通过 Field Type 序列化的普通对象。single: true 会请求一个结果，并把返回类型改为一行数据或 null；noCache: true 会通知 Adapter 绕过查询缓存。布尔值和选项对象可以按任一受支持顺序传入。

  参数

  • options: QueryFindOneOptions
  • toJSON: true

  返回 Promise<Partial<JsonRowFromSchema<Schema>> | null>

  默认返回多行；以下选项启用时返回一行：single: true。

  示例

  await User.where({ active: true }).find();
  await User.where({ active: true }).find(true);
  await User.where({ active: true }).find({ single: true });
  复制

findById

• findById(
      id: FindByIdInput<Schema>,
  ): Promise<QueriedYukari<Name, Schema, AdapterInstance> | null>

  按主键值查找一行数据。

  只有一个主键的 Model 可以直接接受该值；复合主键需要对象。配置 Cache 后会先尝试读取 Cache；Cache 出错时回退到 Adapter。

  参数

  • id: FindByIdInput<Schema>

    主键值或复合主键对象。

  返回 Promise<QueriedYukari<Name, Schema, AdapterInstance> | null>

  匹配的数据行，或 null。

  抛出

  向没有且仅有一个主键的 Model 传入原始类型 ID 时。

• findById(
      id: FindByIdInput<Schema>,
      toJSON: false,
  ): Promise<QueriedYukari<Name, Schema, AdapterInstance> | null>

  按主键值查找一行数据。

  只有一个主键的 Model 可以直接接受该值；复合主键需要对象。配置 Cache 后会先尝试读取 Cache；Cache 出错时回退到 Adapter。

  参数

  • id: FindByIdInput<Schema>

    主键值或复合主键对象。

  • toJSON: false

  返回 Promise<QueriedYukari<Name, Schema, AdapterInstance> | null>

  匹配的数据行，或 null。

  抛出

  向没有且仅有一个主键的 Model 传入原始类型 ID 时。

• findById(
      id: FindByIdInput<Schema>,
      toJSON: true,
  ): Promise<Partial<JsonRowFromSchema<Schema>> | null>

  按主键值查找一行数据。

  只有一个主键的 Model 可以直接接受该值；复合主键需要对象。配置 Cache 后会先尝试读取 Cache；Cache 出错时回退到 Adapter。

  参数

  • id: FindByIdInput<Schema>

    主键值或复合主键对象。

  • toJSON: true

  返回 Promise<Partial<JsonRowFromSchema<Schema>> | null>

  匹配的数据行，或 null。

  抛出

  向没有且仅有一个主键的 Model 传入原始类型 ID 时。

findOne

• findOne(): Promise<QueriedYukari<Name, Schema, AdapterInstance> | null>

  使用当前 Query 状态查找至多一行数据。

  返回 Promise<QueriedYukari<Name, Schema, AdapterInstance> | null>

  第一行数据，或 null 表示没有匹配的数据行。

• findOne(
      toJSON: false,
  ): Promise<QueriedYukari<Name, Schema, AdapterInstance> | null>

  使用当前 Query 状态查找至多一行数据。

  参数

  • toJSON: false

  返回 Promise<QueriedYukari<Name, Schema, AdapterInstance> | null>

  第一行数据，或 null 表示没有匹配的数据行。

• findOne(toJSON: true): Promise<Partial<JsonRowFromSchema<Schema>> | null>

  使用当前 Query 状态查找至多一行数据。

  参数

  • toJSON: true

  返回 Promise<Partial<JsonRowFromSchema<Schema>> | null>

  第一行数据，或 null 表示没有匹配的数据行。

index

• index(indexName: string): this

  设置 Adapter 特有的索引提示。

  参数

  • indexName: string

    不作解释、直接传给 Adapter 的索引名。

  返回 this

  当前 Query。

limit

• limit(limit: string | number | readonly (string | number)[]): this

  设置结果数量，或设置 offset 与结果数量。

  为兼容 v1 会保留字符串和数组。值按十进制整数解析；无效值会变为 0；数组最多使用前两个元素。

  参数

  • limit: string | number | readonly (string | number)[]

    数量、逗号分隔值或 [offset, count]。

  返回 this

  当前 Query。

• limit(offset: string | number, count: string | number): this

  limit - 数量、逗号分隔值或 [offset, count]。

  参数

  • offset: string | number
  • count: string | number

  返回 this

  当前 Query。

order

• order(order: QueryOrder<RowFromSchema<Schema>>): this

  替换当前排序顺序。

  对象形式会检查 schema 字段名；字符串形式会按逗号拆分并解析为 Adapter 兼容的排序表达式。

  参数

  • order: QueryOrder<RowFromSchema<Schema>>

    字符串、字段方向对象，或任一形式组成的数组。

  返回 this

  当前 Query。

update

• update(
      data: Partial<RowFromSchema<Schema>>,
      ...support: AdapterUpdateByQueryCallArguments<AdapterInstance>,
  ): Promise<AdapterUpdateByQueryResult<AdapterInstance>>

  更新符合当前条件的数据行。

  可用性、额外参数和 Promise 结果由所选 Adapter 决定。

  参数

  • data: Partial<RowFromSchema<Schema>>

    要写入的逻辑字段值。

  • ...support: AdapterUpdateByQueryCallArguments<AdapterInstance>

    由 Adapter 定义的额外参数。

  返回 Promise<AdapterUpdateByQueryResult<AdapterInstance>>

  由 Adapter 定义的批量更新结果。

where

• where(condition: QueryWhere<RowFromSchema<Schema>>): this

  替换当前查询条件。

  后续调用不会与先前条件合并。需要组合条件时请使用 $and 或 $or ，用于一个条件需要多个分支时。

  参数

  • condition: QueryWhere<RowFromSchema<Schema>>

    能够感知 Field 的条件对象。

  返回 this

  当前 Query。

  抛出

  运行时值不是对象时。