Interface: VisibleQueryInitializer<TableInfo>

server.VisibleQueryInitializer Not exported: an exported type refers to it.

​

Type parameters

​

Hierarchy

• Omit<SelectableQueryInitializer<TableInfo>, "withSearchIndex" | "withSpatialIndex" | "require" | "knownRecords"> ↳ VisibleQueryInitializer

​

Methods

​

count

▸ count(): Promise<number>

​

Returns

Promise<number>

​

Inherited from

Omit.count

---

​

filter

▸ filter(predicate): SelectableQueryInitializer<TableInfo>

​

Parameters

​

Returns

SelectableQueryInitializer<TableInfo>

​

Inherited from

Omit.filter

---

​

limit

▸ limit(n): SelectableQueryInitializer<TableInfo>

​

Parameters

​

Returns

SelectableQueryInitializer<TableInfo>

​

Inherited from

Omit.limit

---

​

paginate

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

​

Parameters

​

Returns

Promise<PaginationResult<DocumentByInfo<TableInfo>>>

​

Inherited from

Omit.paginate

---

​

collect

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

​

Returns

Promise<DocumentByInfo<TableInfo>[]>

​

Inherited from

Omit.collect

---

​

take

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

​

Parameters

​

Returns

Promise<DocumentByInfo<TableInfo>[]>

​

Inherited from

Omit.take

---

​

first

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

​

Returns

Promise<null | DocumentByInfo<TableInfo>>

​

Inherited from

Omit.first

---

​

unique

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

​

Returns

Promise<null | DocumentByInfo<TableInfo>>

​

Inherited from

Omit.unique

---

​

iterate

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

​

Parameters

​

Returns

AsyncIterableIterator<DocumentByInfo<TableInfo>>

​

Inherited from

Omit.iterate

---

​

where

▸ where(predicate): SelectableQueryInitializer<TableInfo>

​

Parameters

​

Returns

SelectableQueryInitializer<TableInfo>

​

Inherited from

Omit.where

---

​

readPage

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

​

Parameters

​

Returns

Promise<QueryReadPage<DocumentByInfo<TableInfo>>>

​

Inherited from

Omit.readPage

---

​

select

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

​

Type parameters

​

Parameters

​

Returns

ProjectedQuery<TableInfo, Fields, "strict">

​

Inherited from

Omit.select

---

​

selectCells

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

​

Type parameters

​

Parameters

​

Returns

ProjectedQuery<TableInfo, Fields, "visible">

​

Inherited from

Omit.selectCells

---

​

order

▸ order(order): SelectableOrderedQuery<TableInfo>

​

Parameters

​

Returns

SelectableOrderedQuery<TableInfo>

​

Inherited from

Omit.order

---

​

fullTableScan

▸ fullTableScan(): SelectableQuery<TableInfo>

​

Returns

SelectableQuery<TableInfo>

​

Inherited from

Omit.fullTableScan

---

​

withIndex

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

​

Type parameters

​

Parameters

​

Returns

SelectableQuery<TableInfo>

​

Inherited from

Omit.withIndex

---

​

require

▸ require(requirement): VisibleQueryInitializer<TableInfo>

​

Parameters

​

Returns

VisibleQueryInitializer<TableInfo>

---

​

knownRecords

▸ knownRecords(): VisibleQueryInitializer<TableInfo>

​

Returns

VisibleQueryInitializer<TableInfo>

---

​

[asyncIterator]

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

​

Returns

AsyncIterator<DocumentByInfo<TableInfo>, any, undefined>

​

Inherited from

Omit.[asyncIterator]