> ## 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: CompleteQueryInitializer<TableInfo>

> A population is selected once, before traversal.

[server](https://docs.bijection.com/api/modules/server).CompleteQueryInitializer

A population is selected once, before traversal.

## Type parameters

| Name | Type |
| :- | :- |
| `TableInfo` | extends [`GenericTableInfo`](https://docs.bijection.com/api/modules/server#generictableinfo) |

## Hierarchy

* `Omit`\<[`PopulationQueryInitializer`](https://docs.bijection.com/api/interfaces/server.PopulationQueryInitializer)\<`TableInfo`>, `"visible"` | `"complete"` | `"require"`>

  ↳ **`CompleteQueryInitializer`**

## Properties

### take

• **take**: (`n`: `number`, `options`: [`ReadAvailabilityOptions`](https://docs.bijection.com/api/modules/server#readavailabilityoptions)) => `Promise`\<[`ReadResult`](https://docs.bijection.com/api/modules/server#readresult)\<[`DocumentByInfo`](https://docs.bijection.com/api/modules/server#documentbyinfo)\<`TableInfo`>\[]>>(`n`: `number`) => `Promise`\<[`DocumentByInfo`](https://docs.bijection.com/api/modules/server#documentbyinfo)\<`TableInfo`>\[]>

#### Type declaration

▸ (`n`, `options`): `Promise`\<[`ReadResult`](https://docs.bijection.com/api/modules/server#readresult)\<[`DocumentByInfo`](https://docs.bijection.com/api/modules/server#documentbyinfo)\<`TableInfo`>\[]>>

##### Parameters

| Name | Type |
| :- | :- |
| `n` | `number` |
| `options` | [`ReadAvailabilityOptions`](https://docs.bijection.com/api/modules/server#readavailabilityoptions) |

##### Returns

`Promise`\<[`ReadResult`](https://docs.bijection.com/api/modules/server#readresult)\<[`DocumentByInfo`](https://docs.bijection.com/api/modules/server#documentbyinfo)\<`TableInfo`>\[]>>

▸ (`n`): `Promise`\<[`DocumentByInfo`](https://docs.bijection.com/api/modules/server#documentbyinfo)\<`TableInfo`>\[]>

##### Parameters

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

##### Returns

`Promise`\<[`DocumentByInfo`](https://docs.bijection.com/api/modules/server#documentbyinfo)\<`TableInfo`>\[]>

#### Inherited from

Omit.take

***

### collect

• **collect**: (`options`: [`ReadAvailabilityOptions`](https://docs.bijection.com/api/modules/server#readavailabilityoptions)) => `Promise`\<[`ReadResult`](https://docs.bijection.com/api/modules/server#readresult)\<[`DocumentByInfo`](https://docs.bijection.com/api/modules/server#documentbyinfo)\<`TableInfo`>\[]>>() => `Promise`\<[`DocumentByInfo`](https://docs.bijection.com/api/modules/server#documentbyinfo)\<`TableInfo`>\[]>

#### Type declaration

▸ (`options`): `Promise`\<[`ReadResult`](https://docs.bijection.com/api/modules/server#readresult)\<[`DocumentByInfo`](https://docs.bijection.com/api/modules/server#documentbyinfo)\<`TableInfo`>\[]>>

##### Parameters

| Name | Type |
| :- | :- |
| `options` | [`ReadAvailabilityOptions`](https://docs.bijection.com/api/modules/server#readavailabilityoptions) |

##### Returns

`Promise`\<[`ReadResult`](https://docs.bijection.com/api/modules/server#readresult)\<[`DocumentByInfo`](https://docs.bijection.com/api/modules/server#documentbyinfo)\<`TableInfo`>\[]>>

▸ (): `Promise`\<[`DocumentByInfo`](https://docs.bijection.com/api/modules/server#documentbyinfo)\<`TableInfo`>\[]>

##### Returns

`Promise`\<[`DocumentByInfo`](https://docs.bijection.com/api/modules/server#documentbyinfo)\<`TableInfo`>\[]>

#### Inherited from

Omit.collect

***

### first

• **first**: (`options`: [`ReadAvailabilityOptions`](https://docs.bijection.com/api/modules/server#readavailabilityoptions)) => `Promise`\<[`ReadResult`](https://docs.bijection.com/api/modules/server#readresult)\<`null` | [`DocumentByInfo`](https://docs.bijection.com/api/modules/server#documentbyinfo)\<`TableInfo`>>>() => `Promise`\<`null` | [`DocumentByInfo`](https://docs.bijection.com/api/modules/server#documentbyinfo)\<`TableInfo`>>

#### Type declaration

▸ (`options`): `Promise`\<[`ReadResult`](https://docs.bijection.com/api/modules/server#readresult)\<`null` | [`DocumentByInfo`](https://docs.bijection.com/api/modules/server#documentbyinfo)\<`TableInfo`>>>

##### Parameters

| Name | Type |
| :- | :- |
| `options` | [`ReadAvailabilityOptions`](https://docs.bijection.com/api/modules/server#readavailabilityoptions) |

##### Returns

`Promise`\<[`ReadResult`](https://docs.bijection.com/api/modules/server#readresult)\<`null` | [`DocumentByInfo`](https://docs.bijection.com/api/modules/server#documentbyinfo)\<`TableInfo`>>>

▸ (): `Promise`\<`null` | [`DocumentByInfo`](https://docs.bijection.com/api/modules/server#documentbyinfo)\<`TableInfo`>>

##### Returns

`Promise`\<`null` | [`DocumentByInfo`](https://docs.bijection.com/api/modules/server#documentbyinfo)\<`TableInfo`>>

#### Inherited from

Omit.first

***

### unique

• **unique**: (`options`: [`ReadAvailabilityOptions`](https://docs.bijection.com/api/modules/server#readavailabilityoptions)) => `Promise`\<[`ReadResult`](https://docs.bijection.com/api/modules/server#readresult)\<`null` | [`DocumentByInfo`](https://docs.bijection.com/api/modules/server#documentbyinfo)\<`TableInfo`>>>() => `Promise`\<`null` | [`DocumentByInfo`](https://docs.bijection.com/api/modules/server#documentbyinfo)\<`TableInfo`>>

#### Type declaration

▸ (`options`): `Promise`\<[`ReadResult`](https://docs.bijection.com/api/modules/server#readresult)\<`null` | [`DocumentByInfo`](https://docs.bijection.com/api/modules/server#documentbyinfo)\<`TableInfo`>>>

##### Parameters

| Name | Type |
| :- | :- |
| `options` | [`ReadAvailabilityOptions`](https://docs.bijection.com/api/modules/server#readavailabilityoptions) |

##### Returns

`Promise`\<[`ReadResult`](https://docs.bijection.com/api/modules/server#readresult)\<`null` | [`DocumentByInfo`](https://docs.bijection.com/api/modules/server#documentbyinfo)\<`TableInfo`>>>

▸ (): `Promise`\<`null` | [`DocumentByInfo`](https://docs.bijection.com/api/modules/server#documentbyinfo)\<`TableInfo`>>

##### Returns

`Promise`\<`null` | [`DocumentByInfo`](https://docs.bijection.com/api/modules/server#documentbyinfo)\<`TableInfo`>>

#### Inherited from

Omit.unique

***

### paginate

• **paginate**: (`paginationOpts`: [`PaginationOptions`](https://docs.bijection.com/api/interfaces/server.PaginationOptions), `options`: [`ReadAvailabilityOptions`](https://docs.bijection.com/api/modules/server#readavailabilityoptions)) => `Promise`\<[`ReadResult`](https://docs.bijection.com/api/modules/server#readresult)\<[`PaginationResult`](https://docs.bijection.com/api/interfaces/server.PaginationResult)\<[`DocumentByInfo`](https://docs.bijection.com/api/modules/server#documentbyinfo)\<`TableInfo`>>>>(`paginationOpts`: [`PaginationOptions`](https://docs.bijection.com/api/interfaces/server.PaginationOptions)) => `Promise`\<[`PaginationResult`](https://docs.bijection.com/api/interfaces/server.PaginationResult)\<[`DocumentByInfo`](https://docs.bijection.com/api/modules/server#documentbyinfo)\<`TableInfo`>>>

#### Type declaration

▸ (`paginationOpts`, `options`): `Promise`\<[`ReadResult`](https://docs.bijection.com/api/modules/server#readresult)\<[`PaginationResult`](https://docs.bijection.com/api/interfaces/server.PaginationResult)\<[`DocumentByInfo`](https://docs.bijection.com/api/modules/server#documentbyinfo)\<`TableInfo`>>>>

##### Parameters

| Name | Type |
| :- | :- |
| `paginationOpts` | [`PaginationOptions`](https://docs.bijection.com/api/interfaces/server.PaginationOptions) |
| `options` | [`ReadAvailabilityOptions`](https://docs.bijection.com/api/modules/server#readavailabilityoptions) |

##### Returns

`Promise`\<[`ReadResult`](https://docs.bijection.com/api/modules/server#readresult)\<[`PaginationResult`](https://docs.bijection.com/api/interfaces/server.PaginationResult)\<[`DocumentByInfo`](https://docs.bijection.com/api/modules/server#documentbyinfo)\<`TableInfo`>>>>

▸ (`paginationOpts`): `Promise`\<[`PaginationResult`](https://docs.bijection.com/api/interfaces/server.PaginationResult)\<[`DocumentByInfo`](https://docs.bijection.com/api/modules/server#documentbyinfo)\<`TableInfo`>>>

##### Parameters

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

##### Returns

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

#### Inherited from

Omit.paginate

## Methods

### groupBy

▸ **groupBy**\<`Path`>(`field`): [`SelectionAnalysis`](https://docs.bijection.com/api/classes/server.SelectionAnalysis)\<`TableInfo`\[`"fieldPaths"`], `true`, `false`, `false`>

Group this selection's samples by one record field.

#### Type parameters

| Name | Type |
| :- | :- |
| `Path` | extends `TableInfo`\[`"fieldPaths"`] |

#### Parameters

| Name | Type |
| :- | :- |
| `field` | [`SeriesSelectionOnly`](https://docs.bijection.com/api/modules/server#seriesselectiononly)\<`TableInfo`, `Path`> |

#### Returns

[`SelectionAnalysis`](https://docs.bijection.com/api/classes/server.SelectionAnalysis)\<`TableInfo`\[`"fieldPaths"`], `true`, `false`, `false`>

#### Inherited from

Omit.groupBy

***

### window

▸ **window**(`spec`): [`SelectionAnalysis`](https://docs.bijection.com/api/classes/server.SelectionAnalysis)\<`TableInfo`\[`"fieldPaths"`], `false`, `true`, `false`>

Window this selection's event time on a fixed-duration grid.

#### Parameters

| Name | Type |
| :- | :- |
| `spec` | [`SeriesSelectionOnly`](https://docs.bijection.com/api/modules/server#seriesselectiononly)\<`TableInfo`, [`WindowSpec`](https://docs.bijection.com/api/modules/server#windowspec)> |

#### Returns

[`SelectionAnalysis`](https://docs.bijection.com/api/classes/server.SelectionAnalysis)\<`TableInfo`\[`"fieldPaths"`], `false`, `true`, `false`>

#### Inherited from

Omit.window

***

### signal

▸ **signal**(`policy`): [`SelectionAnalysis`](https://docs.bijection.com/api/classes/server.SelectionAnalysis)\<`TableInfo`\[`"fieldPaths"`], `false`, `false`, `true`>

Interpret one series' samples over the selection's bounded interval.

#### Parameters

| Name | Type |
| :- | :- |
| `policy` | [`SeriesSelectionOnly`](https://docs.bijection.com/api/modules/server#seriesselectiononly)\<`TableInfo`, [`SignalPolicy`](https://docs.bijection.com/api/modules/server#signalpolicy)\<`TableInfo`\[`"fieldPaths"`]>> |

#### Returns

[`SelectionAnalysis`](https://docs.bijection.com/api/classes/server.SelectionAnalysis)\<`TableInfo`\[`"fieldPaths"`], `false`, `false`, `true`>

#### Inherited from

Omit.signal

***

### explain

▸ **explain**(): [`ReadPath`](https://docs.bijection.com/api/modules/server#readpath)

Inspect the structural plan without consuming the query or deciding authority.

#### Returns

[`ReadPath`](https://docs.bijection.com/api/modules/server#readpath)

#### Inherited from

Omit.explain

***

### iterate

▸ **iterate**(`options`): `AsyncIterableIterator`\<[`DocumentByInfo`](https://docs.bijection.com/api/modules/server#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

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

#### Returns

`AsyncIterableIterator`\<[`DocumentByInfo`](https://docs.bijection.com/api/modules/server#documentbyinfo)\<`TableInfo`>, `any`, `any`>

#### Inherited from

Omit.iterate

***

### aggregate

▸ **aggregate**\<`Measures`, `By`>(`measures`, `options?`): [`AggregateResult`](https://docs.bijection.com/api/modules/server#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

| Name | Type |
| :- | :- |
| `Measures` | extends [`AggregateMeasures`](https://docs.bijection.com/api/modules/server#aggregatemeasures)\<`TableInfo`> |
| `By` | extends `undefined` \| readonly [`DocumentFields`](https://docs.bijection.com/api/modules/server#documentfields)\<[`DocumentByInfo`](https://docs.bijection.com/api/modules/server#documentbyinfo)\<`TableInfo`>>\[] = `undefined` |

#### Parameters

| Name | Type |
| :- | :- |
| `measures` | `Measures` |
| `options?` | `TableInfo` extends \{ `nativeSeries`: `true`  } ? `never` : \{ `by`: `By`  } |

#### Returns

[`AggregateResult`](https://docs.bijection.com/api/modules/server#aggregateresult)\<`TableInfo`, `Measures`, `By`>

#### Inherited from

Omit.aggregate

***

### readPage

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

Read one bounded traversal step. This does not register a reactive
page boundary; ordinary read dependencies and current access still apply.

#### Parameters

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

#### Returns

`Promise`\<[`QueryReadPage`](https://docs.bijection.com/api/modules/server#queryreadpage)\<[`DocumentByInfo`](https://docs.bijection.com/api/modules/server#documentbyinfo)\<`TableInfo`>>>

#### Inherited from

Omit.readPage

***

### select

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

See [select](https://docs.bijection.com/api/interfaces/server.SelectableOrderedQuery.md#select).

#### Type parameters

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

#### Parameters

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

#### Returns

[`ProjectedQuery`](https://docs.bijection.com/api/interfaces/server.ProjectedQuery)\<`TableInfo`, `Fields`, `"strict"`>

#### Inherited from

Omit.select

***

### selectCells

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

See [selectCells](https://docs.bijection.com/api/interfaces/server.SelectableOrderedQuery.md#selectcells).

#### Type parameters

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

#### Parameters

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

#### Returns

[`ProjectedQuery`](https://docs.bijection.com/api/interfaces/server.ProjectedQuery)\<`TableInfo`, `Fields`, `"visible"`>

#### Inherited from

Omit.selectCells

***

### withBudget

▸ **withBudget**(`budget`): [`SelectableQuery`](https://docs.bijection.com/api/interfaces/server.SelectableQuery)\<`TableInfo`>

#### Parameters

| Name | Type |
| :- | :- |
| `budget` | [`ReadBudget`](https://docs.bijection.com/api/modules/server#readbudget) |

#### Returns

[`SelectableQuery`](https://docs.bijection.com/api/interfaces/server.SelectableQuery)\<`TableInfo`>

#### Inherited from

Omit.withBudget

***

### collectWithDiagnostics

▸ **collectWithDiagnostics**(): `Promise`\<[`ReadReport`](https://docs.bijection.com/api/modules/server#readreport)\<[`DocumentByInfo`](https://docs.bijection.com/api/modules/server#documentbyinfo)\<`TableInfo`>, [`ReadUsage`](https://docs.bijection.com/api/modules/server#readusage)>>

#### Returns

`Promise`\<[`ReadReport`](https://docs.bijection.com/api/modules/server#readreport)\<[`DocumentByInfo`](https://docs.bijection.com/api/modules/server#documentbyinfo)\<`TableInfo`>, [`ReadUsage`](https://docs.bijection.com/api/modules/server#readusage)>>

#### Inherited from

Omit.collectWithDiagnostics

***

### takeWithDiagnostics

▸ **takeWithDiagnostics**(`n`): `Promise`\<[`ReadReport`](https://docs.bijection.com/api/modules/server#readreport)\<[`DocumentByInfo`](https://docs.bijection.com/api/modules/server#documentbyinfo)\<`TableInfo`>, [`ReadUsage`](https://docs.bijection.com/api/modules/server#readusage)>>

#### Parameters

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

#### Returns

`Promise`\<[`ReadReport`](https://docs.bijection.com/api/modules/server#readreport)\<[`DocumentByInfo`](https://docs.bijection.com/api/modules/server#documentbyinfo)\<`TableInfo`>, [`ReadUsage`](https://docs.bijection.com/api/modules/server#readusage)>>

#### Inherited from

Omit.takeWithDiagnostics

***

### filter

▸ **filter**(`predicate`): [`PopulationQueryInitializer`](https://docs.bijection.com/api/interfaces/server.PopulationQueryInitializer)\<`TableInfo`> & \{ `visible`: `never` ; `complete`: `never` ; `withAccessPath`: `never`  }

#### Parameters

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

#### Returns

[`PopulationQueryInitializer`](https://docs.bijection.com/api/interfaces/server.PopulationQueryInitializer)\<`TableInfo`> & \{ `visible`: `never` ; `complete`: `never` ; `withAccessPath`: `never`  }

#### Inherited from

Omit.filter

***

### order

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

#### Parameters

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

#### Returns

[`SelectableOrderedQuery`](https://docs.bijection.com/api/interfaces/server.SelectableOrderedQuery)\<`TableInfo`>

#### Inherited from

Omit.order

***

### fullTableScan

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

#### Returns

[`SelectableQuery`](https://docs.bijection.com/api/interfaces/server.SelectableQuery)\<`TableInfo`>

#### Inherited from

Omit.fullTableScan

***

### withSpatialIndex

▸ **withSpatialIndex**\<`Name`, `Range`>(`indexName`, `range`): [`SpatialIndexQuery`](https://docs.bijection.com/api/modules/server#spatialindexquery)\<`TableInfo`, `Name`, `Range`>

Read a spatial index: any equality prefix, or a complete partition
optionally restricted by one spatial operation.

#### Type parameters

| Name | Type |
| :- | :- |
| `Name` | extends [`SpatialIndexNames`](https://docs.bijection.com/api/modules/server#spatialindexnames)\<`TableInfo`> |
| `Range` | extends [`SpatialRange`](https://docs.bijection.com/api/classes/server.SpatialRange) |

#### Parameters

| Name | Type |
| :- | :- |
| `indexName` | `Name` |
| `range` | (`q`: [`SpatialRangeBuilder`](https://docs.bijection.com/api/modules/server#spatialrangebuilder)\<[`DocumentByInfo`](https://docs.bijection.com/api/modules/server#documentbyinfo)\<`TableInfo`>, [`SpatialPartitions`](https://docs.bijection.com/api/modules/server#spatialpartitions)\<[`NamedIndex`](https://docs.bijection.com/api/modules/server#namedindex)\<`TableInfo`, `Name`>>, [`SpatialIndexField`](https://docs.bijection.com/api/modules/server#spatialindexfield)\<[`NamedIndex`](https://docs.bijection.com/api/modules/server#namedindex)\<`TableInfo`, `Name`>>>) => `Range` |

#### Returns

[`SpatialIndexQuery`](https://docs.bijection.com/api/modules/server#spatialindexquery)\<`TableInfo`, `Name`, `Range`>

#### Inherited from

Omit.withSpatialIndex

▸ **withSpatialIndex**\<`Name`>(`indexName`): [`SpatialIndexQuery`](https://docs.bijection.com/api/modules/server#spatialindexquery)\<`TableInfo`, `Name`, [`SpatialRangeBuilder`](https://docs.bijection.com/api/modules/server#spatialrangebuilder)\<[`DocumentByInfo`](https://docs.bijection.com/api/modules/server#documentbyinfo)\<`TableInfo`>, [`SpatialPartitions`](https://docs.bijection.com/api/modules/server#spatialpartitions)\<[`NamedIndex`](https://docs.bijection.com/api/modules/server#namedindex)\<`TableInfo`, `Name`>>, [`SpatialIndexField`](https://docs.bijection.com/api/modules/server#spatialindexfield)\<[`NamedIndex`](https://docs.bijection.com/api/modules/server#namedindex)\<`TableInfo`, `Name`>>>>

#### Type parameters

| Name | Type |
| :- | :- |
| `Name` | extends [`SpatialIndexNames`](https://docs.bijection.com/api/modules/server#spatialindexnames)\<`TableInfo`> |

#### Parameters

| Name | Type |
| :- | :- |
| `indexName` | `Name` |

#### Returns

[`SpatialIndexQuery`](https://docs.bijection.com/api/modules/server#spatialindexquery)\<`TableInfo`, `Name`, [`SpatialRangeBuilder`](https://docs.bijection.com/api/modules/server#spatialrangebuilder)\<[`DocumentByInfo`](https://docs.bijection.com/api/modules/server#documentbyinfo)\<`TableInfo`>, [`SpatialPartitions`](https://docs.bijection.com/api/modules/server#spatialpartitions)\<[`NamedIndex`](https://docs.bijection.com/api/modules/server#namedindex)\<`TableInfo`, `Name`>>, [`SpatialIndexField`](https://docs.bijection.com/api/modules/server#spatialindexfield)\<[`NamedIndex`](https://docs.bijection.com/api/modules/server#namedindex)\<`TableInfo`, `Name`>>>>

#### Inherited from

Omit.withSpatialIndex

***

### withIndex

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

#### Type parameters

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

#### Parameters

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

#### Returns

[`SelectableQuery`](https://docs.bijection.com/api/interfaces/server.SelectableQuery)\<`TableInfo`>

#### Inherited from

Omit.withIndex

***

### withSearchIndex

▸ **withSearchIndex**\<`IndexName`>(`indexName`, `searchFilter`): [`SelectableOrderedQuery`](https://docs.bijection.com/api/interfaces/server.SelectableOrderedQuery)\<`TableInfo`>

#### Type parameters

| Name | Type |
| :- | :- |
| `IndexName` | extends [`SearchIndexNames`](https://docs.bijection.com/api/modules/server#searchindexnames)\<`TableInfo`> |

#### Parameters

| Name | Type |
| :- | :- |
| `indexName` | `IndexName` |
| `searchFilter` | (`q`: [`SearchFilterBuilder`](https://docs.bijection.com/api/interfaces/server.SearchFilterBuilder)\<[`DocumentByInfo`](https://docs.bijection.com/api/modules/server#documentbyinfo)\<`TableInfo`>, [`NamedSearchIndex`](https://docs.bijection.com/api/modules/server#namedsearchindex)\<`TableInfo`, `IndexName`>>) => [`SearchFilter`](https://docs.bijection.com/api/classes/server.SearchFilter) |

#### Returns

[`SelectableOrderedQuery`](https://docs.bijection.com/api/interfaces/server.SelectableOrderedQuery)\<`TableInfo`>

#### Inherited from

Omit.withSearchIndex

***

### require

▸ **require**(`requirement`): [`CompleteQueryInitializer`](https://docs.bijection.com/api/interfaces/server.CompleteQueryInitializer)\<`TableInfo`>

#### Parameters

| Name | Type |
| :- | :- |
| `requirement` | [`SourceReadRequirement`](https://docs.bijection.com/api/modules/server#sourcereadrequirement) |

#### Returns

[`CompleteQueryInitializer`](https://docs.bijection.com/api/interfaces/server.CompleteQueryInitializer)\<`TableInfo`>

***

### \[asyncIterator]

▸ **\[asyncIterator]**(): `AsyncIterator`\<[`DocumentByInfo`](https://docs.bijection.com/api/modules/server#documentbyinfo)\<`TableInfo`>, `any`, `any`>

#### Returns

`AsyncIterator`\<[`DocumentByInfo`](https://docs.bijection.com/api/modules/server#documentbyinfo)\<`TableInfo`>, `any`, `any`>

#### Inherited from

Omit.\[asyncIterator]


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