Document DSN connection parameters, OAuth, and user agent in README (#196)#388
Merged
Conversation
The README documented only PAT (token:) authentication and a handful of connection parameters, with no guidance on several options that the driver already supports and doc.go already lists. Add a consolidated 'Supported connection parameters' table (catalog, schema, maxRows, timeout, userAgentEntry, useCloudFetch, maxDownloadThreads, authType, accessToken, clientID, clientSecret) and worked DSN examples for: - OAuth machine-to-machine auth (clientID/clientSecret) - OAuth user-to-machine auth (authType=OauthU2M) - setting the user agent (userAgentEntry) Docs-only change; parameter names, defaults, and behavior verified against internal/config/config.go and its existing tests. Closes #196 Signed-off-by: Vikrant Puppala <vikrant.puppala@databricks.com>
gopalldb
approved these changes
Jul 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
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.
Summary
Fixes #196. The README documented only PAT (
token:) authentication and a handful of connection parameters, even though the driver already supports (anddoc.goalready lists) several more — including OAuth authentication and the user agent, which the issue specifically asked about.This PR reworks the "Connecting with DSN" section to close that documentation gap:
catalog,schema,maxRows,timeout,userAgentEntry,useCloudFetch,maxDownloadThreads,authType,accessToken,clientID,clientSecret— each with a description and default.clientID/clientSecret), OAuth user-to-machine auth (authType=OauthU2M), and setting the user agent (userAgentEntry).ansi_mode,timezone) pass through as session parameters.Test plan
go.mod/go.sumuntouched).internal/config/config.go:token:@prefix,clientID/clientSecretparams,authType=OauthM2Moptional.authType=OauthU2Mwith no credentials (builds authenticator from host via OIDC discovery).maxRows=100000,useCloudFetch=true,maxDownloadThreads=10,timeout=no timeout.userAgentEntryDSN forms are already covered by existing tests ininternal/config/config_test.go;go test ./internal/config/passes.Closes #196