Skip to content

Document remote authentication for SQL stored procedures#59

Merged
tbantle22 merged 1 commit into
devfrom
document-sql-remote-auth
May 26, 2026
Merged

Document remote authentication for SQL stored procedures#59
tbantle22 merged 1 commit into
devfrom
document-sql-remote-auth

Conversation

@tbantle22
Copy link
Copy Markdown
Collaborator

@tbantle22 tbantle22 commented May 20, 2026

Closes #46.

The four remote-touching procedures (DOLT_CLONE, DOLT_FETCH, DOLT_PULL, DOLT_PUSH) each named --user and DOLT_REMOTE_PASSWORD in their option lists but didn't explain the actual SQL-server flow: that the env var lives on the server process (not the SQL session), what user/password to use for each backend (DoltHub / DoltLab / Hosted / another sql-server's remotesapi), or that all --user calls in a server process share one password.

Adds a new `### Authenticating to remotes` subsection at the top of `dolt-sql-procedures.md` covering all of the above, with an end-to-end example and the verbatim "must set DOLT_REMOTE_PASSWORD" error string. Each procedure's --user Options entry now cross-links into the new section.

Source: env var is read at call time on the server process per grpc_dial_provider.go:158.

🤖 Generated with Claude Code

@tbantle22 tbantle22 requested a review from coffeegoddd May 20, 2026 22:53
Copy link
Copy Markdown
Member

@zachmu zachmu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Content is good, but maybe this deserves its own doc?

Per @zachmu's review on #59: the "Authenticating to remotes" content
is better as a standalone page than a section buried in the procedures
reference.

- New page reference/sql/version-control/remote-authentication.md
  ("Authenticating to Remotes"), covering --user / DOLT_REMOTE_PASSWORD,
  where to set the env var, the credentials per backend, and an example.
- dolt-sql-procedures.md: the four `--user` option entries now link to
  the new page instead of carrying the full explanation inline.
- nav.ts: added under Version Control Features, after "Using Remotes".

Rebased onto current dev (the branch was 43 commits behind and predated
the catch-all routing + frontmatter-title work), so the page needs no
.astro wrapper and its H1 is injected from the frontmatter title.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@tbantle22 tbantle22 force-pushed the document-sql-remote-auth branch from e744bd9 to 3d826f8 Compare May 26, 2026 19:01
@tbantle22
Copy link
Copy Markdown
Collaborator Author

Done — pulled the "Authenticating to remotes" content out into its own page (/sql-reference/version-control/remote-authentication, "Authenticating to Remotes"), added under Version Control Features in the nav right after "Using Remotes". The four --user option entries in the procedures reference now just link to it instead of carrying the full explanation inline.

Heads-up: the branch was 43 commits behind dev and predated the catch-all routing + frontmatter-title refactors, so I rebased it onto current dev and force-pushed. That means the new page needs no .astro wrapper (the [...slug] route generates it) and its H1 is injected from the frontmatter title — but it also dismisses your prior approval, so this'll need a fresh look. Verified the build (141 pages, single H1, all cross-links resolve).

@tbantle22 tbantle22 merged commit e63c0c1 into dev May 26, 2026
7 checks passed
@tbantle22 tbantle22 deleted the document-sql-remote-auth branch May 26, 2026 19:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

No information on how to authenticate a Dolt SQL Server to clone/push private databases

2 participants