QuerySpec<S extends StoreDef<S>> class final

One declarative read: predicate, order, projection, scope, page size.

where is an AND-list of Cond trees — the list elements AND together, and each element may itself be an arbitrarily deep boolean expression built with &, |, and ~. limit is required by the paging terminals (query, ids, watch, search); pass Limits.unbounded to run without a page size. A limit on a non-paging terminal (count, aggregates) is accepted and passed through to the kernel.

Constructors

QuerySpec({List<Cond<S>> where = const [], List<OrderTerm<S>> orderBy = const [], List<FieldDef<S, Object?>> select = const [], int? limit, bool includeArchived = false, bool includeHidden = false})
One declarative read: predicate, order, projection, scope, page size.
const

Properties

hashCode → int
The hash code for this object.
no setterinherited
includeArchived → bool
Include archived records.
final
includeHidden → bool
Include records hidden by synchronization visibility state.
final
limit → int?
Page size, or Limits.unbounded for no page size.
final
orderBy → List<OrderTerm<S>>
Order terms (FieldDef.asc / FieldDef.desc).
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
select → List<FieldDef<S, Object?>>
Projection: only these fields are carried in the resulting rows. Reading anything else from a projected row throws FieldNotSelectedError.
final
where → List<Cond<S>>
AND-list of predicate trees.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited