Adds multiple conditions that are combined with an AND operator.
An array of conditions to be applied together.
The updated query builder.
Clones the current join query builder instance.
A deep copy of the join query builder.
Extracts the root document's data from the given join result.
A record containing document references.
The root document's data.
Reverses the direction of all currently applied sort orders.
The updated query builder.
@internal/
Returns the current sort orders applied to the query.
An array of field sort definitions.
Transforms this join query result to a nested data structure. For example, a join between teachers and students normally returns a result of the form: [ { teacher: {name: 'Mr. Smith'}, student: {name: 'John Doe'} }, { teacher: {name: 'Mr. Smith'}, student: {name: 'Jane Smith'} }, { teacher: {name: 'Mr. EmptyClass'}, student: undefined }, ] into a result of the form: [ { teacher: {name: 'Mr. Smith'}, students: [ { name: 'John Doe' }, { name: 'Jane Smith' }, ]}, { teacher: {name: 'Mr. EmptyClass'}, students: [] }, ]
@internal/
Enables pagination for the join query results.
Optional
options: Partial<PaginationOptions>Optional pagination configuration such as page size and cursor.
A Pagination object for fetching paginated results.
Returns the results of the query based on the data that is currently available on the client. This method is useful for synchronously accessing data that has already been fetched by another query. The method will return an empty array if data has not yet been populated.
An array of query results.
Serializes the join query into a plain object.
A serialized representation of the query, suitable for transport or logging.
Returns a promise that resolves to the query results.
A promise that resolves to the query results.
Returns an observable that emits the query results and updates whenever the query results change unless
subscribe=false
is provided.
Important: Make sure to unsubscribe from the observable when you are done with it.
Optional
subscribe: booleanWhether to subscribe to changes to the query results. Defaults to true
.
An observable for the query results.
A join query result that has been grouped by alias and returns the DocumentData.