mirror of
https://github.com/lancedb/lancedb.git
synced 2026-01-08 21:02:58 +00:00
e05c0cd87e
* 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
41 lines
928 B
Markdown
41 lines
928 B
Markdown
[**@lancedb/lancedb**](../README.md) • **Docs**
|
|
|
|
***
|
|
|
|
[@lancedb/lancedb](../globals.md) / OpenTableOptions
|
|
|
|
# Interface: OpenTableOptions
|
|
|
|
## Properties
|
|
|
|
### indexCacheSize?
|
|
|
|
```ts
|
|
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?
|
|
|
|
```ts
|
|
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/
|