lance_io/object_store/providers/
memory.rs

1// SPDX-License-Identifier: Apache-2.0
2// SPDX-FileCopyrightText: Copyright The Lance Authors
3
4use std::{collections::HashMap, sync::Arc};
5
6use crate::object_store::{
7    ObjectStore, ObjectStoreParams, ObjectStoreProvider, StorageOptions,
8    DEFAULT_CLOUD_IO_PARALLELISM, DEFAULT_LOCAL_BLOCK_SIZE, DEFAULT_MAX_IOP_SIZE,
9};
10use lance_core::error::Result;
11use object_store::{memory::InMemory, path::Path};
12use url::Url;
13
14/// Provides a fresh in-memory object store for each call to `new_store`.
15#[derive(Default, Debug)]
16pub struct MemoryStoreProvider;
17
18#[async_trait::async_trait]
19impl ObjectStoreProvider for MemoryStoreProvider {
20    async fn new_store(&self, _base_path: Url, params: &ObjectStoreParams) -> Result<ObjectStore> {
21        let block_size = params.block_size.unwrap_or(DEFAULT_LOCAL_BLOCK_SIZE);
22        let storage_options = StorageOptions(params.storage_options.clone().unwrap_or_default());
23        let download_retry_count = storage_options.download_retry_count();
24        Ok(ObjectStore {
25            inner: Arc::new(InMemory::new()),
26            scheme: String::from("memory"),
27            block_size,
28            max_iop_size: *DEFAULT_MAX_IOP_SIZE,
29            use_constant_size_upload_parts: false,
30            list_is_lexically_ordered: true,
31            io_parallelism: DEFAULT_CLOUD_IO_PARALLELISM,
32            download_retry_count,
33            io_tracker: Default::default(),
34        })
35    }
36
37    fn extract_path(&self, url: &Url) -> Result<Path> {
38        let mut output = String::new();
39        if let Some(domain) = url.domain() {
40            output.push_str(domain);
41        }
42        output.push_str(url.path());
43        Ok(Path::from(output))
44    }
45
46    fn calculate_object_store_prefix(
47        &self,
48        _url: &Url,
49        _storage_options: Option<&HashMap<String, String>>,
50    ) -> Result<String> {
51        Ok("memory".to_string())
52    }
53}
54
55#[cfg(test)]
56mod tests {
57    use super::*;
58
59    #[test]
60    fn test_memory_store_path() {
61        let provider = MemoryStoreProvider;
62
63        let url = Url::parse("memory://path/to/file").unwrap();
64        let path = provider.extract_path(&url).unwrap();
65        let expected_path = Path::from("path/to/file");
66        assert_eq!(path, expected_path);
67    }
68
69    #[test]
70    fn test_calculate_object_store_prefix() {
71        let provider = MemoryStoreProvider;
72        assert_eq!(
73            "memory",
74            provider
75                .calculate_object_store_prefix(&Url::parse("memory://etc").unwrap(), None)
76                .unwrap()
77        );
78    }
79}