Type parameters
Hierarchy
-
OrderedQuery<TableInfo> ↳SelectableOrderedQuery↳↳SelectableQuery
Methods
filter
▸ filter(predicate): SelectableOrderedQuery<TableInfo>
Filter the query output, returning only the values for which predicate evaluates to true.
Important: Prefer using .withIndex() over .filter() whenever
possible. Filters scan all documents matched so far and discard non-matches,
while indexes efficiently skip non-matching documents. Define an index in
your schema for fields you filter on frequently.
Parameters
Returns
SelectableOrderedQuery<TableInfo>
- A new OrderedQuery with the given filter predicate applied.
Inherited from
OrderedQuery.filterpaginate
▸ paginate(paginationOpts): Promise<PaginationResult<DocumentByInfo<TableInfo>>>
Load a page of n results and obtain a Cursor for loading more.
Note: If this is called from a reactive query function the number of
results may not match paginationOpts.numItems!
paginationOpts.numItems is only an initial value. After the first invocation,
paginate will return all items in the original query range. This ensures
that all pages will remain adjacent and non-overlapping.
Parameters
Returns
Promise<PaginationResult<DocumentByInfo<TableInfo>>>
A PaginationResult containing the page of results and a
cursor to continue paginating.
Inherited from
OrderedQuery.paginatecollect
▸ collect():Promise<DocumentByInfo<TableInfo>[]>
Execute the query and return all of the results as an array.
Warning: This loads every matching document into memory. If the result
set can grow unbounded as your database grows, .collect() will eventually
cause performance problems or hit limits. Only use .collect() when the
result set is tightly bounded (e.g., a known small number of items).
Prefer .first(), .unique(), .take(n), or .paginate() when the
result set may be large or unbounded. For processing many results without
loading all into memory, use the Query as an AsyncIterable with
for await...of.
Returns
Promise<DocumentByInfo<TableInfo>[]>
- An array of all of the query’s results.
Inherited from
OrderedQuery.collecttake
▸ take(n): Promise<DocumentByInfo<TableInfo>[]>
Execute the query and return the first n results.
Parameters
Returns
Promise<DocumentByInfo<TableInfo>[]>
- An array of the first
nresults of the query (or less if the query doesn’t havenresults).
Inherited from
OrderedQuery.takefirst
▸ first():Promise<null | DocumentByInfo<TableInfo>>
Execute the query and return the first result if there is one.
Returns
Promise<null | DocumentByInfo<TableInfo>>
- The first value of the query or
nullif the query returned no results.
Inherited from
OrderedQuery.firstunique
▸ unique():Promise<null | DocumentByInfo<TableInfo>>
Execute the query and return the singular result if there is one.
Use this when you expect exactly zero or one result, for example when
querying by a unique field. If the query matches more than one document,
this will throw an error.
Example
Throws
Will throw an error if the query returns more than one result.
Returns
Promise<null | DocumentByInfo<TableInfo>>
- The single result returned from the query or null if none exists.
Inherited from
OrderedQuery.uniqueselect
▸ select<Fields>(fields): ProjectedOrderedQuery<TableInfo, Fields>
Select top-level properties while retaining _id and _creationTime.
Omitted properties are not evaluated merely to return this projection.
Filters, index order and membership keep their original meaning and access
requirements. A refused property refuses the read; it is never replaced by
null. Selection may be specified once, before consumption.
Type parameters
Parameters
Returns
ProjectedOrderedQuery<TableInfo, Fields>
[asyncIterator]
▸ [asyncIterator]():AsyncIterator<DocumentByInfo<TableInfo>, any, undefined>
Returns
AsyncIterator<DocumentByInfo<TableInfo>, any, undefined>