Files
lancedb/docs/src/js/interfaces/IndexOptions.md
2024-07-22 10:26:49 -07:00

38 lines
877 B
Markdown

[**@lancedb/lancedb**](../README.md) • **Docs**
***
[@lancedb/lancedb](../globals.md) / IndexOptions
# Interface: IndexOptions
## Properties
### config?
> `optional` **config**: [`Index`](../classes/Index.md)
Advanced index configuration
This option allows you to specify a specfic index to create and also
allows you to pass in configuration for training the index.
See the static methods on Index for details on the various index types.
If this is not supplied then column data type(s) and column statistics
will be used to determine the most useful kind of index to create.
***
### replace?
> `optional` **replace**: `boolean`
Whether to replace the existing index
If this is false, and another index already exists on the same columns
and the same name, then an error will be returned. This is true even if
that index is out of date.
The default is true