Class: TableDefinition<DocumentType, Indexes, SearchIndexes, VectorIndexes>
server.TableDefinition
The definition of a table within a schema.
This should be produced by using defineTable.
Type parameters
Name | Type |
---|---|
DocumentType | extends Validator <any , any , any > = Validator <any , any , any > |
Indexes | extends GenericTableIndexes = |
SearchIndexes | extends GenericTableSearchIndexes = |
VectorIndexes | extends GenericTableVectorIndexes = |
Properties
validator
• validator: DocumentType
Defined in
Methods
index
▸ index<IndexName
, FirstFieldPath
, RestFieldPaths
>(name
, fields
): TableDefinition
<DocumentType
, Expand
<Indexes
& Record
<IndexName
, [FirstFieldPath
, ...RestFieldPaths[], "_creationTime"
]>>, SearchIndexes
, VectorIndexes
>
Define an index on this table.
To learn about indexes, see Defining Indexes.