mirror of
https://github.com/lancedb/lancedb.git
synced 2026-01-17 09:12:58 +00:00
db125013fc
* 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.
43 lines
528 B
Markdown
43 lines
528 B
Markdown
[**@lancedb/lancedb**](../README.md) • **Docs**
|
|
|
|
***
|
|
|
|
[@lancedb/lancedb](../globals.md) / IndexConfig
|
|
|
|
# Interface: IndexConfig
|
|
|
|
A description of an index currently configured on a column
|
|
|
|
## Properties
|
|
|
|
### columns
|
|
|
|
```ts
|
|
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
|
|
|
|
```ts
|
|
indexType: string;
|
|
```
|
|
|
|
The type of the index
|
|
|
|
***
|
|
|
|
### name
|
|
|
|
```ts
|
|
name: string;
|
|
```
|
|
|
|
The name of the index
|