docs: explain S3 object-store configuration for SQL - #1716
Open
emecii wants to merge 1 commit into
Open
Conversation
Signed-off-by: Yifan Chen <emecii23@gmail.com>
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.
Which issue does this PR close?
Closes #970.
Rationale for this change
CREATE EXTERNAL TABLE ... OPTIONS ('aws.…' ...)fails becauseawsis not aSQL configuration namespace. The Python API already supports this workflow by
configuring an
AmazonS3object and registering it on theSessionContext, butthe object-store guide only showed
register_parquet.What changes are included in this PR?
SessionContextconstruction.registered.
AmazonS3, rather than in SQLOPTIONS.Are there any user-facing changes?
Yes. The user guide now explains how to use an already registered S3 object
store with
CREATE EXTERNAL TABLE.Validation: checked the documentation diff, parsed all eight Python snippets in
the page with
ast.parse, and verified the SQL DDL reaches the configured S3object store with the published DataFusion wheel. The example is deliberately
documented as requiring valid S3 credentials.
I understand and reviewed this AI-assisted documentation change end-to-end.