mirror of https://github.com/lancedb/lancedb.git synced 2026-01-05 11:22:58 +00:00

Files

Ryan Green 3ae90dde80 feat: add new table API to wait for async indexing (#2338 )

* Add new wait_for_index() table operation that polls until indices are
created/fully indexed
* Add an optional wait timeout parameter to all create_index operations
* Python and NodeJS interfaces

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

## Summary by CodeRabbit

- **New Features**
- Added optional waiting for index creation completion with configurable
timeout.
- Introduced methods to poll and wait for indices to be fully built
across sync and async tables.
  - Extended index creation APIs to accept a wait timeout parameter.
- **Bug Fixes**
- Added a new timeout error variant for improved error reporting on
index operations.
- **Tests**
- Added tests covering successful index readiness waiting, timeout
scenarios, and missing index cases.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

2025-04-21 08:41:21 -02:30

934 B

Raw Blame History

@lancedb/lancedb • Docs

@lancedb/lancedb / IndexOptions

Interface: IndexOptions

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.

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

waitTimeoutSeconds?

optional waitTimeoutSeconds: number;

934 B Raw Blame History