Type parameters
Methods
explain
▸ explain():Promise<RelationReadExplanation>
Inspect schema admission, pagination and maintenance without reading source rows.
Returns
Promise<RelationReadExplanation>
paginate
▸ paginate(options): Promise<PaginationResult<Row>>
Parameters
Returns
Promise<PaginationResult<Row>>
withIndex
▸ withIndex<Index>(index, range?): RelationRead<Row, Indexes, Paginated, true>
Read through a declared index; fields follow its order and value types.
Type parameters
Parameters
Returns
RelationRead<Row, Indexes, Paginated, true>
order
▸ order(direction): RelationRead<Row, Indexes, Paginated, Ordered>
Reverse an existing order. An unordered relation requires orderBy in its definition.
Parameters
Returns
RelationRead<Row, Indexes, Paginated, Ordered>
collect
▸ collect():Promise<Row[]>
Returns
Promise<Row[]>
take
▸ take(count): Promise<Row[]>
Parameters
Returns
Promise<Row[]>
first
▸ first():Promise<Row | null>
Returns
Promise<Row | null>
unique
▸ unique():Promise<Row | null>
Returns
Promise<Row | null>