docs: clarify DialTimeout and Cloud idle behavior in Go client#180
Open
mintlify[bot] wants to merge 1 commit into
Open
docs: clarify DialTimeout and Cloud idle behavior in Go client#180mintlify[bot] wants to merge 1 commit into
mintlify[bot] wants to merge 1 commit into
Conversation
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
3 tasks
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.
Summary
Ports upstream PR ClickHouse/clickhouse-docs#6301 to clarify
DialTimeoutbehavior when connecting to idled ClickHouse Cloud services.Changes
integrations/language-clients/go/config-reference.mdx: expanded theDialTimeoutrow in the Timeouts table and added a<Note>callout (converted from Docusaurus:::note[...]) explaining Cloud wake-up behavior.integrations/language-clients/go/configuration.mdx: updated theDialTimeoutdescription to recommend1m–2mfor idled Cloud services with a link to the Timeouts section.Context
Upstream merge
29ddcf7onmainofclickhouse/clickhouse-docs. i18n translation directories were intentionally skipped per instructions; only English docs updated.Note
Low Risk
English-only documentation updates; no runtime or client code changes.
Overview
Documents how
DialTimeoutinteracts with paused ClickHouse Cloud services that wake on the first connection.In
config-reference.mdx, the Timeouts table now recommends 1–2m for idled Cloud targets and expands failure modes (dial timeout before wake completes). A new<Note>explains wake latency, why the first post-idle query can fail with a short timeout, and tradeoffs (slower outage detection vs. context deadlines).In
configuration.mdx, theDialTimeoutrow points readers to that section and the same 1m–2m guidance for possibly idle Cloud services.Reviewed by Cursor Bugbot for commit 1110c13. Bugbot is set up for automated code reviews on this repo. Configure here.