docs(duckdb): add S3-compatible endpoint secret example - #5934
Draft
goanpeca wants to merge 1 commit into
Draft
Conversation
Signed-off-by: Gonzalo Peña-Castellanos <goanpeca@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.
Description
The DuckDB connection's
secretsoption passes every field straight through toCREATE OR REPLACE SECRET, so DuckDB'sendpointandurl_styleS3 secret parameters already work today without any code change. The two existing examples only show the Amazon S3 defaults, so nothing on the page tells users that pointing ans3secret at a different S3 host is supported. The parameter list is only reachable via the DuckDB link at the bottom of the section.This adds a third short example under "Cloud service authentication", alongside the list-format and dictionary-format examples, showing an
s3secret with a customendpoint(and a commentedurl_stylefor providers that need path-style addressing).Docs only, no code changes.
Test Plan
mkdocs buildusingdocs/requirements.txtand confirmed the new tabbed section renders and appears in the page table of contents.yaml.safe_loadto confirm it is valid.endpointandurl_stylein the exactCREATE OR REPLACE SECRET (type 's3', ...)statement thatBaseDuckDBConnectionConfig._cursor_initgenerates, so the documented fields are real rather than aspirational.Checklist
make styleand fixed any issuesmake fast-test)git commit -s) per the DCO