selectAll method

  1. @override
FutureOr<Iterable<O>> selectAll({
  1. Transaction? transaction,
  2. int? limit,
  3. int? offset,
  4. int? page,
  5. bool? orderByID,
  6. OrderDirection? orderDirection,
  7. EntityResolutionRules? resolutionRules,
})
override

Ordering and pagination:

  • limit: the maximum number of returned entities. Also the page size of page.
  • offset: the return offset, for pagination.
  • page: the 1-based page to return, an ergonomic alternative to offset: it resolves to (page - 1) * limit. Requires a positive limit, and can't be combined with offset. See resolveSelectOffset.
  • orderByID: if true the result is ordered by the table ID column, automatically resolved from the table scheme (TableScheme.idFieldName) or from EntityHandler.idFieldName. Defaults to true when offset is defined, since a paginated select needs a stable order to be correct. Pass false to opt out.
  • orderDirection: the OrderDirection of the ordering, OrderDirection.ascending by default. Ignored while the ordering is not active (see orderByID).

Note that a query over a to-many relationship generates a JOIN without a DISTINCT, so it can return the same entity more than once. Paginating such a query is best-effort.

Implementation

@override
FutureOr<Iterable<O>> selectAll({
  Transaction? transaction,
  int? limit,
  int? offset,
  int? page,
  bool? orderByID,
  OrderDirection? orderDirection,
  EntityResolutionRules? resolutionRules,
  // NOTE: `transaction` is not forwarded, preserving the pre-existing
  // behavior of this method.
}) => select(
  ConditionANY(),
  limit: limit,
  offset: offset,
  page: page,
  orderByID: orderByID,
  orderDirection: orderDirection,
  resolutionRules: resolutionRules,
);