Type parameters
Hierarchy
-
ObjectResultQuery<Rowextends {_id:unknown;_creationTime:unknown} ?CollectionRow<Row> :Readonly<Partial<Row>>> ↳ObjectSet
Properties
context
•Protected Readonly context: Context
Inherited from
ObjectResultQuery.contextexpression
•Protected Readonly expression: ObjectQueryExpression
Inherited from
ObjectResultQuery.expressioncollection
•Readonly collection: Name
Methods
declaration
▸ declaration():ObjectQueryRequest
Capture the structured declaration for build-time consumer extraction.
This is a declaration only; it performs no authorization or data read.
Returns
ObjectQueryRequest
Inherited from
ObjectResultQuery.declarationdescribe
▸ describe(options?): Promise<PreparedObjectQuery>
Parameters
Returns
Promise<PreparedObjectQuery>
Inherited from
ObjectResultQuery.describeread
▸ read(options?): Promise<Readonly<ObjectQueryValue<Row extends { _id: unknown ; _creationTime: unknown } ? CollectionRow<Row> : Readonly<Partial<Row>>> & { basis: string ; binding: string }>>
Parameters
Returns
Promise<Readonly<ObjectQueryValue<Row extends { _id: unknown ; _creationTime: unknown } ? CollectionRow<Row> : Readonly<Partial<Row>>> & { basis: string ; binding: string }>>
Inherited from
ObjectResultQuery.readwatch
▸ watch(listener): () => void
Parameters
Returns
fn
▸ (): void
Returns
void
Inherited from
ObjectResultQuery.watchpage
▸ page(options?): Promise<ObjectQueryPage<Row extends { _id: unknown ; _creationTime: unknown } ? CollectionRow<Row> : Readonly<Partial<Row>>>>
Parameters
Returns
Promise<ObjectQueryPage<Row extends { _id: unknown ; _creationTime: unknown } ? CollectionRow<Row> : Readonly<Partial<Row>>>>
Inherited from
ObjectResultQuery.pagerun
▸ run(bounds?): Promise<QuestionRequest<{ rows: { kind: "table" ; row: Row extends { _id: unknown ; _creationTime: unknown } ? CollectionRow<Row> : Readonly<Partial<Row>> } }>>
Explicit durable execution. The returned request owns observation, paging and cleanup.
Parameters
Returns
Promise<QuestionRequest<{ rows: { kind: "table" ; row: Row extends { _id: unknown ; _creationTime: unknown } ? CollectionRow<Row> : Readonly<Partial<Row>> } }>>
Inherited from
ObjectResultQuery.runexplain
▸ explain(bounds?): Promise<ObjectQueryExplanation>
Parameters
Returns
Promise<ObjectQueryExplanation>
Inherited from
ObjectResultQuery.explainorderBy
▸ orderBy(...fields): ObjectResultQuery<Row extends { _id: unknown ; _creationTime: unknown } ? CollectionRow<Row> : Readonly<Partial<Row>>>
Parameters
Returns
ObjectResultQuery<Row extends { _id: unknown ; _creationTime: unknown } ? CollectionRow<Row> : Readonly<Partial<Row>>>
Inherited from
ObjectResultQuery.orderBywhere
▸ where<Filters>(filters): ObjectSet<Schema, Name, NarrowCollectionRow<Row, Filters>>
Type parameters
Parameters
Returns
ObjectSet<Schema, Name, NarrowCollectionRow<Row, Filters>>
related
▸ related<Alias>(relationship): ObjectSet<Schema, Extract<Schema[Name]["relationships"][Alias], keyof Schema & string>>
Type parameters
Parameters
Returns
ObjectSet<Schema, Extract<Schema[Name]["relationships"][Alias], keyof Schema & string>>
union
▸ union(this, right): ObjectSet<Schema, Name>
Parameters
Returns
ObjectSet<Schema, Name>
intersect
▸ intersect(this, right): ObjectSet<Schema, Name, Row>
Parameters
Returns
ObjectSet<Schema, Name, Row>
subtract
▸ subtract(this, right): ObjectSet<Schema, Name, Row>
Parameters
Returns
ObjectSet<Schema, Name, Row>
select
▸ select<Result>(shape): ObjectResultQuery<Result>
Type parameters
Parameters
Returns
ObjectResultQuery<Result>
▸ select<Fields>(...fields): ObjectResultQuery<Readonly<Partial<Pick<Row, Fields[number]>>>>
Type parameters
Parameters
Returns
ObjectResultQuery<Readonly<Partial<Pick<Row, Fields[number]>>>>
aggregate
▸ aggregate<Result>(shape): ObjectResultQuery<Result>
Type parameters
Parameters
Returns
ObjectResultQuery<Result>
groupBy
▸ groupBy<K>(keys): Object
Type parameters
Parameters
Returns
Object