Skip to content

Document from_clickhouse#268

Open
mavam wants to merge 7 commits intotopic/new-executorfrom
topic/from-clickhouse
Open

Document from_clickhouse#268
mavam wants to merge 7 commits intotopic/new-executorfrom
topic/from-clickhouse

Conversation

@mavam
Copy link
Copy Markdown
Member

@mavam mavam commented Apr 17, 2026

🔍 Problem

  • The ClickHouse docs only covered writing to ClickHouse.
  • The new from_clickhouse operator needs reference and guide coverage.
  • The ClickHouse docs should also describe the shared database-operator connection contract, including URI-based connections.
  • The ClickHouse integration diagram should live as editable Excalidraw source in the docs repo.

🛠️ Solution

  • Add a dedicated from_clickhouse operator reference page.
  • Update the ClickHouse integration page and related data-store guides for read and write workflows.
  • Document both connection styles for ClickHouse operators:
    • explicit host / port / user / password
    • uri="clickhouse://[user[:password]@]host[:port][/database]"
  • Clarify that database.table and URI/default databases replace a separate database argument.
  • Cross-link related operator and integration pages.
  • Replace the tracked ClickHouse SVG with a raw .excalidraw source file that the docs build converts automatically.

💬 Review

  • Focus on whether the guide split between collecting from data stores and routing to data-store destinations is clear.
  • Confirm the ClickHouse integration page tells a coherent read/write story around from_clickhouse and to_clickhouse.
  • Check that the URI guidance and examples are consistent across the reference and guide pages.
🛠️ Code PR: tenzir/tenzir#6048
🎫 Refs TNZ-403

mavam added 2 commits April 17, 2026 08:10
Add a collecting guide for reading from MySQL and ClickHouse and expand the ClickHouse reference coverage.

Update send-to-destinations to cover ClickHouse and Snowflake and add reciprocal guide links from the related references.
Move the ClickHouse integration diagram into the docs tree as a raw .excalidraw file and reference it directly from the page.

This lets the docs pipeline generate and inline the SVG automatically.
@github-actions github-actions Bot added guide How-to guides reference Reference documentation integration Integration documentation labels Apr 17, 2026
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Apr 17, 2026

📦 Preview  ·  View →  ·  🟢 Live

Auto-updates on push

Copy link
Copy Markdown

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: d904d21862

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread src/content/docs/guides/routing/send-to-destinations.mdx Outdated
Copy link
Copy Markdown

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 8d65547b53

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread src/content/docs/guides/collecting/read-from-data-stores.mdx
@github-actions github-actions Bot added the site Site infrastructure label Apr 17, 2026
Copy link
Copy Markdown

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: eb4cbdb72b

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread src/content/docs/integrations/clickhouse.mdx
Copy link
Copy Markdown

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 404d48cca9

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread src/content/docs/guides/collecting/index.mdx
@mavam mavam requested a review from IyeOnline April 21, 2026 13:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

guide How-to guides integration Integration documentation reference Reference documentation site Site infrastructure

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant