matches method

List<O> matches(
  1. EntityMatcher matcher, {
  2. Object? parameters,
  3. List? positionalParameters,
  4. Map<String, Object?>? namedParameters,
  5. int? limit,
  6. int? offset,
  7. bool? orderByID,
  8. OrderDirection? orderDirection,
})

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).

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

List<O> matches(
  EntityMatcher<dynamic> matcher, {
  Object? parameters,
  List? positionalParameters,
  Map<String, Object?>? namedParameters,
  int? limit,
  int? offset,
  bool? orderByID,
  OrderDirection? orderDirection,
}) {
  var itr = iterable().where((o) {
    return matcher.matchesEntity(
      o,
      entityHandler: entityHandler,
      parameters: parameters,
      positionalParameters: positionalParameters,
      namedParameters: namedParameters,
    );
  });

  return _applyOrderAndPagination(
    itr,
    limit: limit,
    offset: offset,
    orderByID: orderByID,
    orderDirection: orderDirection,
  );
}