Skip to content

Document from_clickhouse#268

Open
mavam wants to merge 17 commits into
mainfrom
topic/from-clickhouse
Open

Document from_clickhouse#268
mavam wants to merge 17 commits into
mainfrom
topic/from-clickhouse

Conversation

@mavam

@mavam mavam commented Apr 17, 2026

Copy link
Copy Markdown
Member

🔍 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

@github-actions github-actions Bot added guide How-to guides reference Reference documentation integration Integration documentation labels Apr 17, 2026
@github-actions

github-actions Bot commented Apr 17, 2026

Copy link
Copy Markdown
Contributor

📦 Preview  ·  View →  ·  🟢 Live

Verified for 1047ea8  ·  Auto-updates on push

@chatgpt-codex-connector chatgpt-codex-connector 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.

💡 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

@chatgpt-codex-connector chatgpt-codex-connector 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.

💡 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

@chatgpt-codex-connector chatgpt-codex-connector 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.

💡 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 Outdated

@chatgpt-codex-connector chatgpt-codex-connector 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.

💡 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
Base automatically changed from topic/new-executor to main May 8, 2026 15:22
@IyeOnline IyeOnline force-pushed the topic/from-clickhouse branch from 404d48c to 160a1d7 Compare May 22, 2026 11:44

@chatgpt-codex-connector chatgpt-codex-connector 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.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 160a1d7d9b

ℹ️ About Codex in GitHub

Codex has been enabled to automatically 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 👍.

When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".

Comment thread src/content/docs/reference/operators.mdx Outdated

@chatgpt-codex-connector chatgpt-codex-connector 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.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: af2b9f913a

ℹ️ About Codex in GitHub

Codex has been enabled to automatically 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 👍.

When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".

Comment thread src/content/docs/reference/operators/from_clickhouse.mdx
Comment thread src/content/docs/reference/operators.mdx Outdated
@IyeOnline IyeOnline force-pushed the topic/from-clickhouse branch from af2b9f9 to db29435 Compare May 28, 2026 15:07

@chatgpt-codex-connector chatgpt-codex-connector 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.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: db294355a2

ℹ️ About Codex in GitHub

Codex has been enabled to automatically 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 👍.

When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".

Comment thread src/content/docs/guides/collecting/read-from-data-stores.mdx Outdated
mavam and others added 10 commits June 13, 2026 08:59
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.
Replace the local ClickHouse setup walkthrough with a Cloud-first callout and a compact OSS quick start fallback. Keep the PR's from_clickhouse examples while clarifying when local non-TLS examples apply.

Assisted-by: GPT-5 (Codex)
Remove duplicate operator catalog sections, add the executor prerequisite near runnable from_clickhouse examples, and use the documented to_upper function in the data-store guide.

Assisted-by: GPT-5 (Codex)
Drop outdated notes that told users to run from_clickhouse with the new pipeline executor. The executor requirement has already landed, so the warning no longer applies.

Assisted-by: GPT-5 (Codex)
@mavam mavam force-pushed the topic/from-clickhouse branch from db29435 to a93ae5d Compare June 13, 2026 07:06

@chatgpt-codex-connector chatgpt-codex-connector 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.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: a93ae5d1ac

ℹ️ 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 Outdated
Keep the URI variant aligned with the automatic table creation example by reading the local OCSF fixture with from_file before sending it to ClickHouse.

Assisted-by: GPT-5 (Codex)
Update the ClickHouse integration page diagram from the supplied Excalidraw source so the rendered SVG matches the latest asset.

Assisted-by: GPT-5 (Codex)

@chatgpt-codex-connector chatgpt-codex-connector 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.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: adf68e8b69

ℹ️ 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/reference/operators/to_clickhouse.mdx Outdated
mavam added 2 commits June 13, 2026 09:29
Frame the page around ClickHouse as the analytical store for Tenzir security data pipelines. Add clearer integration paths, Cloud connection guidance, and examples for writing, reading, inspecting, and exporting ClickHouse data.

Assisted-by: GPT-5 (Codex)
Use from_file in the to_clickhouse URI example so the pipeline reads the CSV file before writing it to ClickHouse.

Assisted-by: GPT-5 (Codex)

@chatgpt-codex-connector chatgpt-codex-connector 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.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 62d55538d9

ℹ️ 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/reference/operators/to_clickhouse.mdx
mavam added 3 commits June 13, 2026 09:39
Add prose between adjacent TQL blocks so the renderer does not treat separate examples as input-output pairs.

Assisted-by: GPT-5 (Codex)
Remove redundant ClickHouse Cloud TLS wording and use the shorter Examples heading for the integration page examples section.

Assisted-by: GPT-5 (Codex)
Update the generated schema example to show Nullable(Bool), matching the documented to_clickhouse type mapping.

Assisted-by: GPT-5 (Codex)
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.

2 participants