Skip to content

Add dataflow pubsub template docs#6295

Merged
Blargian merged 3 commits into
mainfrom
add-dataflow-pubsub-template-docs
May 28, 2026
Merged

Add dataflow pubsub template docs#6295
Blargian merged 3 commits into
mainfrom
add-dataflow-pubsub-template-docs

Conversation

@BentsiLeviav
Copy link
Copy Markdown
Contributor

@BentsiLeviav BentsiLeviav commented May 27, 2026

Summary

Add documentation to our new Dataflow template from PubSub to ClickHouse


Note

Low Risk
Documentation-only changes with no runtime or security impact.

Overview
Adds a full Pub/Sub to ClickHouse Dataflow template guide and wires it into the docs site navigation and template index.

The new page documents the streaming pipeline end to end: prerequisites, template parameters (subscription, ClickHouse HTTP endpoint, batching via windowSeconds / batchRowCount, ClickHouseIO options), JSON-to-column schema mapping and type coercion, dead-letter handling (ClickHouse table schema and/or Pub/Sub topic), console run steps, custom metrics, and troubleshooting (memory limits, DLQ-only traffic, no rows).

Index and cross-links are updated so predefined templates mention both BigQuery batch and Pub/Sub streaming; the templates list promotes Pub/Sub from “coming soon” to a live doc and drops the old issue link. The overview dataflow.md blurb now calls out streaming from Pub/Sub. BigQuery template source code section now points to both Google’s upstream DataflowTemplates repo and ClickHouse’s fork (same pattern on the new Pub/Sub page). Sidebar adds the new doc under Dataflow templates.

Reviewed by Cursor Bugbot for commit 2f91560. Bugbot is set up for automated code reviews on this repo. Configure here.

BentsiLeviav and others added 2 commits May 27, 2026 11:40
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@BentsiLeviav BentsiLeviav requested review from a team as code owners May 27, 2026 18:43
@vercel
Copy link
Copy Markdown

vercel Bot commented May 27, 2026

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

Project Deployment Actions Updated (UTC)
clickhouse-docs Ready Ready Preview, Comment May 28, 2026 6:32am
4 Skipped Deployments
Project Deployment Actions Updated (UTC)
clickhouse-docs-jp Ignored Ignored May 28, 2026 6:32am
clickhouse-docs-ko Ignored Ignored Preview May 28, 2026 6:32am
clickhouse-docs-ru Ignored Ignored Preview May 28, 2026 6:32am
clickhouse-docs-zh Ignored Ignored Preview May 28, 2026 6:32am

Request Review

@mintlify
Copy link
Copy Markdown

mintlify Bot commented May 27, 2026

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

Added documentation for the new Pub/Sub to ClickHouse Google Dataflow template and linked it from related pages.

@Blargian Blargian merged commit 8158091 into main May 28, 2026
18 checks passed
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.

3 participants