Files
lancedb/docs/src/js/interfaces/IndexOptions.md
Weston Pace 67f041be91 docs: add a reference to @lancedb/lance in the docs (#1166)
We aren't yet ready to switch over the examples since almost all JS
examples rely on embeddings and we haven't yet ported those over.
However, this makes it possible for those that are interested to start
using `@lancedb/lancedb`
2024-03-29 04:55:03 -07:00

1.2 KiB

@lancedb/lancedb / Exports / IndexOptions

Interface: IndexOptions

Table of contents

Properties

Properties

config

Optional config: Index

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.

Defined in

indices.ts:192


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

Defined in

indices.ts:202