Files
lancedb/docs/src/js/interfaces/OpenTableOptions.md
Will Jones 3d1f102087 feat: allow Python and Typescript users to create Sessions (#2530)
## Summary
- Exposes `Session` in Python and Typescript so users can set the
`index_cache_size_bytes` and `metadata_cache_size_bytes`
* The `Session` is attached to the `Connection`, and thus shared across
all tables in that connection.
- Adds deprecation warnings for table-level cache configuration


🤖 Generated with [Claude Code](https://claude.ai/code)

---------

Co-authored-by: Claude <noreply@anthropic.com>
2025-07-24 12:06:29 -07:00

1.1 KiB

@lancedb/lancedbDocs


@lancedb/lancedb / OpenTableOptions

Interface: OpenTableOptions

Properties

indexCacheSize?

optional indexCacheSize: number;

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

Deprecated

Use session-level cache configuration instead. Create a Session with custom cache sizes and pass it to the connect() function.

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/