docs: add connection parameter reference (Thrift vs SEA/Kernel)#457
Open
eric-wang-1990 wants to merge 2 commits into
Open
docs: add connection parameter reference (Thrift vs SEA/Kernel)#457eric-wang-1990 wants to merge 2 commits into
eric-wang-1990 wants to merge 2 commits into
Conversation
Documents every public ConnectionOptions / OpenSessionRequest / per-statement parameter and whether it is honored on the Thrift backend, the SEA/Kernel backend (useKernel), or both — making protocol support gaps explicit. Mirrors the databricks-sql-kernel connection-parameters reference format. Co-authored-by: Isaac
eric-wang-1990
temporarily deployed
to
azure-prod
July 23, 2026 02:17 — with
GitHub Actions
Inactive
eric-wang-1990
temporarily deployed
to
azure-prod
July 23, 2026 02:17 — with
GitHub Actions
Inactive
eric-wang-1990
temporarily deployed
to
azure-prod
July 23, 2026 02:17 — with
GitHub Actions
Inactive
eric-wang-1990
temporarily deployed
to
azure-prod
July 23, 2026 02:17 — with
GitHub Actions
Inactive
|
Thanks for your contribution! To satisfy the DCO policy in our contributing guide every commit message must include a sign-off message. One or more of your commits is missing this message. You can reword previous commit messages with an interactive rebase ( |
Relocate docs/connection-parameters.md → CONNECTION_PARAMETERS.md at the repo root and add a README "Configuration" section linking to it, mirroring the existing Telemetry section's summary+link pattern. Co-authored-by: Isaac
eric-wang-1990
temporarily deployed
to
azure-prod
July 23, 2026 02:23 — with
GitHub Actions
Inactive
eric-wang-1990
temporarily deployed
to
azure-prod
July 23, 2026 02:23 — with
GitHub Actions
Inactive
eric-wang-1990
temporarily deployed
to
azure-prod
July 23, 2026 02:23 — with
GitHub Actions
Inactive
|
Thanks for your contribution! To satisfy the DCO policy in our contributing guide every commit message must include a sign-off message. One or more of your commits is missing this message. You can reword previous commit messages with an interactive rebase ( |
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.
What
Adds
docs/connection-parameters.md— a single reference listing every public connection / session / per-statement parameter the Node.js connector accepts, and whether each is honored on the Thrift backend (default), the SEA / Kernel backend (useKernel: true), or both.The goal is to make protocol support gaps explicit: a parameter honored on one backend but ignored or rejected on the other is called out in a Gap column.
Format
Modeled on the databricks-sql-kernel connection-parameters reference. Grouped by concern: connection identity · authentication · HTTP/proxy/retries · TLS/SSL · results & type rendering · session defaults · telemetry · per-statement options. Each row has a ✅ / ❌ /⚠️ / — verdict per backend plus a Gap note.
Sources of truth
lib/contracts/IDBSQLClient.tslib/contracts/InternalConnectionOptions.tslib/DBSQLClient.ts,lib/thrift-backend/ThriftBackend.ts,lib/connection/connections/HttpConnection.tslib/kernel/KernelAuth.ts,lib/kernel/KernelBackend.ts,lib/kernel/KernelSessionBackend.tsNotable gaps documented
Thrift-only (missing/ignored on Kernel):
enableMetricViewMetadataauto-injection; auth typescustom/token-provider/external-token/static-token+ token federation; Azure-direct OAuth; custom OAuthpersistence; custom U2MoauthClientId; SOCKS proxies; per-statementuseCloudFetch/useLZ4Compression/stagingAllowedLocalPath.Kernel-only (no Thrift public equivalent):
maxConnections; all TLS controls (checkServerCertificate,checkServerCertificateHostname,customCaCert,clientCertPem,clientKeyPem).TLS caveat surfaced: the Thrift
connect()path exposes no public TLS options and hardcodesrejectUnauthorized: false(HttpConnection.ts); the internalca/cert/keyfields are never populated from a public option. TLS customization is therefore kernel-only in practice.All kernel-path behavior reflects the M0 stub (
useKernelis internal/unstable) and is noted as subject to change.Docs-only change — no code touched.
This pull request and its description were written by Isaac.