Class: TableDefinition<DocumentType, Indexes, SearchIndexes, VectorIndexes, IsSource, Relations>

browser.TableDefinition Not exported: an exported type refers to it.

Type parameters

Name	Type
`DocumentType`	extends `Validator`<`any`, `any`, `any`> = `Validator`<`any`, `any`, `any`>
`Indexes`	extends `GenericTableIndexes` = {}
`SearchIndexes`	extends `GenericTableSearchIndexes` = {}
`VectorIndexes`	extends `GenericTableVectorIndexes` = {}
`IsSource`	extends `boolean` = `false`
`Relations`	extends `DeclaredRelations` = {}

Hierarchy

TableDefinition ↳ ViewDefinition

Constructors

constructor

• new TableDefinition<DocumentType, Indexes, SearchIndexes, VectorIndexes, IsSource, Relations>(documentType)

Type parameters

Name	Type
`DocumentType`	extends `Validator`<`any`, `any`, `any`> = `Validator`<`any`, `any`, `any`>
`Indexes`	extends `GenericTableIndexes` = {}
`SearchIndexes`	extends `GenericTableSearchIndexes` = {}
`VectorIndexes`	extends `GenericTableVectorIndexes` = {}
`IsSource`	extends `boolean` = `false`
`Relations`	extends `DeclaredRelations` = {}

Parameters

Name	Type
`documentType`	`DocumentType`

Properties

isSource

• Readonly isSource: IsSource

relations

• Readonly relations: Relations

declared

• Private declared: TableExtensions

indexes

• Private indexes: Index[]

stagedDbIndexes

• Private stagedDbIndexes: Index[]

searchIndexes

• Private searchIndexes: SearchIndex[]

stagedSearchIndexes

• Private stagedSearchIndexes: SearchIndex[]

vectorIndexes

• Private vectorIndexes: VectorIndex[]

stagedVectorIndexes

• Private stagedVectorIndexes: VectorIndex[]

validator

• validator: DocumentType

stagedValidator

• Private stagedValidator: undefined | Validator<any, any, any>

Methods

access

▸ access(definition): TableDefinition<DocumentType, Indexes, SearchIndexes, VectorIndexes, IsSource, Relations>

Parameters

Name	Type
`definition`	`ReadAccess`

Returns

TableDefinition<DocumentType, Indexes, SearchIndexes, VectorIndexes, IsSource, Relations> ▸ access(definition): TableDefinition<DocumentType, Indexes, SearchIndexes, VectorIndexes, IsSource, Relations>

Parameters

Name	Type
`definition`	`Members`

Returns

TableDefinition<DocumentType, Indexes, SearchIndexes, VectorIndexes, IsSource, Relations> ▸ access<R, B>(definition, ...binding): TableDefinition<DocumentType, Indexes, SearchIndexes, VectorIndexes, IsSource, Relations> & AccessTableBinding<R, B>

Type parameters

Name	Type
`R`	extends `AccessResource`<`undefined` \| `string`, `string`, `string`, `ResourceAccessModelDefinition`, `R`>
`B`	extends `object` = {}

Parameters

Name	Type
`definition`	`R`
`...binding`	`R` extends `AccessResource`<`string`, `string`, `string`, `ResourceAccessModelDefinition`> ? [options: AccessResourceBinding<Extract<keyof DocumentType[“type”], string>, R extends AccessResource<any, P, string, ResourceAccessModelDefinition> ? P : never> & B & Object & Object] : [options?: AccessResourceBinding<Extract<keyof DocumentType[“type”], string>, R extends AccessResource<any, P, string, ResourceAccessModelDefinition> ? P : never> & B & Object]

Returns

TableDefinition<DocumentType, Indexes, SearchIndexes, VectorIndexes, IsSource, Relations> & AccessTableBinding<R, B>

input

▸ input(...limits): TableInput<DocumentType>

Parameters

Name	Type
`...limits`	`TableInputArgs`<`DocumentType`>

Returns

TableInput<DocumentType>

resourceRequests

▸ resourceRequests(options): TableDefinition<DocumentType, Indexes, SearchIndexes, VectorIndexes, IsSource, Relations>

Parameters

Name	Type
`options`	`Object`
`options.grants`	`string`
`options.expire`	`FunctionReference`<`"mutation"`, `"internal"`, { `id`: `Id`<`string`> }>

Returns

TableDefinition<DocumentType, Indexes, SearchIndexes, VectorIndexes, IsSource, Relations>

retain

▸ retain(options): TableDefinition<DocumentType, Indexes, SearchIndexes, VectorIndexes, IsSource, Relations>

Parameters

Name	Type
`options`	`Object`
`options.by`	`string` \| `string`[]
`options.keys?`	`"registered"` \| `"derived"`

Returns

TableDefinition<DocumentType, Indexes, SearchIndexes, VectorIndexes, IsSource, Relations>

erasable

▸ erasable(): TableDefinition<DocumentType, Indexes, SearchIndexes, VectorIndexes, IsSource, Relations>

Returns

TableDefinition<DocumentType, Indexes, SearchIndexes, VectorIndexes, IsSource, Relations>

aggregate

▸ aggregate(name, options): TableDefinition<DocumentType, Indexes, SearchIndexes, VectorIndexes, IsSource, Relations>

Parameters

Name	Type
`name`	`string`
`options`	`Object`
`options.by`	`string`[]
`options.sum?`	`string`[]
`options.decimal?`	`Record`<`string`, `number`>
`options.time?`	`Object`
`options.time.field`	`string`
`options.time.unit`	`"minute"` \| `"hour"` \| `"day"` \| `"week"` \| `"month"` \| `"second"`
`options.visibility?`	`"collectionReaders"`

Returns

TableDefinition<DocumentType, Indexes, SearchIndexes, VectorIndexes, IsSource, Relations>

govern

▸ govern(this, definition): TableDefinition<DocumentType, Indexes, SearchIndexes, VectorIndexes, IsSource, Relations>

Parameters

Name	Type
`this`	`GovernableTable`<`IsSource`, `TableDefinition`<`DocumentType`, `Indexes`, `SearchIndexes`, `VectorIndexes`, `IsSource`, `Relations`>>
`definition`	`GoverningDefinition`<`Expand`<`SystemFields` & `DocumentType`[`"type"`]> & { `_id`: `Id`<`string`> }>

Returns

TableDefinition<DocumentType, Indexes, SearchIndexes, VectorIndexes, IsSource, Relations>

link

▸ link<Fields, Names>(this, endpoints, names?): TableDefinition<DocumentType, Indexes, SearchIndexes, VectorIndexes, IsSource, Relations & LinkRelations<DocumentType, Fields, Names>>

Type parameters

Name	Type
`Fields`	extends `never`
`Names`	extends `Partial`<`Record`<`Fields`, `LinkEndpointNames`>> = {}

Parameters

Name	Type
`this`	`LinkableTable`<`DocumentType`, `IsSource`, `TableDefinition`<`DocumentType`, `Indexes`, `SearchIndexes`, `VectorIndexes`, `IsSource`, `Relations`>>
`endpoints`	`Record`<`Fields`, `Cardinality`>
`names?`	`Names`

Returns

TableDefinition<DocumentType, Indexes, SearchIndexes, VectorIndexes, IsSource, Relations & LinkRelations<DocumentType, Fields, Names>>

reference

▸ reference<Field, Options>(this, field, options?): TableDefinition<DocumentType, Indexes, SearchIndexes, VectorIndexes, IsSource, Relations & ReferenceRelation<DocumentType, Field, Options>>

Type parameters

Name	Type
`Field`	extends `never`
`Options`	extends `ReferenceOptions` = {}

Parameters

Name	Type
`this`	`TableDefinition`<`DocumentType`, `Indexes`, `SearchIndexes`, `VectorIndexes`, `IsSource`, `Relations`>
`field`	`Field`
`options?`	`Options`

Returns

TableDefinition<DocumentType, Indexes, SearchIndexes, VectorIndexes, IsSource, Relations & ReferenceRelation<DocumentType, Field, Options>>

source

▸ source<S>(this, handle): TableDefinition<SourceDocumentType<DocumentType>, Indexes, SearchIndexes, VectorIndexes, true, Relations>

Type parameters

Name	Type
`S`	extends `Record`<`string`, `GenericValidator`>

Parameters

Name	Type
`this`	`TableDefinition`<`DocumentType`, `Indexes`, `SearchIndexes`, `VectorIndexes`, `IsSource`, `Relations`>
`handle`	`SourceHandle`<`S`> & [`DocumentType`[`"type"`]] extends [`Expand`<{ [Property in string \| number \| symbol]?: Exclude<Infer<S[Property]>, undefined> } & { [Property in string \| number \| symbol]: Infer<S[Property]> }>] ? [`Expand`<{ [Property in string \| number \| symbol]?: Exclude<Infer<S[Property]>, undefined> } & { [Property in string \| number \| symbol]: Infer<S[Property]> }>] extends [`any`[`any`]] ? `unknown` : `never` : `never`

Returns

TableDefinition<SourceDocumentType<DocumentType>, Indexes, SearchIndexes, VectorIndexes, true, Relations>

isLocalRetained

▸ ** isLocalRetained**(): boolean

Returns

boolean

isLocal

▸ ** isLocal**(): boolean

Returns

boolean

indexes

▸ ** indexes**(): { indexDescriptor: string ; fields: string[] }[]

Returns

{ indexDescriptor: string ; fields: string[] }[]

index

▸ index<IndexName, FirstFieldPath, RestFieldPaths>(name, indexConfig): TableDefinition<DocumentType, Expand<Indexes & Record<IndexName, [FirstFieldPath, …RestFieldPaths[], "_creationTime"]>>, SearchIndexes, VectorIndexes, IsSource, Relations>

Type parameters

Name	Type
`IndexName`	extends `string`
`FirstFieldPath`	extends `any`
`RestFieldPaths`	extends `ExtractFieldPaths`<`DocumentType`>[]

Parameters

Name	Type
`name`	`IndexName`
`indexConfig`	`Object`
`indexConfig.fields`	[`FirstFieldPath`, …RestFieldPaths[]]
`indexConfig.staged?`	`false`

Returns

TableDefinition<DocumentType, Expand<Indexes & Record<IndexName, [FirstFieldPath, …RestFieldPaths[], "_creationTime"]>>, SearchIndexes, VectorIndexes, IsSource, Relations> ▸ index<IndexName, FirstFieldPath, RestFieldPaths>(name, fields): TableDefinition<DocumentType, Expand<Indexes & Record<IndexName, [FirstFieldPath, …RestFieldPaths[], "_creationTime"]>>, SearchIndexes, VectorIndexes, IsSource, Relations>

Type parameters

Name	Type
`IndexName`	extends `string`
`FirstFieldPath`	extends `any`
`RestFieldPaths`	extends `ExtractFieldPaths`<`DocumentType`>[]

Parameters

Name	Type
`name`	`IndexName`
`fields`	[`FirstFieldPath`, …RestFieldPaths[]]

Returns

TableDefinition<DocumentType, Expand<Indexes & Record<IndexName, [FirstFieldPath, …RestFieldPaths[], "_creationTime"]>>, SearchIndexes, VectorIndexes, IsSource, Relations> ▸ index<IndexName, FirstFieldPath, RestFieldPaths>(name, indexConfig): TableDefinition<DocumentType, Indexes, SearchIndexes, VectorIndexes, IsSource, Relations>

Type parameters

Name	Type
`IndexName`	extends `string`
`FirstFieldPath`	extends `any`
`RestFieldPaths`	extends `ExtractFieldPaths`<`DocumentType`>[]

Parameters

Name	Type
`name`	`IndexName`
`indexConfig`	`Object`
`indexConfig.fields`	[`FirstFieldPath`, …RestFieldPaths[]]
`indexConfig.staged`	`true`

Returns

TableDefinition<DocumentType, Indexes, SearchIndexes, VectorIndexes, IsSource, Relations>

searchIndex

▸ searchIndex<IndexName, SearchField, FilterFields>(name, indexConfig): TableDefinition<DocumentType, Indexes, Expand<SearchIndexes & Record<IndexName, { searchField: SearchField ; filterFields: FilterFields }>>, VectorIndexes, IsSource, Relations>

Type parameters

Name	Type
`IndexName`	extends `string`
`SearchField`	extends `any`
`FilterFields`	extends `any` = `never`

Parameters

Name	Type
`name`	`IndexName`
`indexConfig`	`Object`
`indexConfig.searchField`	`SearchField`
`indexConfig.filterFields?`	`FilterFields`[]
`indexConfig.staged?`	`false`

Returns

TableDefinition<DocumentType, Indexes, Expand<SearchIndexes & Record<IndexName, { searchField: SearchField ; filterFields: FilterFields }>>, VectorIndexes, IsSource, Relations> ▸ searchIndex<IndexName, SearchField, FilterFields>(name, indexConfig): TableDefinition<DocumentType, Indexes, SearchIndexes, VectorIndexes, IsSource, Relations>

Type parameters

Name	Type
`IndexName`	extends `string`
`SearchField`	extends `any`
`FilterFields`	extends `any` = `never`

Parameters

Name	Type
`name`	`IndexName`
`indexConfig`	`Object`
`indexConfig.searchField`	`SearchField`
`indexConfig.filterFields?`	`FilterFields`[]
`indexConfig.staged`	`true`

Returns

TableDefinition<DocumentType, Indexes, SearchIndexes, VectorIndexes, IsSource, Relations>

vectorIndex

▸ vectorIndex<IndexName, VectorField, FilterFields>(name, indexConfig): TableDefinition<DocumentType, Indexes, SearchIndexes, Expand<VectorIndexes & Record<IndexName, { vectorField: VectorField ; dimensions: number ; filterFields: FilterFields }>>, IsSource, Relations>

Type parameters

Name	Type
`IndexName`	extends `string`
`VectorField`	extends `any`
`FilterFields`	extends `any` = `never`

Parameters

Name	Type
`name`	`IndexName`
`indexConfig`	`Object`
`indexConfig.vectorField`	`VectorField`
`indexConfig.dimensions`	`number`
`indexConfig.filterFields?`	`FilterFields`[]
`indexConfig.staged?`	`false`

Returns

TableDefinition<DocumentType, Indexes, SearchIndexes, Expand<VectorIndexes & Record<IndexName, { vectorField: VectorField ; dimensions: number ; filterFields: FilterFields }>>, IsSource, Relations> ▸ vectorIndex<IndexName, VectorField, FilterFields>(name, indexConfig): TableDefinition<DocumentType, Indexes, SearchIndexes, VectorIndexes, IsSource, Relations>

Type parameters

Name	Type
`IndexName`	extends `string`
`VectorField`	extends `any`
`FilterFields`	extends `any` = `never`

Parameters

Name	Type
`name`	`IndexName`
`indexConfig`	`Object`
`indexConfig.vectorField`	`VectorField`
`indexConfig.dimensions`	`number`
`indexConfig.filterFields?`	`FilterFields`[]
`indexConfig.staged`	`true`

Returns

TableDefinition<DocumentType, Indexes, SearchIndexes, VectorIndexes, IsSource, Relations>

staged

▸ staged(documentSchema): TableDefinition<DocumentType, Indexes, SearchIndexes, VectorIndexes, IsSource, Relations>

Parameters

Name	Type
`documentSchema`	`Record`<`string`, `GenericValidator`> \| `Validator`<`Record`<`string`, `any`>, `"required"`, `any`>

Returns

TableDefinition<DocumentType, Indexes, SearchIndexes, VectorIndexes, IsSource, Relations>

self

▸ Protected self(): TableDefinition<DocumentType, Indexes, SearchIndexes, VectorIndexes, IsSource, Relations>

Returns

TableDefinition<DocumentType, Indexes, SearchIndexes, VectorIndexes, IsSource, Relations>

[accessStorage]

▸ [accessStorage](): Object

Returns

Object

Name	Type
`indexes`	`Index`[]
`erasable`	`boolean`

export

▸ export(): Object

Returns

Object

Name	Type
`fileFields`	(`null` \| `string`)[][]
`discovery?`	`string`
`indexes`	{ `indexDescriptor`: `string` ; `fields`: `string`[] }[]
`stagedDbIndexes`	`Index`[]
`searchIndexes`	`SearchIndex`[]
`stagedSearchIndexes`	`SearchIndex`[]
`vectorIndexes`	`VectorIndex`[]
`stagedVectorIndexes`	`VectorIndex`[]
`documentType`	`ValidatorJSON`
`stagedDocumentType`	`undefined` \| `ValidatorJSON`
`access?`	`SerializedReadAccess`
`governingRule?`	`SerializedGoverningRule`
`source?`	`SourceBinding`
`link?`	`LinkDefinition`
`references?`	`Record`<`string`, `SerializedReference`>
`retain?`	`SerializedRetainedCustody`
`resourceRequests?`	`SerializedResourceRequests`
`aggregates?`	`Record`<`string`, `SerializedAggregate`>
`erasable?`	`true`

​Type parameters

​Hierarchy

​Constructors

​constructor

​Type parameters

​Parameters

​Properties

​isSource

​relations

​declared

​indexes

​stagedDbIndexes

​searchIndexes

​stagedSearchIndexes

​vectorIndexes

​stagedVectorIndexes

​validator

​stagedValidator

​Methods

​access

​Parameters

​Returns

​Parameters

​Returns

​Type parameters

​Parameters

​Returns

​input

​Parameters

​Returns

​resourceRequests

​Parameters

​Returns

​retain

​Parameters

​Returns

​erasable

​Returns

​aggregate

​Parameters

​Returns

​govern

​Parameters

​Returns

​link

​Type parameters

​Parameters

​Returns

​reference

​Type parameters

​Parameters

​Returns

​source

​Type parameters

​Parameters

​Returns

​isLocalRetained

​Returns

​isLocal

​Returns

​indexes

​Returns

​index

​Type parameters

​Parameters

​Returns

​Type parameters

​Parameters

​Returns

​Type parameters

​Parameters

​Returns

​searchIndex

​Type parameters

​Parameters

​Returns

​Type parameters

​Parameters

​Returns

​vectorIndex

Type parameters

Hierarchy

Constructors

constructor

Type parameters

Parameters

Properties

isSource

relations

declared

indexes

stagedDbIndexes

searchIndexes

stagedSearchIndexes

vectorIndexes

stagedVectorIndexes

validator

stagedValidator

Methods

access

Parameters

Returns

Parameters

Returns

Type parameters

Parameters

Returns

input

Parameters

Returns

resourceRequests

Parameters

Returns

retain

Parameters

Returns

erasable

Returns

aggregate

Parameters

Returns

govern

Parameters

Returns

link

Type parameters

Parameters

Returns

reference

Type parameters

Parameters

Returns

source

Type parameters

Parameters

Returns

isLocalRetained

Returns

isLocal

Returns

indexes

Returns

index

Type parameters

Parameters

Returns

Type parameters

Parameters

Returns

Type parameters

Parameters

Returns

searchIndex

Type parameters

Parameters

Returns

Type parameters

Parameters

Returns

vectorIndex