Interface: CompleteQueryInitializer<TableInfo>

server.CompleteQueryInitializer A population is selected once, before traversal.

​

Type parameters

​

Hierarchy

• Omit<SelectableQueryInitializer<TableInfo>, "visible" | "complete" | "require">
• LogicalDomainInitializer<TableInfo> ↳ CompleteQueryInitializer

​

Properties

​

take

• take: (n: number, options: ReadAvailabilityOptions) => Promise<ReadResult<DocumentByInfo<TableInfo>[]>>(n: number) => Promise<DocumentByInfo<TableInfo>[]>

​

Type declaration

▸ (n, options): Promise<ReadResult<DocumentByInfo<TableInfo>[]>>

Parameters

Returns

Promise<ReadResult<DocumentByInfo<TableInfo>[]>> ▸ (n): Promise<DocumentByInfo<TableInfo>[]>

Parameters

Returns

Promise<DocumentByInfo<TableInfo>[]>

​

Inherited from

Omit.take

---

​

collect

• collect: (options: ReadAvailabilityOptions) => Promise<ReadResult<DocumentByInfo<TableInfo>[]>>() => Promise<DocumentByInfo<TableInfo>[]>

​

Type declaration

▸ (options): Promise<ReadResult<DocumentByInfo<TableInfo>[]>>

Parameters

Returns

Promise<ReadResult<DocumentByInfo<TableInfo>[]>> ▸ (): Promise<DocumentByInfo<TableInfo>[]>

Returns

Promise<DocumentByInfo<TableInfo>[]>

​

Inherited from

Omit.collect

---

​

first

• first: (options: ReadAvailabilityOptions) => Promise<ReadResult<null | DocumentByInfo<TableInfo>>>() => Promise<null | DocumentByInfo<TableInfo>>

​

Type declaration

▸ (options): Promise<ReadResult<null | DocumentByInfo<TableInfo>>>

Parameters

Returns

Promise<ReadResult<null | DocumentByInfo<TableInfo>>> ▸ (): Promise<null | DocumentByInfo<TableInfo>>

Returns

Promise<null | DocumentByInfo<TableInfo>>

​

Inherited from

Omit.first

---

​

unique

• unique: (options: ReadAvailabilityOptions) => Promise<ReadResult<null | DocumentByInfo<TableInfo>>>() => Promise<null | DocumentByInfo<TableInfo>>

​

Type declaration

▸ (options): Promise<ReadResult<null | DocumentByInfo<TableInfo>>>

Parameters

Returns

Promise<ReadResult<null | DocumentByInfo<TableInfo>>> ▸ (): Promise<null | DocumentByInfo<TableInfo>>

Returns

Promise<null | DocumentByInfo<TableInfo>>

​

Inherited from

Omit.unique

---

​

paginate

• paginate: (paginationOpts: PaginationOptions, options: ReadAvailabilityOptions) => Promise<ReadResult<PaginationResult<DocumentByInfo<TableInfo>>>>(paginationOpts: PaginationOptions) => Promise<PaginationResult<DocumentByInfo<TableInfo>>>

​

Type declaration

▸ (paginationOpts, options): Promise<ReadResult<PaginationResult<DocumentByInfo<TableInfo>>>>

Parameters

Returns

Promise<ReadResult<PaginationResult<DocumentByInfo<TableInfo>>>> ▸ (paginationOpts): Promise<PaginationResult<DocumentByInfo<TableInfo>>>

Parameters

Returns

Promise<PaginationResult<DocumentByInfo<TableInfo>>>

​

Inherited from

Omit.paginate

​

Methods

​

groupBy

▸ groupBy<Path>(field): SelectionAnalysis<TableInfo["fieldPaths"], true, false, false> Group this selection’s samples by one record field.

​

Type parameters

​

Parameters

​

Returns

SelectionAnalysis<TableInfo["fieldPaths"], true, false, false>

​

Inherited from

Omit.groupBy

---

​

window

▸ window(spec): SelectionAnalysis<TableInfo["fieldPaths"], false, true, false> Window this selection’s event time on a fixed-duration grid.

​

Parameters

​

Returns

SelectionAnalysis<TableInfo["fieldPaths"], false, true, false>

​

Inherited from

Omit.window

---

​

signal

▸ signal(policy): SelectionAnalysis<TableInfo["fieldPaths"], false, false, true> Interpret one series’ samples over the selection’s bounded interval.

​

Parameters

​

Returns

SelectionAnalysis<TableInfo["fieldPaths"], false, false, true>

​

Inherited from

Omit.signal

---

​

explain

▸ explain(): ReadPath Inspect the structural plan without consuming the query or deciding authority.

​

Returns

ReadPath

​

Inherited from

Omit.explain

---

​

iterate

▸ iterate(options): AsyncIterableIterator<DocumentByInfo<TableInfo>, any, any> Iterate with at most this many candidates per native index fetch (1–1024). Use 1 when merging queues so unopened pages are not fetched speculatively. Filters and access checks may require multiple fetches to yield one row.

​

Parameters

​

Returns

AsyncIterableIterator<DocumentByInfo<TableInfo>, any, any>

​

Inherited from

Omit.iterate

---

​

aggregate

▸ aggregate<Measures, By>(measures, options?): AggregateResult<TableInfo, Measures, By> Reduce the whole population before any limit or projection. Work and authorization failures refuse the total rather than returning a partial value.

​

Type parameters

​

Parameters

​

Returns

AggregateResult<TableInfo, Measures, By>

​

Inherited from

Omit.aggregate

---

​

readPage

▸ readPage(options): Promise<QueryReadPage<DocumentByInfo<TableInfo>>> Read one bounded traversal step. This does not register a reactive page boundary; ordinary read dependencies and current access still apply.

​

Parameters

​

Returns

Promise<QueryReadPage<DocumentByInfo<TableInfo>>>

​

Inherited from

Omit.readPage

---

​

select

▸ select<Fields>(fields): ProjectedQuery<TableInfo, Fields, "strict"> See select.

​

Type parameters

​

Parameters

​

Returns

ProjectedQuery<TableInfo, Fields, "strict">

​

Inherited from

Omit.select

---

​

selectCells

▸ selectCells<Fields>(fields): ProjectedQuery<TableInfo, Fields, "visible"> See selectCells.

​

Type parameters

​

Parameters

​

Returns

ProjectedQuery<TableInfo, Fields, "visible">

​

Inherited from

Omit.selectCells

---

​

where

▸ where(domain): LogicalQuery<TableInfo> Read the population over these field equalities, in creation order unless orderBy states another.

​

Parameters

​

Returns

LogicalQuery<TableInfo>

​

Inherited from

LogicalDomainInitializer.where

---

​

orderBy

▸ orderBy(field, order?): SelectableOrderedQuery<TableInfo> Read the whole population in this logical order.

​

Parameters

​

Returns

SelectableOrderedQuery<TableInfo>

​

Inherited from

LogicalDomainInitializer.orderBy

---

​

withBudget

▸ withBudget(budget): SelectableQuery<TableInfo>

​

Parameters

​

Returns

SelectableQuery<TableInfo>

​

Inherited from

Omit.withBudget

---

​

collectWithDiagnostics

▸ collectWithDiagnostics(): Promise<ReadReport<DocumentByInfo<TableInfo>, ReadUsage>>

​

Returns

Promise<ReadReport<DocumentByInfo<TableInfo>, ReadUsage>>

​

Inherited from

Omit.collectWithDiagnostics

---

​

takeWithDiagnostics

▸ takeWithDiagnostics(n): Promise<ReadReport<DocumentByInfo<TableInfo>, ReadUsage>>

​

Parameters

​

Returns

Promise<ReadReport<DocumentByInfo<TableInfo>, ReadUsage>>

​

Inherited from

Omit.takeWithDiagnostics

---

​

filter

▸ filter(predicate): SelectableQueryInitializer<TableInfo> & { visible: never ; complete: never ; withAccessPath: never }

​

Parameters

​

Returns

SelectableQueryInitializer<TableInfo> & { visible: never ; complete: never ; withAccessPath: never }

​

Inherited from

Omit.filter

---

​

order

▸ order(order): SelectableOrderedQuery<TableInfo>

​

Parameters

​

Returns

SelectableOrderedQuery<TableInfo>

​

Inherited from

Omit.order

---

​

fullTableScan

▸ fullTableScan(): SelectableQuery<TableInfo>

​

Returns

SelectableQuery<TableInfo>

​

Inherited from

Omit.fullTableScan

---

​

withSpatialIndex

▸ withSpatialIndex<Name, Range>(indexName, range): SpatialIndexQuery<TableInfo, Name, Range> Read a spatial index: any equality prefix, or a complete partition optionally restricted by one spatial operation.

​

Type parameters

​

Parameters

​

Returns

SpatialIndexQuery<TableInfo, Name, Range>

​

Inherited from

Omit.withSpatialIndex ▸ withSpatialIndex<Name>(indexName): SpatialIndexQuery<TableInfo, Name, SpatialRangeBuilder<DocumentByInfo<TableInfo>, SpatialPartitions<NamedIndex<TableInfo, Name>>, SpatialIndexField<NamedIndex<TableInfo, Name>>>>

​

Type parameters

​

Parameters

​

Returns

SpatialIndexQuery<TableInfo, Name, SpatialRangeBuilder<DocumentByInfo<TableInfo>, SpatialPartitions<NamedIndex<TableInfo, Name>>, SpatialIndexField<NamedIndex<TableInfo, Name>>>>

​

Inherited from

Omit.withSpatialIndex

---

​

withIndex

▸ withIndex<IndexName>(indexName, indexRange?): SelectableQuery<TableInfo>

​

Type parameters

​

Parameters

​

Returns

SelectableQuery<TableInfo>

​

Inherited from

Omit.withIndex

---

​

withSearchIndex

▸ withSearchIndex<IndexName>(indexName, searchFilter): SelectableOrderedQuery<TableInfo>

​

Type parameters

​

Parameters

​

Returns

SelectableOrderedQuery<TableInfo>

​

Inherited from

Omit.withSearchIndex

---

​

require

▸ require(requirement): CompleteQueryInitializer<TableInfo>

​

Parameters

​

Returns

CompleteQueryInitializer<TableInfo>

---

​

[asyncIterator]

▸ [asyncIterator](): AsyncIterator<DocumentByInfo<TableInfo>, any, any>

​

Returns

AsyncIterator<DocumentByInfo<TableInfo>, any, any>

​

Inherited from

Omit.[asyncIterator]