ApiCoreFunctions
Function: runQuery()
function runQuery<T, C, I>(source, given): Promise<QueryResult<T, Readonly<Record<string,
| number
| readonly QueryRecord<unknown, Readonly<Record<string, number | readonly QueryRecord<unknown, Readonly<Record<string, number | readonly QueryRecord<unknown, Readonly<Record<string, number | readonly QueryRecord<unknown, Readonly<Record<string, number | readonly QueryRecord<unknown, Readonly<Record<string, number | readonly QueryRecord<unknown, Re..., Readonly<Record<string, unknown>>>[]>>, Readonly<Record<string, unknown>>>>;Defined in: packages/core/src/query/engine.ts:51
Runs a query against a space.
Type Parameters
| Type Parameter | Default type |
|---|---|
T | unknown |
C extends CollectionRef | CollectionRef |
I extends | Readonly<Record<string, Include>> | undefined | | Readonly<Record<string, Include>> | undefined |
Parameters
| Parameter | Type |
|---|---|
source | QuerySource |
given | Query<C, I> |
Returns
Promise<QueryResult<T, Readonly<Record<string,
| number
| readonly QueryRecord<unknown, Readonly<Record<string, number | readonly QueryRecord<unknown, Readonly<Record<string, number | readonly QueryRecord<unknown, Readonly<Record<string, number | readonly QueryRecord<unknown, Readonly<Record<string, number | readonly QueryRecord<unknown, Readonly<Record<string, number | readonly QueryRecord<unknown, Re..., Readonly<Record<string, unknown>>>[]>>, Readonly<Record<string, unknown>>>>
Throws
When the query is malformed — with a message saying what to fix