rust/lancedb
1
0
Fork 0
mirror of https://github.com/lancedb/lancedb.git synced 2025-12-26 14:49:57 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
42e8451484aedbf3d664fe50da4df38ea841b2da
lancedb/docs/src/js/interfaces/OpenTableOptions.md
Will Jones e05c0cd87e ci(node): check docs in CI (#2084) 
* Make `npm run docs` fail if there are any warnings. This will catch
items missing from the API reference.
* Add a check in our CI to make sure `npm run dos` runs without warnings
and doesn't generate any new files (indicating it might be out-of-date.
* Hide constructors that aren't user facing.
* Remove unused enum `WriteMode`.

Closes #2068
2025-01-30 16:06:06 -08:00

928 B
Raw Blame History

@lancedb/lancedb • Docs

@lancedb/lancedb / OpenTableOptions

Interface: OpenTableOptions

Properties

indexCacheSize?

optional indexCacheSize: number;

Set the size of the index cache, specified as a number of entries

The exact meaning of an "entry" will depend on the type of index:

  • IVF: there is one entry for each IVF partition
  • BTREE: there is one entry for the entire index

This cache applies to the entire opened table, across all indices. Setting this value higher will increase performance on larger datasets at the expense of more RAM

storageOptions?

optional storageOptions: Record<string, string>;

Configuration for object storage.

Options already set on the connection will be inherited by the table, but can be overridden here.

The available options are described at https://lancedb.github.io/lancedb/guides/storage/