Skip to content

@lancedb/lancedb • Docs

@lancedb/lancedb / Session

Class: Session

A session for managing caches and object stores across LanceDB operations.

Sessions allow you to configure cache sizes for index and metadata caches, which can significantly impact performance for large datasets.

Constructors

new Session()

new Session(indexCacheSizeBytes?, metadataCacheSizeBytes?): Session

Create a new session with custom cache sizes.

Parameters

  • index_cache_size_bytes: The size of the index cache in bytes. Defaults to 6GB if not specified.
  • metadata_cache_size_bytes: The size of the metadata cache in bytes. Defaults to 1GB if not specified.

Parameters

  • indexCacheSizeBytes?: null | bigint

  • metadataCacheSizeBytes?: null | bigint

Returns

Session

Methods

approxNumItems()

approxNumItems(): number

Get the approximate number of items cached in the session.

Returns

number

sizeBytes()

sizeBytes(): bigint

Get the current size of the session caches in bytes.

Returns

bigint

default()

static default(): Session

Create a session with default cache sizes.

This is equivalent to creating a session with 6GB index cache and 1GB metadata cache.

Returns

Session