mirror of
https://github.com/lancedb/lancedb.git
synced 2026-08-18 03:58:26 +00:00
Xuanwo
920fc0e455
PyO3 defaults native extension classes to `builtins`, so mkdocstrings/Griffe could not resolve the newly documented `lancedb.Session` alias and `Deploy docs to Pages` failed on `main`. Declare the extension module for the public native types referenced by the Python API docs so Griffe resolves them through `lancedb._lancedb` and Pages can build again. Validated with the docs toolchain used by CI (`griffe==0.49.0`, `mkdocstrings==0.25.2`, and `mkdocs==1.6.1`); `PYTHONPATH=. mkdocs build` succeeds.
108 lines
3.2 KiB
Rust
108 lines
3.2 KiB
Rust
// SPDX-License-Identifier: Apache-2.0
|
|
// SPDX-FileCopyrightText: Copyright The LanceDB Authors
|
|
|
|
use std::sync::Arc;
|
|
|
|
use lancedb::{ObjectStoreRegistry, Session as LanceSession};
|
|
use pyo3::{PyResult, pyclass, pymethods};
|
|
|
|
/// 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 memory use and performance. They can
|
|
/// also be re-used across multiple connections to share the same cache state.
|
|
#[pyclass(module = "lancedb._lancedb", from_py_object)]
|
|
#[derive(Clone)]
|
|
pub struct Session {
|
|
pub(crate) inner: Arc<LanceSession>,
|
|
}
|
|
|
|
impl Default for Session {
|
|
fn default() -> Self {
|
|
Self {
|
|
inner: Arc::new(LanceSession::default()),
|
|
}
|
|
}
|
|
}
|
|
|
|
#[pymethods]
|
|
impl Session {
|
|
/// Create a new session with custom cache sizes.
|
|
///
|
|
/// Parameters
|
|
/// ----------
|
|
/// index_cache_size_bytes : int, optional
|
|
/// The size of the index cache in bytes.
|
|
/// Index data is stored in memory in this cache to speed up queries.
|
|
/// Default: 6GB (6 * 1024 * 1024 * 1024 bytes)
|
|
/// metadata_cache_size_bytes : int, optional
|
|
/// The size of the metadata cache in bytes.
|
|
/// The metadata cache stores file metadata and schema information in memory.
|
|
/// This cache improves scan and write performance.
|
|
/// Default: 1GB (1024 * 1024 * 1024 bytes)
|
|
#[new]
|
|
#[pyo3(signature = (index_cache_size_bytes=None, metadata_cache_size_bytes=None))]
|
|
pub fn new(
|
|
index_cache_size_bytes: Option<usize>,
|
|
metadata_cache_size_bytes: Option<usize>,
|
|
) -> PyResult<Self> {
|
|
let index_cache_size = index_cache_size_bytes.unwrap_or(6 * 1024 * 1024 * 1024); // 6GB default
|
|
let metadata_cache_size = metadata_cache_size_bytes.unwrap_or(1024 * 1024 * 1024); // 1GB default
|
|
|
|
let session = LanceSession::new(
|
|
index_cache_size,
|
|
metadata_cache_size,
|
|
Arc::new(ObjectStoreRegistry::default()),
|
|
);
|
|
|
|
Ok(Self {
|
|
inner: Arc::new(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
|
|
/// A new Session with default cache sizes
|
|
#[staticmethod]
|
|
#[allow(clippy::should_implement_trait)]
|
|
pub fn default() -> Self {
|
|
Default::default()
|
|
}
|
|
|
|
/// Get the current size of the session caches in bytes.
|
|
///
|
|
/// Returns
|
|
/// -------
|
|
/// int
|
|
/// The total size of all caches in the session
|
|
#[getter]
|
|
pub fn size_bytes(&self) -> u64 {
|
|
self.inner.size_bytes()
|
|
}
|
|
|
|
/// Get the approximate number of items cached in the session.
|
|
///
|
|
/// Returns
|
|
/// -------
|
|
/// int
|
|
/// The number of cached items across all caches
|
|
#[getter]
|
|
pub fn approx_num_items(&self) -> usize {
|
|
self.inner.approx_num_items()
|
|
}
|
|
|
|
fn __repr__(&self) -> String {
|
|
format!(
|
|
"Session(size_bytes={}, approx_num_items={})",
|
|
self.size_bytes(),
|
|
self.approx_num_items()
|
|
)
|
|
}
|
|
}
|