mirror of
https://github.com/lancedb/lancedb.git
synced 2026-03-29 03:50:39 +00:00
fa1b04f341
This PR migrates all Rust crates in the workspace to Rust 2024 edition and addresses the resulting compatibility updates. It also fixes all clippy warnings surfaced by the workspace checks so the codebase remains warning-free under the current lint configuration. Context: - Scope: workspace edition bump (`2021` -> `2024`) plus follow-up refactors required by new edition and clippy rules. - Validation: `cargo fmt --all` and `cargo clippy --quiet --features remote --tests --examples -- -D warnings` both pass.
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]
|
|
#[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()
|
|
)
|
|
}
|
|
}
|