Interface Query<Name, Schema, AdapterInstance>

field

orderBy

conn

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

  Selects the transaction connection used by subsequent execution.

  Parameters

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

    Adapter-specific connection, or null to use the Adapter's default connection behavior.

  Returns this

  This Query.

count

• count(): Promise<number>

  Counts rows matching the current condition.

  Returns Promise<number>

  The count reported by the Adapter.

delete

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

  Deletes rows matching the current condition.

  Returns Promise<AdapterDeleteByQueryResult<AdapterInstance>>

  The Adapter-defined bulk-delete result.

execute

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

  Executes an Adapter-specific raw operation using the connection selected by conn.

  Parameters

  • ...arguments_: AdapterQueryExecuteArguments<AdapterInstance>

    Adapter-defined execute arguments.

  Returns Promise<AdapterExecuteResult<AdapterInstance>>

  The Adapter-defined execution result.

fields

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

  Replaces the selected fields.

  A string is split on commas and trimmed. An array receives schema field-name checking, while strings remain available for Adapter-compatible expressions.

  Parameters

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

    Comma-separated expression or logical field names.

  Returns this

  This Query.

  Throws

  When the runtime value is neither a string nor an array.

find

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

  Finds rows using the current Query state.

  By default, the result is an array of Yukari rows. Passing true returns plain objects serialized through Field Types. single: true requests one result and changes the return type to a row or null; noCache: true tells the Adapter to bypass query caching. The boolean and options object may be passed in either supported order.

  Returns Promise<readonly QueriedYukari<Name, Schema, AdapterInstance>[]>

  Many rows by default, or one row when single: true.

  Example

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

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

  Finds rows using the current Query state.

  By default, the result is an array of Yukari rows. Passing true returns plain objects serialized through Field Types. single: true requests one result and changes the return type to a row or null; noCache: true tells the Adapter to bypass query caching. The boolean and options object may be passed in either supported order.

  Parameters

  • options: QueryFindManyOptions

  Returns Promise<readonly QueriedYukari<Name, Schema, AdapterInstance>[]>

  Many rows by default, or one row when single: true.

  Example

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

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

  Finds rows using the current Query state.

  By default, the result is an array of Yukari rows. Passing true returns plain objects serialized through Field Types. single: true requests one result and changes the return type to a row or null; noCache: true tells the Adapter to bypass query caching. The boolean and options object may be passed in either supported order.

  Parameters

  • options: QueryFindOneOptions

  Returns Promise<QueriedYukari<Name, Schema, AdapterInstance> | null>

  Many rows by default, or one row when single: true.

  Example

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

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

  Finds rows using the current Query state.

  By default, the result is an array of Yukari rows. Passing true returns plain objects serialized through Field Types. single: true requests one result and changes the return type to a row or null; noCache: true tells the Adapter to bypass query caching. The boolean and options object may be passed in either supported order.

  Parameters

  • toJSON: false
  • Optionaloptions: QueryFindManyOptions

  Returns Promise<readonly QueriedYukari<Name, Schema, AdapterInstance>[]>

  Many rows by default, or one row when single: true.

  Example

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

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

  Finds rows using the current Query state.

  By default, the result is an array of Yukari rows. Passing true returns plain objects serialized through Field Types. single: true requests one result and changes the return type to a row or null; noCache: true tells the Adapter to bypass query caching. The boolean and options object may be passed in either supported order.

  Parameters

  • toJSON: false
  • options: QueryFindOneOptions

  Returns Promise<QueriedYukari<Name, Schema, AdapterInstance> | null>

  Many rows by default, or one row when single: true.

  Example

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

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

  Finds rows using the current Query state.

  By default, the result is an array of Yukari rows. Passing true returns plain objects serialized through Field Types. single: true requests one result and changes the return type to a row or null; noCache: true tells the Adapter to bypass query caching. The boolean and options object may be passed in either supported order.

  Parameters

  • toJSON: true
  • Optionaloptions: QueryFindManyOptions

  Returns Promise<readonly Partial<JsonRowFromSchema<Schema>>[]>

  Many rows by default, or one row when single: true.

  Example

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

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

  Finds rows using the current Query state.

  By default, the result is an array of Yukari rows. Passing true returns plain objects serialized through Field Types. single: true requests one result and changes the return type to a row or null; noCache: true tells the Adapter to bypass query caching. The boolean and options object may be passed in either supported order.

  Parameters

  • toJSON: true
  • options: QueryFindOneOptions

  Returns Promise<Partial<JsonRowFromSchema<Schema>> | null>

  Many rows by default, or one row when single: true.

  Example

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

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

  Finds rows using the current Query state.

  By default, the result is an array of Yukari rows. Passing true returns plain objects serialized through Field Types. single: true requests one result and changes the return type to a row or null; noCache: true tells the Adapter to bypass query caching. The boolean and options object may be passed in either supported order.

  Parameters

  • options: QueryFindManyOptions
  • toJSON: true

  Returns Promise<readonly Partial<JsonRowFromSchema<Schema>>[]>

  Many rows by default, or one row when single: true.

  Example

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

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

  Finds rows using the current Query state.

  By default, the result is an array of Yukari rows. Passing true returns plain objects serialized through Field Types. single: true requests one result and changes the return type to a row or null; noCache: true tells the Adapter to bypass query caching. The boolean and options object may be passed in either supported order.

  Parameters

  • options: QueryFindOneOptions
  • toJSON: false

  Returns Promise<QueriedYukari<Name, Schema, AdapterInstance> | null>

  Many rows by default, or one row when single: true.

  Example

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

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

  Finds rows using the current Query state.

  By default, the result is an array of Yukari rows. Passing true returns plain objects serialized through Field Types. single: true requests one result and changes the return type to a row or null; noCache: true tells the Adapter to bypass query caching. The boolean and options object may be passed in either supported order.

  Parameters

  • options: QueryFindOneOptions
  • toJSON: true

  Returns Promise<Partial<JsonRowFromSchema<Schema>> | null>

  Many rows by default, or one row when single: true.

  Example

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

findById

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

  Finds one row by its primary-key value or values.

  A Model with one primary key accepts the value directly. Composite keys require an object. With a configured Cache, this first attempts a Cache read; Cache errors fall back to the Adapter.

  Parameters

  • id: FindByIdInput<Schema>

    Primary-key value or composite-key object.

  Returns Promise<QueriedYukari<Name, Schema, AdapterInstance> | null>

  The matching row, or null.

  Throws

  When a primitive ID is supplied to a Model without exactly one primary key.

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

  Finds one row by its primary-key value or values.

  A Model with one primary key accepts the value directly. Composite keys require an object. With a configured Cache, this first attempts a Cache read; Cache errors fall back to the Adapter.

  Parameters

  • id: FindByIdInput<Schema>

    Primary-key value or composite-key object.

  • toJSON: false

  Returns Promise<QueriedYukari<Name, Schema, AdapterInstance> | null>

  The matching row, or null.

  Throws

  When a primitive ID is supplied to a Model without exactly one primary key.

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

  Finds one row by its primary-key value or values.

  A Model with one primary key accepts the value directly. Composite keys require an object. With a configured Cache, this first attempts a Cache read; Cache errors fall back to the Adapter.

  Parameters

  • id: FindByIdInput<Schema>

    Primary-key value or composite-key object.

  • toJSON: true

  Returns Promise<Partial<JsonRowFromSchema<Schema>> | null>

  The matching row, or null.

  Throws

  When a primitive ID is supplied to a Model without exactly one primary key.

findOne

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

  Finds at most one row using the current Query state.

  Returns Promise<QueriedYukari<Name, Schema, AdapterInstance> | null>

  The first row, or null when no row matches.

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

  Finds at most one row using the current Query state.

  Parameters

  • toJSON: false

  Returns Promise<QueriedYukari<Name, Schema, AdapterInstance> | null>

  The first row, or null when no row matches.

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

  Finds at most one row using the current Query state.

  Parameters

  • toJSON: true

  Returns Promise<Partial<JsonRowFromSchema<Schema>> | null>

  The first row, or null when no row matches.

index

• index(indexName: string): this

  Sets an Adapter-specific index hint.

  Parameters

  • indexName: string

    Index name passed to the Adapter without interpretation.

  Returns this

  This Query.

limit

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

  Sets the result count, or the offset and result count.

  Strings and arrays are retained for v1 compatibility. Values are parsed as base-10 integers, invalid values become 0, and at most two array entries are used.

  Parameters

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

    Count, comma-separated values, or [offset, count].

  Returns this

  This Query.

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

  Sets the result count, or the offset and result count.

  Strings and arrays are retained for v1 compatibility. Values are parsed as base-10 integers, invalid values become 0, and at most two array entries are used.

  Parameters

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

  Returns this

  This Query.

order

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

  Replaces the current sort order.

  Object forms provide schema field-name checking. String forms are parsed as comma-separated Adapter-compatible order expressions.

  Parameters

  • order: QueryOrder<RowFromSchema<Schema>>

    String, field-direction object, or an array of either form.

  Returns this

  This Query.

update

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

  Updates rows matching the current condition.

  Availability, additional arguments, and the resolved value are determined by the selected Adapter.

  Parameters

  • data: Partial<RowFromSchema<Schema>>

    Logical field values to write.

  • ...support: AdapterUpdateByQueryCallArguments<AdapterInstance>

    Adapter-defined additional arguments.

  Returns Promise<AdapterUpdateByQueryResult<AdapterInstance>>

  The Adapter-defined bulk-update result.

where

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

  Replaces the current query condition.

  A later call does not merge with an earlier condition. Use $and or $or inside one condition when multiple branches are required.

  Parameters

  • condition: QueryWhere<RowFromSchema<Schema>>

    Field-aware condition object.

  Returns this

  This Query.

  Throws

  When the runtime value is not an object.