> ## Documentation Index
> Fetch the complete documentation index at: https://docs.bijection.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Interface: VisibleQueryInitializer<TableInfo>

> Not exported: an exported type refers to it.

[server](/api/modules/server).VisibleQueryInitializer

Not exported: an exported type refers to it.

## Type parameters

| Name | Type |
| :- | :- |
| `TableInfo` | extends [`GenericTableInfo`](/api/modules/server#generictableinfo) |

## Hierarchy

* `Omit`\<[`SelectableQueryInitializer`](/api/interfaces/server.SelectableQueryInitializer)\<`TableInfo`>, `"withSearchIndex"` | `"withSpatialIndex"` | `"require"` | `"knownRecords"`>

  ↳ **`VisibleQueryInitializer`**

## Methods

### count

▸ **count**(): `Promise`\<`number`>

#### Returns

`Promise`\<`number`>

#### Inherited from

Omit.count

***

### filter

▸ **filter**(`predicate`): [`SelectableQueryInitializer`](/api/interfaces/server.SelectableQueryInitializer)\<`TableInfo`>

#### Parameters

| Name | Type |
| :- | :- |
| `predicate` | (`q`: [`FilterBuilder`](/api/interfaces/server.FilterBuilder)\<`TableInfo`>) => [`ExpressionOrValue`](/api/modules/server#expressionorvalue)\<`boolean`> |

#### Returns

[`SelectableQueryInitializer`](/api/interfaces/server.SelectableQueryInitializer)\<`TableInfo`>

#### Inherited from

Omit.filter

***

### limit

▸ **limit**(`n`): [`SelectableQueryInitializer`](/api/interfaces/server.SelectableQueryInitializer)\<`TableInfo`>

#### Parameters

| Name | Type |
| :- | :- |
| `n` | `number` |

#### Returns

[`SelectableQueryInitializer`](/api/interfaces/server.SelectableQueryInitializer)\<`TableInfo`>

#### Inherited from

Omit.limit

***

### paginate

▸ **paginate**(`paginationOpts`): `Promise`\<[`PaginationResult`](/api/interfaces/server.PaginationResult)\<[`DocumentByInfo`](/api/modules/server#documentbyinfo)\<`TableInfo`>>>

#### Parameters

| Name | Type |
| :- | :- |
| `paginationOpts` | [`PaginationOptions`](/api/interfaces/server.PaginationOptions) |

#### Returns

`Promise`\<[`PaginationResult`](/api/interfaces/server.PaginationResult)\<[`DocumentByInfo`](/api/modules/server#documentbyinfo)\<`TableInfo`>>>

#### Inherited from

Omit.paginate

***

### collect

▸ **collect**(): `Promise`\<[`DocumentByInfo`](/api/modules/server#documentbyinfo)\<`TableInfo`>\[]>

#### Returns

`Promise`\<[`DocumentByInfo`](/api/modules/server#documentbyinfo)\<`TableInfo`>\[]>

#### Inherited from

Omit.collect

***

### take

▸ **take**(`n`): `Promise`\<[`DocumentByInfo`](/api/modules/server#documentbyinfo)\<`TableInfo`>\[]>

#### Parameters

| Name | Type |
| :- | :- |
| `n` | `number` |

#### Returns

`Promise`\<[`DocumentByInfo`](/api/modules/server#documentbyinfo)\<`TableInfo`>\[]>

#### Inherited from

Omit.take

***

### first

▸ **first**(): `Promise`\<`null` | [`DocumentByInfo`](/api/modules/server#documentbyinfo)\<`TableInfo`>>

#### Returns

`Promise`\<`null` | [`DocumentByInfo`](/api/modules/server#documentbyinfo)\<`TableInfo`>>

#### Inherited from

Omit.first

***

### unique

▸ **unique**(): `Promise`\<`null` | [`DocumentByInfo`](/api/modules/server#documentbyinfo)\<`TableInfo`>>

#### Returns

`Promise`\<`null` | [`DocumentByInfo`](/api/modules/server#documentbyinfo)\<`TableInfo`>>

#### Inherited from

Omit.unique

***

### iterate

▸ **iterate**(`options`): `AsyncIterableIterator`\<[`DocumentByInfo`](/api/modules/server#documentbyinfo)\<`TableInfo`>>

#### Parameters

| Name | Type |
| :- | :- |
| `options` | `Object` |
| `options.prefetch` | `number` |

#### Returns

`AsyncIterableIterator`\<[`DocumentByInfo`](/api/modules/server#documentbyinfo)\<`TableInfo`>>

#### Inherited from

Omit.iterate

***

### where

▸ **where**(`predicate`): [`SelectableQueryInitializer`](/api/interfaces/server.SelectableQueryInitializer)\<`TableInfo`>

#### Parameters

| Name | Type |
| :- | :- |
| `predicate` | (`row`: [`SpatialRow`](/api/modules/server#spatialrow)\<[`DocumentByInfo`](/api/modules/server#documentbyinfo)\<`TableInfo`>>) => [`ExpressionOrValue`](/api/modules/server#expressionorvalue)\<`boolean`> |

#### Returns

[`SelectableQueryInitializer`](/api/interfaces/server.SelectableQueryInitializer)\<`TableInfo`>

#### Inherited from

Omit.where

***

### readPage

▸ **readPage**(`options`): `Promise`\<[`QueryReadPage`](/api/modules/server#queryreadpage)\<[`DocumentByInfo`](/api/modules/server#documentbyinfo)\<`TableInfo`>>>

#### Parameters

| Name | Type |
| :- | :- |
| `options` | [`PaginationOptions`](/api/interfaces/server.PaginationOptions) |

#### Returns

`Promise`\<[`QueryReadPage`](/api/modules/server#queryreadpage)\<[`DocumentByInfo`](/api/modules/server#documentbyinfo)\<`TableInfo`>>>

#### Inherited from

Omit.readPage

***

### select

▸ **select**\<`Fields`>(`fields`): [`ProjectedQuery`](/api/interfaces/server.ProjectedQuery)\<`TableInfo`, `Fields`, `"strict"`>

#### Type parameters

| Name | Type |
| :- | :- |
| `Fields` | extends [`DocumentFields`](/api/modules/server#documentfields)\<[`DocumentByInfo`](/api/modules/server#documentbyinfo)\<`TableInfo`>> |

#### Parameters

| Name | Type |
| :- | :- |
| `fields` | readonly `Fields`\[] |

#### Returns

[`ProjectedQuery`](/api/interfaces/server.ProjectedQuery)\<`TableInfo`, `Fields`, `"strict"`>

#### Inherited from

Omit.select

***

### selectCells

▸ **selectCells**\<`Fields`>(`fields`): [`ProjectedQuery`](/api/interfaces/server.ProjectedQuery)\<`TableInfo`, `Fields`, `"visible"`>

#### Type parameters

| Name | Type |
| :- | :- |
| `Fields` | extends [`DocumentFields`](/api/modules/server#documentfields)\<[`DocumentByInfo`](/api/modules/server#documentbyinfo)\<`TableInfo`>> |

#### Parameters

| Name | Type |
| :- | :- |
| `fields` | readonly `Fields`\[] |

#### Returns

[`ProjectedQuery`](/api/interfaces/server.ProjectedQuery)\<`TableInfo`, `Fields`, `"visible"`>

#### Inherited from

Omit.selectCells

***

### order

▸ **order**(`order`): [`SelectableOrderedQuery`](/api/interfaces/server.SelectableOrderedQuery)\<`TableInfo`>

#### Parameters

| Name | Type |
| :- | :- |
| `order` | `"asc"` \| `"desc"` |

#### Returns

[`SelectableOrderedQuery`](/api/interfaces/server.SelectableOrderedQuery)\<`TableInfo`>

#### Inherited from

Omit.order

***

### fullTableScan

▸ **fullTableScan**(): [`SelectableQuery`](/api/interfaces/server.SelectableQuery)\<`TableInfo`>

#### Returns

[`SelectableQuery`](/api/interfaces/server.SelectableQuery)\<`TableInfo`>

#### Inherited from

Omit.fullTableScan

***

### withIndex

▸ **withIndex**\<`IndexName`>(`indexName`, `indexRange?`): [`SelectableQuery`](/api/interfaces/server.SelectableQuery)\<`TableInfo`>

#### Type parameters

| Name | Type |
| :- | :- |
| `IndexName` | extends [`IndexNames`](/api/modules/server#indexnames)\<`TableInfo`> |

#### Parameters

| Name | Type |
| :- | :- |
| `indexName` | `IndexName` |
| `indexRange?` | (`q`: [`IndexRangeBuilder`](/api/interfaces/server.IndexRangeBuilder)\<[`DocumentByInfo`](/api/modules/server#documentbyinfo)\<`TableInfo`>, [`NamedIndex`](/api/modules/server#namedindex)\<`TableInfo`, `IndexName`>, `0`>) => [`IndexRange`](/api/classes/server.IndexRange) |

#### Returns

[`SelectableQuery`](/api/interfaces/server.SelectableQuery)\<`TableInfo`>

#### Inherited from

Omit.withIndex

***

### require

▸ **require**(`requirement`): [`VisibleQueryInitializer`](/api/interfaces/server.VisibleQueryInitializer)\<`TableInfo`>

#### Parameters

| Name | Type |
| :- | :- |
| `requirement` | [`SourceReadRequirement`](/api/modules/server#sourcereadrequirement) |

#### Returns

[`VisibleQueryInitializer`](/api/interfaces/server.VisibleQueryInitializer)\<`TableInfo`>

***

### knownRecords

▸ **knownRecords**(): [`VisibleQueryInitializer`](/api/interfaces/server.VisibleQueryInitializer)\<`TableInfo`>

#### Returns

[`VisibleQueryInitializer`](/api/interfaces/server.VisibleQueryInitializer)\<`TableInfo`>

***

### \[asyncIterator]

▸ **\[asyncIterator]**(): `AsyncIterator`\<[`DocumentByInfo`](/api/modules/server#documentbyinfo)\<`TableInfo`>, `any`, `undefined`>

#### Returns

`AsyncIterator`\<[`DocumentByInfo`](/api/modules/server#documentbyinfo)\<`TableInfo`>, `any`, `undefined`>

#### Inherited from

Omit.\[asyncIterator]


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.