docs: add storage backend configuration reference tables#4173
Merged
rtyler merged 3 commits intodelta-io:mainfrom Feb 8, 2026
Merged
docs: add storage backend configuration reference tables#4173rtyler merged 3 commits intodelta-io:mainfrom
rtyler merged 3 commits intodelta-io:mainfrom
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #4173 +/- ##
=======================================
Coverage 76.62% 76.62%
=======================================
Files 166 166
Lines 47030 47030
Branches 47030 47030
=======================================
Hits 36036 36036
Misses 9252 9252
Partials 1742 1742 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Add comprehensive configuration reference tables for S3, Azure ADLS, GCS, and S3-compatible storage backends. Each table lists all valid storage_options keys, their environment variable equivalents, and descriptions sourced from the object_store crate's config enums. Changes: - s3.md: Added configuration reference table (20+ keys), Delta Lake specific options, and supported URL schemes - adls.md: Added Azure configuration reference with 18 auth/config options - gcs.md: Added GCS configuration reference and authentication methods - s3-like.md: Added detailed guides for 5 S3-compatible services (R2, MinIO, Alibaba OSS, LocalStack, Ceph) with service-specific examples - lakefs.md: Replaced TODO placeholder with Python cleanup code example - special_configuration.md: Added common client options table (17 keys) that work across all backends All sections include links to authoritative object_store documentation for complete reference. Closes delta-io#2748 Signed-off-by: adhil-cloud <muhammadadhil45@gmail.com>
6e91973 to
215b5b6
Compare
rtyler
approved these changes
Feb 8, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #2748
Adds comprehensive
storage_optionsconfiguration reference tables to each storage backend documentation page, making it easy for usersto discover all available configuration keys without having to dig through the Rust
object_storecrate docs.Changes
Configuration Reference Tables Added
schemes
SAS, managed identity) and URL schemes
connection pooling, etc.)
S3-Compatible Services Documentation
Documentation Improvements
Notes
object_storecrate's config enumsThis contribution was created with assistance from Claude.