Interface: SpatialQuery<TableInfo>

server.SpatialQuery A spatial set read. Pagination batches have private native order; nearest establishes a global reported-point distance order. A physical encoding never defines a logical top-N result.

​

Type parameters

​

Hierarchy

• AsyncIterable<DocumentByInfo<TableInfo>> ↳ SpatialQuery

​

Methods

​

where

▸ where(predicate): SpatialQuery<TableInfo>

​

Parameters

​

Returns

SpatialQuery<TableInfo>

---

​

filter

▸ filter(predicate): SpatialQuery<TableInfo>

​

Parameters

​

Returns

SpatialQuery<TableInfo>

---

​

collect

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

​

Returns

Promise<DocumentByInfo<TableInfo>[]>

---

​

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 }[]>

---

​

[asyncIterator]

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

​

Returns

AsyncIterator<DocumentByInfo<TableInfo>, any, undefined>

​

Inherited from

AsyncIterable.[asyncIterator]