Type parameters
Hierarchy
-
AsyncIterable<DocumentByInfo<TableInfo>> ↳SetQuery
Methods
require
▸ require(requirement): SetQuery<TableInfo>
Parameters
Returns
SetQuery<TableInfo>
knownRecords
▸ knownRecords():SetQuery<TableInfo>
Returns
SetQuery<TableInfo>
aggregate
▸ aggregate<Measures, By>(measures, options?): Promise<QueryAggregateOutput<TableInfo, Measures, By>>
Type parameters
Parameters
Returns
Promise<QueryAggregateOutput<TableInfo, Measures, By>>
where
▸ where(predicate): SetQuery<TableInfo>
Parameters
Returns
SetQuery<TableInfo>
filter
▸ filter(predicate): SetQuery<TableInfo>
Parameters
Returns
SetQuery<TableInfo>
collect
▸ collect():Promise<DocumentByInfo<TableInfo>[]>
Returns
Promise<DocumentByInfo<TableInfo>[]>
collectWithDiagnostics
▸ collectWithDiagnostics():Promise<{ rows: DocumentByInfo<TableInfo>[] ; diagnostics: SpatialReadDiagnostics ; execution: ReadExecutionDiagnostics }>
Execute with whole-population authorization and native work counters.
Returns
Promise<{ rows: DocumentByInfo<TableInfo>[] ; diagnostics: SpatialReadDiagnostics ; execution: ReadExecutionDiagnostics }>
paginate
▸ paginate(options): Promise<PaginationResult<DocumentByInfo<TableInfo>>>
Parameters
Returns
Promise<PaginationResult<DocumentByInfo<TableInfo>>>
readPage
▸ readPage(options): Promise<QueryReadPage<DocumentByInfo<TableInfo>>>
Parameters
Returns
Promise<QueryReadPage<DocumentByInfo<TableInfo>>>
nearest
▸ nearest(origin, options): Promise<{ doc: DocumentByInfo<TableInfo> ; distance_m: number }[]>
Order by reported point distance. Refuse if global ordering cannot be
established within the native work budget. Requires a spatial index.
Parameters
Returns
Promise<{ doc: DocumentByInfo<TableInfo> ; distance_m: number }[]>
nearestWithDiagnostics
▸ nearestWithDiagnostics(origin, options): Promise<{ rows: { doc: DocumentByInfo<TableInfo> ; distance_m: number }[] ; diagnostics: { work: SpatialReadDiagnostics ; execution: ReadExecutionDiagnostics ; cells_visited: number ; cells_subdivided: number ; index_probes: number ; rows_ranked: number ; unique_documents_ranked: number ; rows_read: number ; bytes_read: number ; frontier_peak: number } }>
The same exact answer with native work counters. This stronger read
requires authorization for the whole candidate range, including rows
ordinary selective reads could withhold.
Parameters
Returns
Promise<{ rows: { doc: DocumentByInfo<TableInfo> ; distance_m: number }[] ; diagnostics: { work: SpatialReadDiagnostics ; execution: ReadExecutionDiagnostics ; cells_visited: number ; cells_subdivided: number ; index_probes: number ; rows_ranked: number ; unique_documents_ranked: number ; rows_read: number ; bytes_read: number ; frontier_peak: number } }>
[asyncIterator]
▸ [asyncIterator]():AsyncIterator<DocumentByInfo<TableInfo>, any, any>
Returns
AsyncIterator<DocumentByInfo<TableInfo>, any, any>