lance-format/lance

added a `localstore` scheme in `object_store.rs` for testing

Open

#1,376 opened on Oct 10, 2023

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Rust (695 forks)github user discovery
enhancementgood first issuehelp wantedrust

Repository metrics

Stars
 (6,582 stars)
PR merge metrics
 (Avg merge 6d 1h) (219 merged PRs in 30d)

Description

we have a short cut in https://github.com/lancedb/lance/blob/main/rust/lance/src/io/object_store.rs#L607-L615, where we use the FS directly when we detect the file being read is a local file.

However, this makes testing object store behavior hard because we have to setup a object store fixture like localstack in order to test the CloudObjectReader path.

We can add a localstore scheme, where we can exercise object store code path with a local directory

Contributor guide

Research direction
Implement a new URI scheme 'localstore' that uses a local directory but exercises the full object store code path for testing purposes. Modify the object store.rs to add a new scheme that wraps the local filesystem but goes through the CloudObjectReader (or the object store abstraction) to simulate cloud storage behavior. Review the existing shortcut for local files and the CloudObjectReader path to understand how to create a local store scheme that bypasses the direct FS access.
Tech stack
rust
Domain
backend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Rust
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70