docs: add connection parameter reference (Thrift vs SEA/Kernel) - #445
Conversation
There was a problem hiding this comment.
Pull request overview
Adds a standalone documentation reference for all DSN parameters and connector options, clarifying which settings apply to the Thrift backend vs the SEA/kernel backend, and links it from the README to make the information easier to find.
Changes:
- Added
CONNECTION_PARAMETERS.mdwith per-concern matrices describing parameter applicability (Thrift vs SEA/kernel). - Linked the new reference doc from the README’s “Connection properties” section.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| README.md | Adds a prominent link to the new connection-parameter reference from the existing connection properties documentation. |
| CONNECTION_PARAMETERS.md | New consolidated matrix/reference documenting per-parameter applicability and behavior across Thrift vs SEA/kernel backends. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
eric-wang-1990
added
the
engineer-bot
Addresses: - #3800163483 at CONNECTION_PARAMETERS.md:17 Signed-off-by: peco-engineer-bot[bot] <peco-engineer-bot[bot]@users.noreply.github.com>
Add CONNECTION_PARAMETERS.md at the repo root: a per-concern comparison matrix of every DSN parameter and connector option, showing whether each applies to the Thrift backend (default), the SEA/kernel backend, or both, using a ✅/❌/⚠️ /— legend. Link it from the README Connection properties section. Co-authored-by: Isaac Signed-off-by: eric-wang-1990 <e.wang@databricks.com>
Addresses: - #3800163483 at CONNECTION_PARAMETERS.md:17 Signed-off-by: peco-engineer-bot[bot] <peco-engineer-bot[bot]@users.noreply.github.com> Signed-off-by: eric-wang-1990 <e.wang@databricks.com>
add70a7 to
17b160d
Compare
![peco-review-bot[bot]](https://avatars.githubusercontent.com/in/3801177?s=60&v=4){kind=small}
There was a problem hiding this comment.
Verdict: 1 Low
Docs-only PR adding CONNECTION_PARAMETERS.md and a README pointer. Content mirrors the README Protocol column accurately; all cross-doc anchors (#connection-properties, #choosing-a-backend-thrift-vs-seakernel, #building) and the telemetry/DESIGN.md link resolve. Looks good — one low-severity self-contradiction where timezone is offered as an example of an unlisted param yet appears in the Query execution table.
Addresses: - #3800257703 at CONNECTION_PARAMETERS.md:34 Signed-off-by: peco-engineer-bot[bot] <peco-engineer-bot[bot]@users.noreply.github.com>
Match the databricks-sql-go layout (databricks/databricks-sql-go#445): put the reference at the repo root as CONNECTION_PARAMETERS.md and link it from README's docs section, instead of docs/connection-parameters.md. Retitle to the plural 'Connection parameters reference' and fix the relative proxy link (proxy.md -> docs/proxy.md) now that the file sits one level up. Co-authored-by: Isaac Signed-off-by: eric-wang-1990 <e.wang@databricks.com>
What
Adds
CONNECTION_PARAMETERS.mdat the repo root — a per-concern comparison matrix of every DSN parameter and connector option, documenting whether each applies to the Thrift backend (default), the SEA/kernel backend, or both. Links it from the README's Connection properties section.Mirrors the equivalent references in the Python and Node.js drivers.
Layout
One matrix per concern with a
✅ / ❌ / ⚠️ / —legend:ErrNotSupportedByKernel/ErrRequiresKernelBackend) — never silently ignoredSections: Endpoint & routing, Authentication, Query execution, Retry/backoff, Result rendering, Cloud Fetch, TLS, Proxy, Telemetry.
The
⚠️distinction matters more in this driver than in Python/Node because unsupported options are hard-rejected rather than ignored — e.g.maxRows/useCloudFetch/maxDownloadThreads/useArrowNativeDecimalare inert on kernel,warehouseIdis ignored on Thrift, whileWithTransport/custom auth providers/port≠443are rejected on kernel andWithKernel*options are rejected on Thrift.Notes
This pull request and its description were written by Isaac.
This PR was created with GitHub MCP.