lance-format / lance-format/lance
Unify `storage_options`, URI params, and `ObjectStoreParams`
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 7.1k
- Forks
- 852
- Avg merge
- 3d 18h
- Merged PRs (30d)
- 272
Description
Right now, most options can be passed in either environment variables or storage_options argument. But there's some like ddbTableName that are passed down as URI parameters:
To unify these, we could make the ddbTableName and related options available as storage_options. Then we could make all query parameters in URIs parsed as storage options. That would make the following two equivalent:
lance.dataset("s3://my-bucket/my-table", storage_options={"ddbCommitLock": "true", "ddbTableName": "myDdbTable"})
lance.dataset("s3://my-bucket/my-table?ddbCommitLock=true&ddbTableName=myDdbTable")
As part of this, we could simplify things by deprecating the s3+ddb scheme in favor of simply ddb.
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 docs/read_and_write.rst around the referenced URI-parameter example and the lance.dataset entry point, then trace storage_options, URI parsing, and ObjectStoreParams. Done means equivalent storage_options and URI forms support ddbTableName and related options, with the s3+ddb scheme deprecation addressed.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python, rust
- Domain
- backend-api-design, cloud
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100