Skip to content

Docs: Cloud data catalog integration quickstart#6449

Open
amychen1776 wants to merge 8 commits into
mainfrom
docs/data-catalog-cloud-quickstart
Open

Docs: Cloud data catalog integration quickstart#6449
amychen1776 wants to merge 8 commits into
mainfrom
docs/data-catalog-cloud-quickstart

Conversation

@amychen1776

Copy link
Copy Markdown
Contributor

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>
@amychen1776 amychen1776 requested review from a team as code owners June 25, 2026 19:23
@vercel

vercel Bot commented Jun 25, 2026

Copy link
Copy Markdown

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

Project Deployment Actions Updated (UTC)
clickhouse-docs Ready Ready Preview, Comment Jun 25, 2026 8:55pm
clickhouse-docs-jp Building Building Preview, Comment Jun 25, 2026 8:55pm
3 Skipped Deployments
Project Deployment Actions Updated (UTC)
clickhouse-docs-ko Ignored Ignored Preview Jun 25, 2026 8:55pm
clickhouse-docs-ru Ignored Ignored Preview Jun 25, 2026 8:55pm
clickhouse-docs-zh Ignored Ignored Preview Jun 25, 2026 8:55pm

Request Review

@cursor cursor 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.

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

Fix All in Cursor

❌ 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.

Comment thread docs/cloud/features/02_integrations/02_data_catalogs.md Outdated
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>
amychen1776 and others added 2 commits June 25, 2026 15:35
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>
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>
Comment thread sidebars.js
'integrations/data-sources/cassandra',
'integrations/data-ingestion/gcs/index',
'integrations/data-ingestion/s3-minio',
'integrations/data-catalogs/index',

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Added this sidebar so that the preview build would pass, but I'm not convinced with this placement. Also the label as it is right now in the sidebar is "Connect a data catalog", perhaps it can just be Data catalog.

# Connect a data catalog in ClickHouse Cloud

:::info
Data catalog integrations in ClickHouse Cloud are in public beta.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

I don't think this is needed because of the BetaBadge up top.

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.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

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.


| 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+ |

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

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.

1. Fill in the connection parameters and **Database name** for your catalog type. The **Database name** is the ClickHouse database that exposes your catalog tables in the SQL console.
Select your catalog below for field-level guidance and prerequisites.

[AWS Glue Catalog](/use-cases/data-lake/glue-catalog) exposes [Iceberg](/engines/table-engines/integrations/iceberg) tables registered in the Glue Data Catalog.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

I'd suggest for each of these Catalog sections that we give them a seperate header or create a tabbed section with each catalog.

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.

2 participants