Skip to content

docs: correct connection parameter reference - #943

Open
vuanhphung wants to merge 1 commit into
mainfrom
docs/fix-connection-parameter-reference
Open

docs: correct connection parameter reference#943
vuanhphung wants to merge 1 commit into
mainfrom
docs/fix-connection-parameter-reference

Conversation

@vuanhphung

Copy link
Copy Markdown
Collaborator

Updates the connection parameter reference to include missing routing and header options and align its Thrift/Kernel support matrix with the current implementations.

Corrects stale behavior and default claims for authentication, HTTP/retries, inline parameters, and telemetry, then refreshes the summary and connector version.

Testing: git diff --check.

Signed-off-by: Vu Anh Phung <vu.phung@databricks.com>

@peco-review-bot peco-review-bot Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Verdict: 1 Low

Looks good — a well-researched documentation correction whose technical claims I spot-checked against session.py, client.py, and backend/kernel/client.py and found accurate (notably the _telemetry_circuit_breaker_enabled effective-False Thrift default, kernel header filtering, force_enable_telemetry not being forwarded to Kernel, and shared-cursor use_inline_params rendering). One low-severity completeness note inline.

Comment thread CONNECTION_PARAMETERS.md
`_retry_dangerous_codes`, `_respect_server_retry_after_header`,
`_retry_max_redirects`, `_enable_v3_retries`.
9. `_socket_timeout`, `_port`, `_connection_uri`.
8. `force_enable_telemetry`.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🔵 Low — oauth_token_cache_enabled is introduced here as a kernel-supported option, but unlike every other kernel-only auth option it has no row in the Authentication table above — so this is the only place in the reference it appears, with no type/default/Note documented. The parameter is a real forwarded kernel kwarg (session.py kernel_auth_options["oauth_token_cache_enabled"]), so consider adding an Authentication-table row (e.g. bool, False/None default, Kernel-only, U2M encrypted on-disk token cache) for parity with the other kernel-only rows this list cross-references.

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.

1 participant