Class: TableDefinition<Document, FieldPaths, Indexes, SearchIndexes, VectorIndexes>
server.TableDefinition
The definition of a table within a schema.
This should be produced by using defineTable.
Type parameters
| Name | Type |
|---|---|
Document | extends GenericDocument = GenericDocument |
FieldPaths | extends string = string |
Indexes | extends GenericTableIndexes = |
SearchIndexes | extends GenericTableSearchIndexes = |
VectorIndexes | extends GenericTableVectorIndexes = |
Methods
index
▸ index<IndexName, FirstFieldPath, RestFieldPaths>(name, fields): TableDefinition<Document, FieldPaths, Expand<Indexes & Record<IndexName, [FirstFieldPath, ...RestFieldPaths[], "_creationTime"]>>, SearchIndexes, VectorIndexes>
Define an index on this table.
To learn about indexes, see Defining Indexes.
Type parameters
| Name | Type |
|---|---|
IndexName | extends string |
FirstFieldPath | extends string |
RestFieldPaths | extends FieldPaths[] |
Parameters
| Name | Type | Description |
|---|---|---|
name | IndexName | The name of the index. |
fields | [FirstFieldPath, ...RestFieldPaths[]] | The fields to index, in order. Must specify at least one field. |
Returns
TableDefinition<Document, FieldPaths, Expand<Indexes & Record<IndexName, [FirstFieldPath, ...RestFieldPaths[], "_creationTime"]>>, SearchIndexes, VectorIndexes>
A TableDefinition with this index included.
Defined in
searchIndex
▸ searchIndex<IndexName, SearchField, FilterFields>(name, indexConfig): TableDefinition<Document, FieldPaths, Indexes, Expand<SearchIndexes & Record<IndexName, { searchField: SearchField ; filterFields: FilterFields }>>, VectorIndexes>
Define a search index on this table.
To learn about search indexes, see Search.
Type parameters
| Name | Type |
|---|---|
IndexName | extends string |
SearchField | extends string |
FilterFields | extends string = never |
Parameters
| Name | Type | Description |
|---|---|---|
name | IndexName | The name of the index. |
indexConfig | Object | The search index configuration object. |
indexConfig.searchField | SearchField | The field to index for full text search. This must be a field of type string. |
indexConfig.filterFields? | FilterFields[] | Additional fields to index for fast filtering when running search queries. |
Returns
TableDefinition<Document, FieldPaths, Indexes, Expand<SearchIndexes & Record<IndexName, { searchField: SearchField ; filterFields: FilterFields }>>, VectorIndexes>
A TableDefinition with this search index included.
Defined in
vectorIndex
▸ vectorIndex<IndexName, VectorField, FilterFields>(name, indexConfig): TableDefinition<Document, FieldPaths, Indexes, SearchIndexes, Expand<VectorIndexes & Record<IndexName, { vectorField: VectorField ; dimensions: number ; filterFields: FilterFields }>>>
Define a vector index on this table.
To learn about vector indexes, see Vector Search.
Type parameters
| Name | Type |
|---|---|
IndexName | extends string |
VectorField | extends string |
FilterFields | extends string = never |
Parameters
| Name | Type | Description |
|---|---|---|
name | IndexName | The name of the index. |
indexConfig | Object | The vector index configuration object. |
indexConfig.vectorField | VectorField | The field to index for vector search. This must be a field of type v.array(v.float64()) (or a union) |
indexConfig.dimensions | number | The length of the vectors indexed. This must be between 2 and 2048 inclusive. |
indexConfig.filterFields? | FilterFields[] | Additional fields to index for fast filtering when running vector searches. |
Returns
TableDefinition<Document, FieldPaths, Indexes, SearchIndexes, Expand<VectorIndexes & Record<IndexName, { vectorField: VectorField ; dimensions: number ; filterFields: FilterFields }>>>
A TableDefinition with this vector index included.
Defined in
self
▸ Protected self(): TableDefinition<Document, FieldPaths, Indexes, SearchIndexes, VectorIndexes>
Work around for https://github.com/microsoft/TypeScript/issues/57035
Returns
TableDefinition<Document, FieldPaths, Indexes, SearchIndexes, VectorIndexes>