lance-format / lance-format/lance

Slice 7: Deprecate .inner + explicit as_upstream_object_store() escape hatch

Open
#7,338 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Rust
Stars
7.1k
Forks
852
Avg merge
3d 18h
Merged PRs (30d)
272

Description

Parent PRD

#7331

What to build

Mark ObjectStore::inner #[deprecated] once common internal call sites have Lance-method alternatives, and add an explicitly named upstream-interop accessor (e.g. as_upstream_object_store()) for the remaining legitimate compatibility uses. The field stays public until the next breaking API window (Phase 6, deferred).

Deprecation note should point users to Lance methods or the explicit escape hatch:

#[deprecated(
    note = "use Lance ObjectStore methods instead; direct upstream object_store access bypasses Lance I/O wrappers"
)]
pub inner: Arc<dyn object_store::ObjectStore>,

Acceptance criteria

  • inner annotated #[deprecated] with a message pointing to Lance methods / the escape hatch
  • as_upstream_object_store() (or agreed name per Open Q3) added for explicit interop
  • Workspace builds with no internal #[deprecated] warnings (remaining uses go through the escape hatch and are documented as compatibility)
  • Parent .inner tracker reflects the final set of intentional remaining uses
  • Open Question 3 resolved and recorded

Blocked by

  • Blocked by #7334
  • Blocked by #7335

Design sections addressed

  • Phase 5 (Deprecate .inner); Open Question 3

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with parent issue #7331 and the blocked work in #7334 and #7335, then locate ObjectStore::inner and its internal call sites. Done means the field is deprecated, explicit upstream interop is available, internal warnings are gone, intentional uses are documented in the parent tracker, and Open Question 3 is recorded as resolved.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
backend-api-design
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.