Files
lancedb/docs/src/js/interfaces/IndexConfig.md
Will Jones db125013fc docs: better formatting for Node API docs (#1892)
* Sets `"useCodeBlocks": true`
* Adds a post-processing script `nodejs/typedoc_post_process.js` that
puts the parameter description on the same line as the parameter name,
like it is in our Python docs. This makes the text hierarchy clearer in
those sections and also makes the sections shorter.
2024-12-09 17:04:09 -08:00

528 B

@lancedb/lancedbDocs


@lancedb/lancedb / IndexConfig

Interface: IndexConfig

A description of an index currently configured on a column

Properties

columns

columns: string[];

The columns in the index

Currently this is always an array of size 1. In the future there may be more columns to represent composite indices.


indexType

indexType: string;

The type of the index


name

name: string;

The name of the index