Interface: SpatialPartitionQuery<TableInfo, Field>

server.SpatialPartitionQuery A spatial range within one complete partition, which nearest can rank.

​

Type parameters

​

Hierarchy

• SpatialQuery<TableInfo> ↳ SpatialPartitionQuery

​

Methods

​

require

▸ require(requirement): SpatialPartitionQuery<TableInfo, Field>

​

Parameters

​

Returns

SpatialPartitionQuery<TableInfo, Field>

​

Inherited from

SpatialQuery.require

---

​

filter

▸ filter(predicate): SpatialPartitionQuery<TableInfo, Field>

​

Parameters

​

Returns

SpatialPartitionQuery<TableInfo, Field>

​

Inherited from

SpatialQuery.filter

---

​

withBudget

▸ withBudget(budget): SpatialPartitionQuery<TableInfo, Field>

​

Parameters

​

Returns

SpatialPartitionQuery<TableInfo, Field>

​

Inherited from

SpatialQuery.withBudget

---

​

explain

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

​

Returns

ReadPath

​

Inherited from

SpatialQuery.explain

---

​

collect

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

​

Returns

Promise<DocumentByInfo<TableInfo>[]>

​

Inherited from

SpatialQuery.collect

---

​

take

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

​

Parameters

​

Returns

Promise<DocumentByInfo<TableInfo>[]>

​

Inherited from

SpatialQuery.take

---

​

first

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

​

Returns

Promise<null | DocumentByInfo<TableInfo>>

​

Inherited from

SpatialQuery.first

---

​

unique

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

​

Returns

Promise<null | DocumentByInfo<TableInfo>>

​

Inherited from

SpatialQuery.unique

---

​

paginate

▸ paginate(options): Promise<PaginationResult<DocumentByInfo<TableInfo>>>

​

Parameters

​

Returns

Promise<PaginationResult<DocumentByInfo<TableInfo>>>

​

Inherited from

SpatialQuery.paginate

---

​

readPage

▸ readPage(options): Promise<QueryReadPage<DocumentByInfo<TableInfo>>>

​

Parameters

​

Returns

Promise<QueryReadPage<DocumentByInfo<TableInfo>>>

​

Inherited from

SpatialQuery.readPage

---

​

iterate

▸ iterate(options): AsyncIterableIterator<DocumentByInfo<TableInfo>, any, any>

​

Parameters

​

Returns

AsyncIterableIterator<DocumentByInfo<TableInfo>, any, any>

​

Inherited from

SpatialQuery.iterate

---

​

aggregate

▸ aggregate<Measures, By>(measures, options?): AggregateResult<TableInfo, Measures, By>

​

Type parameters

​

Parameters

​

Returns

AggregateResult<TableInfo, Measures, By>

​

Inherited from

SpatialQuery.aggregate

---

​

collectWithDiagnostics

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

​

Returns

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

​

Inherited from

SpatialQuery.collectWithDiagnostics

---

​

takeWithDiagnostics

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

​

Parameters

​

Returns

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

​

Inherited from

SpatialQuery.takeWithDiagnostics

---

​

nearest

▸ nearest(origin, ...options): NearestQuery<DocumentByInfo<TableInfo>> Rank this range’s eligible documents by distance. Filters apply before ranking; consume the result with take or first.

​

Parameters

​

Returns

NearestQuery<DocumentByInfo<TableInfo>>

---

​

[asyncIterator]

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

​

Returns

AsyncIterator<DocumentByInfo<TableInfo>, any, any>

​

Inherited from

SpatialQuery.[asyncIterator]