Skip to content

docs: Add the ClickHouse Cloud guide - #59

Merged
gjtorikian merged 4 commits into
mainfrom
docs/clickhouse-cloud-guide
Nov 12, 2026
Merged

gjtorikian merged 4 commits into
mainfrom
docs/clickhouse-cloud-guide

Conversation

@gjtorikian

@gjtorikian gjtorikian commented Nov 12, 2026 •

Copy link
Copy Markdown
Collaborator

Summary

  • Adds docs/integrations/clickhouse-cloud.md, the fourth hosted-destination guide alongside Neon, PlanetScale and MongoDB Atlas, and links it from the README's integration list.
  • Covers what the console puts in front of you: tier, the one-time default password and its reset, the IP access list, the HTTPS endpoint and what to prepend to it, and that no CA is needed.
  • Writes down the two things a first run on Cloud trips over: the service idles after 15 minutes (so listen keeps it billing, and a cold first command waits for the wake), and only port 8443 is exposed, which a 443-only network cannot reach.
  • Records the November 2026 result against a two-replica Scale service: 162 of 163, with the one failure explained as the hand-applied --print-sql script racing DDL replication, and "run it again" as the fix since every statement is idempotent.
  • The grants for a dedicated user are listed from the package README and marked as not yet tried on Cloud; the guide was verified with default.
  • Follow-ups from review, same PR: getting-started.md now says it shows Postgres and names the three package READMEs that hold the counterparts, and the Atlas guide's "library" link goes to the MongoDB README's MongoDestination snippet instead of the Postgres one.

Neon, PlanetScale and Atlas each have an integration guide; ClickHouse
Cloud, the fourth hosted destination the packages were verified
against, had none, and what the November run turned up lived only in
a demo repository's notes. The idling behavior, the 8443-only port
and the replica race in the hand-applied --print-sql script are the
things a first run on Cloud trips over, so they belong where the
package's users look.
@greptile-apps

greptile-apps Bot commented Nov 12, 2026 •

Copy link
Copy Markdown

RetriggerView in GreptileConfidence Score: 5/5

[Low impact] The PR appears safe to merge; the previous finding is fixed and no new issues were found.

Summary

Adds a ClickHouse Cloud setup guide and links it from the main README.

  • Operators can find ClickHouse Cloud setup and connection details in one guide.
  • The guide explains how HTTPS and idling shape Cloud sync runs.
  • The guide shows how to test a Cloud endpoint and interpret a replica-run result.
  • The guide connects Cloud setup to running and querying the mirror.
  • Database guides now point readers to instructions for their destination.
  • The ClickHouse README explains where row history remains available.

Reviews (4) · Last reviewed commit: "docs: Qualify the counterpart claim in t..." · Reviewed by Greptile

Comment thread docs/integrations/clickhouse-cloud.md Resolved
Comment thread docs/integrations/clickhouse-cloud.md Resolved
…mples

The mirror tables are ReplacingMergeTree, so a merge collapses each row
to its newest version; the guide and the package README both claimed
every version was kept. The guide also pointed at the Postgres query
guide and the Postgres embed snippet without saying what differs.
…embed

The guide never said it was Postgres-only, so a reader arriving from a
search took the engine for a Postgres tool, and the Atlas guide sent
its "library" link to a snippet that imports PostgresDestination. The
README already carries the one-sentence scoping; the guide now does
too, with the three package READMEs it defers to.
Comment thread docs/getting-started.md Resolved
The guide describes init --print-sql, which the MongoDB command does
not have, so "every option has a counterpart" promised a workflow that
package's users cannot use.
@gjtorikian
gjtorikian merged commit 1908e15 into main Nov 12, 2026
25 checks passed
@gjtorikian
gjtorikian deleted the docs/clickhouse-cloud-guide branch November 12, 2026 02:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

1 participant