select method

FutureOr<Iterable<O>> select(
  1. EntityMatcher<O> matcher, {
  2. Object? parameters,
  3. List? positionalParameters,
  4. Map<String, Object?>? namedParameters,
  5. int? limit,
  6. int? offset,
  7. int? page,
  8. bool? orderByID,
  9. OrderDirection? orderDirection,
  10. Transaction? transaction,
  11. EntityResolutionRules? resolutionRules,
})

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, and, with a SQL database, also when limit is defined (which rows an unordered LIMIT returns is undefined). Pass false to opt out.
  • orderDirection: the OrderDirection of the ordering, OrderDirection.ascending by default. Ignored while the ordering is not active (see orderByID).

A query over a to-many relationship returns (and counts, and paginates) each entity once: with a SQL database, its JOINs are in a subquery of the matching IDs. Note that 2 conditions over the same to-many relationship (roles.type == "a" && roles.type == "b") are, on SQL, over the same joined row, and in memory each over any related entity.

Implementation

FutureOr<Iterable<O>> select(
  EntityMatcher<O> matcher, {
  Object? parameters,
  List? positionalParameters,
  Map<String, Object?>? namedParameters,
  int? limit,
  int? offset,
  int? page,
  bool? orderByID,
  OrderDirection? orderDirection,
  Transaction? transaction,
  EntityResolutionRules? resolutionRules,
}) => entityRepository.select(
  matcher,
  parameters: parameters,
  positionalParameters: positionalParameters,
  namedParameters: namedParameters,
  limit: limit,
  offset: offset,
  page: page,
  orderByID: orderByID,
  orderDirection: orderDirection,
  transaction: transaction,
  resolutionRules: resolutionRules,
);