lance-format / lance-format/lance
New `history()` command to replace `list_versions()`
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 7.1k
- Forks
- 852
- Avg merge
- 3d 18h
- Merged PRs (30d)
- 272
Description
Adding operation information
We have Transaction information, but it's not well surfaced. Along with each version, it would be nice to list the operations performed to produce each version.
Cleanup
When we cleanup versions, it removes them from the list.
Performance
The logic for listing version is:
- Use
CommitHandlerto list the manifests - For each manifest:
- Open it
- Read off the
timestampandmetadatafrom the versions.
If there are a lot of versions, this can be expensive.
API
We would create a new history() command to replace the versions() API that would provide more information about the commits:
def history(
min_version: Optional[int] = None,
created_after: Optional[datetime] = None,
cleaned_up: Optional[bool] = None,
only_tagged: bool = False,
) -> List[HistoryEntry]: ...
class HistoryEntry:
version: int
created_on: datetime
created_by: str
tags: Set[str]
operation: LanceOperation
cleaned_up: bool
TBD: how to add a created_by field? Should we just create metadata? Then we could add arbitrary things like: lance_version, lancedb_version, author, etc.
The only_tagged parameter let's users filter just for the versions that have tags currently.
Improving performance and handling cleanup
We can store a new file to speed up history listing: _history/{version}.lance. This would be a Lance file containing a cache of history up to version.
Tags are mutable, but we can still include them in the cache as (name, etag) pairs. We can list the _refs/tags directory. If the tag is missing, we ignore it. If there is an etag we don't recognize, we can add that.
When we run history(), we can cache this file if it doesn't exist. When we run cleanup_old_versions(), we can also create this file before deleting old versions. By caching this data, we keep around the full history. If we want, we can also add a parameter to cleanup_old_version() to prune this history so we don't retain longer than some time period.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with CommitHandler and the existing versions() API, then trace how manifests, timestamps, metadata, tags, and cleanup_old_versions() are handled. The proposed work includes a history() API with HistoryEntry fields and an optional _history/{version}.lance cache; done would define the unresolved created_by behavior and preserve history across cleanup.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python, rust
- Domain
- backend, data
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 30/100