Commit 2406f31
docs: add connection parameter reference (Thrift vs SEA/Kernel) (#457)
* docs: add connection parameter reference (Thrift vs SEA/Kernel)
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
Signed-off-by: eric-wang-1990 <e.wang@databricks.com>
* docs: move connection param reference to root, link from README
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
Signed-off-by: eric-wang-1990 <e.wang@databricks.com>
* docs: apply prettier formatting to connection parameters table
Aligns markdown table columns to satisfy the repo prettier check
(prettier . --check). Whitespace-only; no content changes.
Co-authored-by: Isaac
Signed-off-by: eric-wang-1990 <e.wang@databricks.com>
* ai: apply changes for #457 (3 review threads)
Addresses:
- #3663057241 at CONNECTION_PARAMETERS.md:60
- #3663100673 at CONNECTION_PARAMETERS.md:108
- #3663100689 at CONNECTION_PARAMETERS.md:62
Signed-off-by: peco-engineer-bot[bot] <peco-engineer-bot[bot]@users.noreply.github.com>
* ai: apply changes for #457 (1 review thread)
Addresses:
- #3663168408 at CONNECTION_PARAMETERS.md:77
Signed-off-by: peco-engineer-bot[bot] <peco-engineer-bot[bot]@users.noreply.github.com>
* ai: apply changes for #457 (1 review thread)
Addresses:
- #3799169490 at CONNECTION_PARAMETERS.md:88
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>
* docs: restructure connection-parameter tables to Option/Type/Thrift/Kernel/Default/Note
Add `Type` and `Default Value` columns to every parameter table and rename the
`Gap` column to `Note`. Types come from the public `ConnectionOptions` /
`ExecuteStatementOptions` shapes (`IDBSQLClient.ts`, `IDBSQLSession.ts`);
defaults come from `DBSQLClientDefaults` (`DBSQLClient.ts`) and
`DEFAULT_TELEMETRY_CONFIG` (`telemetry/types.ts`). The telemetry section's prose
"Aspect" table is replaced with a full per-option table (one row per
`telemetry*` knob with its default), and the events caveat is kept as a note.
Formatted with `prettier --write` so `prettier . --check` passes (the file
previously failed the check).
Co-authored-by: Isaac
Signed-off-by: eric-wang-1990 <e.wang@databricks.com>
* docs: fix runAsync backend semantics (Thrift no-op, kernel honors it)
The `runAsync` row said "not threaded on the kernel path", but
`IDBSQLSession.ts` documents the reverse: on Thrift `runAsync` is a no-op
(the path always submits async and polls; the option is not read), while the
kernel reads it to select sync direct-results (default) vs. submit-and-poll.
Flip the verdicts (Thrift 1 parent 05974d5 commit 2406f31
4 files changed
Lines changed: 210 additions & 14 deletions
0 commit comments