Document the s3:// remote for dolt and doltgres - #174
Open
macneale4 wants to merge 1 commit into
Open
Conversation
Adds an S3-compatible section to the remote options on both sites, between AWS and GCS, covering what the protocol is, how credentials are resolved, and how to address a provider that is not AWS. The three query parameters get a table and worked R2 and MinIO examples, because the interesting parts are not obvious: endpoint and region fall back to the SDK chain but path-style does not and can only be set in the url; MinIO generally needs path-style and R2 does not; and an unrecognized parameter is an error rather than being ignored, so a typo is reported when the remote is added rather than surfacing later as a connection failure. The dolt page also warns to quote the url, since an unquoted ampersand backgrounds the command. The doltgres page is written in its own idiom rather than copied: sql function calls instead of cli, credentials framed as what the server process sees, and no shell quoting advice, which does not apply inside a quoted sql string. Doltgres inherits the scheme through dolt's dbfactory once its dolt dependency is bumped. cli.md is generated by dump-docs, so it is untouched here; its scheme list and remote help text come from the dolt source and will update when it is regenerated. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.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
2 participants
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.
No description provided.