Docs: Cloud data catalog integration quickstart by amychen1776 · Pull Request #6449 · ClickHouse/clickhouse-docs

amychen1776 · 2026-06-25T19:23:08Z

Summary

Add /integrations/data-catalogs with a ClickHouse Cloud UI walkthrough for linking open table format catalogs, including screenshots and per-catalog anchor links.
Update the Cloud data catalogs integrations page with a clearer support matrix (Cloud vs Core guides) and a link to the new quickstart.

Test plan

Run docs site locally and open /integrations/data-catalogs
Verify catalog query params (?catalog=...) scroll or highlight the intended sections
Confirm images render under static/images/integrations/data-catalogs/
Check Cloud page /cloud/features/integrations/data-catalogs links and table formatting
Run Vale or existing docs lint if applicable

Made with Cursor

Introduce a step-by-step UI guide with per-catalog deep links and update the Cloud integrations page with a clearer support matrix. Co-authored-by: Cursor <cursoragent@cursor.com>

vercel · 2026-06-25T19:23:10Z

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Actions	Updated (UTC)
clickhouse-docs	Ready	Preview, Comment	Jul 1, 2026 2:34pm
clickhouse-docs-jp	Building	Preview, Comment	Jul 1, 2026 2:34pm

3 Skipped Deployments

Project	Deployment	Actions	Updated (UTC)
clickhouse-docs-ko	Ignored	Preview	Jul 1, 2026 2:34pm
clickhouse-docs-ru	Ignored	Preview	Jul 1, 2026 2:34pm
clickhouse-docs-zh	Ignored	Preview	Jul 1, 2026 2:34pm

cursor

Cursor Bugbot has reviewed your changes using default effort and found 1 potential issue.

^{❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, have a team admin enable autofix in the Cursor dashboard.}

^{Reviewed by Cursor Bugbot for commit f7a2f60. Configure here.}

Show the public beta badge on the Cloud quickstart and integrations landing page again. Co-authored-by: Cursor <cursoragent@cursor.com>

Remove extra consecutive blank lines so CI markdown checks pass. Co-authored-by: Cursor <cursoragent@cursor.com>

Keep the Data sources UI image on the manage landing page and add it to the Cloud integration quickstart intro for context. Co-authored-by: Cursor <cursoragent@cursor.com>

Co-authored-by: Cursor <cursoragent@cursor.com>

…into docs/data-catalog-cloud-quickstart

Adds integrations/data-catalogs/index to the Data sources sidebar category, next to the object-storage entries. The page was created without a sidebar entry, which failed the floating-pages build check on DocsCheck and Vercel. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

- /materialized-view -> /materialized-views (index page slug) - /use-cases/data-lake/guides/accelerating-analytics -> /use-cases/data-lake/getting-started/accelerating-analytics Both were failing the Docusaurus broken-links check on the Vercel build. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

dhtclk · 2026-06-25T21:13:13Z

+Data catalog integrations in ClickHouse Cloud are in public beta.
+:::
+
+Connect ClickHouse Cloud to your data catalogs to access your open table format tables. You can set up connections in the **Data sources** UI. For setup via SQL, use the `[DataLakeCatalog](/engines/database-engines/datalakecatalog)` database engine in your SQL editor of choice.


Suggested change

Connect ClickHouse Cloud to your data catalogs to access your open table format tables. You can set up connections in the **Data sources** UI. For setup via SQL, use the `[DataLakeCatalog](/engines/database-engines/datalakecatalog)` database engine in your SQL editor of choice.

Connect ClickHouse Cloud to your data catalogs to access your open table format tables. You can set up connections in the **Data sources** UI. For setup via SQL, use the [`DataLakeCatalog`](/engines/database-engines/datalakecatalog) database engine in your SQL editor of choice.

Fixing the backticks here so that the link renders properly.

dhtclk · 2026-06-25T21:25:37Z

+
+| Name              | Open table format | Auth method                            | Cloud                                                      | Core                                             | Version |
+| ----------------- | ----------------- | -------------------------------------- | ---------------------------------------------------------- | ------------------------------------------------ | ------- |
+| AWS Glue Catalog  | Iceberg           | IAM role (26.2+), Access keys          | [Guide](/integrations/data-catalogs?catalog=aws-glue)      | [Guide](/use-cases/data-lake/glue-catalog)       | 25.10+  |


What is the intention of these query string params in these links (?catalog=aws-glue). As of now, every link lands at the top of the page.

I wanted to send them to the new page of the setup guide

dhtclk · 2026-06-26T19:06:59Z

@amychen1776 - I made some updates to page organization and used some UI components. lmk what you think and we can go from there.

- Move integrations/data-catalogs/index out of "Data sources" into a new "Data lakes" category in the integrations sidebar - Shorten sidebar_label to "Data catalogs" - Clarify description: connecting a data catalog for Iceberg or Delta tables in ClickHouse Cloud Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

- Add "Data lakes" entry to the Integrations top-nav dropdown (MenuData.js) pointing to /integrations/data-catalogs, with matching i18n key in en/code.json — the mega-menu is hand-curated, not derived from sidebars.js, so the new category was otherwise invisible - Reword the "Add your catalog connection" intro (drop "field-level", remove repeated "Database name") - Clarify that dropping a catalog removes the catalog's database from ClickHouse, not data in the external catalog - Note that catalog tables can take from minutes up to a day to appear Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

A prior edit removed the intro line under "Connect your catalog" and swept up the adjacent <VerticalStepper> opening tag, leaving an orphaned closing tag that broke MDX compilation. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

mintlify · 2026-07-01T15:08:04Z

Docs PR opened: ClickHouse/mintlify-docs-dev#315

Ported the Cloud data catalog quickstart page and refreshed the Cloud vs Core support matrix on the data catalogs feature page.

Add Cloud data catalog integration quickstart and refresh overview.

f7a2f60

Introduce a step-by-step UI guide with per-catalog deep links and update the Cloud integrations page with a clearer support matrix. Co-authored-by: Cursor <cursoragent@cursor.com>

amychen1776 requested review from a team as code owners June 25, 2026 19:23

cursor Bot reviewed Jun 25, 2026

View reviewed changes

Comment thread docs/cloud/features/02_integrations/02_data_catalogs.md Outdated

vercel Bot had a problem deploying to Preview – clickhouse-docs June 25, 2026 19:24 Failure

Restore BetaBadge on data catalog integration page.

fd1cf5a

Show the public beta badge on the Cloud quickstart and integrations landing page again. Co-authored-by: Cursor <cursoragent@cursor.com>

vercel Bot had a problem deploying to Preview – clickhouse-docs June 25, 2026 19:26 Failure

Fix markdownlint MD012 in data catalog docs.

1101604

Remove extra consecutive blank lines so CI markdown checks pass. Co-authored-by: Cursor <cursoragent@cursor.com>

vercel Bot had a problem deploying to Preview – clickhouse-docs June 25, 2026 19:33 Failure

amychen1776 and others added 2 commits June 25, 2026 15:35

Restore data catalogs UI screenshot on overview and integration pages.

c9385c3

Keep the Data sources UI image on the manage landing page and add it to the Cloud integration quickstart intro for context. Co-authored-by: Cursor <cursoragent@cursor.com>

Update catalog flyout select screenshot

eb13bde

Co-authored-by: Cursor <cursoragent@cursor.com>

vercel Bot had a problem deploying to Preview – clickhouse-docs June 25, 2026 19:39 Failure

Merge branch 'main' of https://github.com/ClickHouse/clickhouse-docs …

d63bc7b

…into docs/data-catalog-cloud-quickstart

vercel Bot had a problem deploying to Preview – clickhouse-docs-ru June 25, 2026 19:53 Failure

vercel Bot had a problem deploying to Preview – clickhouse-docs-zh June 25, 2026 19:53 Failure

vercel Bot had a problem deploying to Preview – clickhouse-docs-ko June 25, 2026 19:54 Failure

vercel Bot had a problem deploying to Preview – clickhouse-docs June 25, 2026 19:59 Failure

vercel Bot had a problem deploying to Preview – clickhouse-docs-jp June 25, 2026 19:59 Failure

vercel Bot had a problem deploying to Preview – clickhouse-docs June 25, 2026 20:37 Failure

vercel Bot deployed to Preview – clickhouse-docs June 25, 2026 20:55 View deployment

dhtclk reviewed Jun 25, 2026

View reviewed changes

Comment thread sidebars.js Outdated

Comment thread docs/integrations/data-catalogs/index.md Outdated

dhtclk reviewed Jun 25, 2026

View reviewed changes

updating links, structural updates with ui components, page org

bc71aa7

vercel Bot deployed to Preview – clickhouse-docs June 26, 2026 19:18 View deployment

vercel Bot deployed to Preview – clickhouse-docs June 29, 2026 20:54 View deployment

amychen1776 and others added 4 commits June 29, 2026 17:34

Tighten catalog table timing note to "a few minutes"

68d9dca

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

Specify catalog table listing can take up to 3 minutes

5f20a44

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

Attribute table listing delay to "depending on the catalog"

9946af5

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

vercel Bot deployed to Preview – clickhouse-docs June 29, 2026 21:58 View deployment

Update data catalog quickstart screenshots

ed9068a

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

vercel Bot deployed to Preview – clickhouse-docs June 30, 2026 19:59 View deployment

amychen1776 and others added 4 commits June 30, 2026 17:01

Update linked catalogs table screenshot

b4ba456

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

Update data catalogs UI overview screenshot

caa2ff8

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

update tone

29235da

editing claude wording

2c139b9

vercel Bot had a problem deploying to Preview – clickhouse-docs June 30, 2026 21:35 Failure

Remove replica-aware-routing changes from this PR

be16348

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

vercel Bot had a problem deploying to Preview – clickhouse-docs June 30, 2026 22:52 Failure

vercel Bot deployed to Preview – clickhouse-docs July 1, 2026 14:34 View deployment

dhtclk approved these changes Jul 1, 2026

View reviewed changes

dhtclk merged commit 266d32d into main Jul 1, 2026
17 checks passed

mintlify Bot mentioned this pull request Jul 1, 2026

Migration: Cloud data catalog integration quickstart ClickHouse/mintlify-docs-dev#315

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Docs: Cloud data catalog integration quickstart#6449

Docs: Cloud data catalog integration quickstart#6449
dhtclk merged 21 commits into
mainfrom
docs/data-catalog-cloud-quickstart

amychen1776 commented Jun 25, 2026

Uh oh!

vercel Bot commented Jun 25, 2026 •

edited

Loading

Uh oh!

cursor Bot left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

dhtclk Jun 25, 2026

Uh oh!

dhtclk Jun 25, 2026

Uh oh!

amychen1776 Jun 29, 2026

Uh oh!

Uh oh!

dhtclk commented Jun 26, 2026

Uh oh!

Uh oh!

mintlify Bot commented Jul 1, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

	Connect ClickHouse Cloud to your data catalogs to access your open table format tables. You can set up connections in the Data sources UI. For setup via SQL, use the `[DataLakeCatalog](/engines/database-engines/datalakecatalog)` database engine in your SQL editor of choice.
	Connect ClickHouse Cloud to your data catalogs to access your open table format tables. You can set up connections in the Data sources UI. For setup via SQL, use the [`DataLakeCatalog`](/engines/database-engines/datalakecatalog) database engine in your SQL editor of choice.

Uh oh!

Conversation

amychen1776 commented Jun 25, 2026

Summary

Test plan

Uh oh!

vercel Bot commented Jun 25, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

cursor Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

dhtclk Jun 25, 2026

Choose a reason for hiding this comment

Uh oh!

dhtclk Jun 25, 2026

Choose a reason for hiding this comment

Uh oh!

amychen1776 Jun 29, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

dhtclk commented Jun 26, 2026

Uh oh!

Uh oh!

mintlify Bot commented Jul 1, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

vercel Bot commented Jun 25, 2026 •

edited

Loading