Skip to content

docs: Add ClickHouse as compatible with query_id in dbt_run_results#1004

Open
29antonioac wants to merge 1 commit intoelementary-data:masterfrom
29antonioac:docs/query-id-clickhouse
Open

docs: Add ClickHouse as compatible with query_id in dbt_run_results#1004
29antonioac wants to merge 1 commit intoelementary-data:masterfrom
29antonioac:docs/query-id-clickhouse

Conversation

@29antonioac
Copy link
Copy Markdown

@29antonioac 29antonioac commented May 7, 2026

What

  • Add ClickHouse to Snowflake as adapters with query_id population in dbt_run_results model.

Why

Dependencies

  • The linked PR has been merged to main, but not tagged so a release has not been generated yet.

Summary by CodeRabbit

  • Documentation
    • Updated dbt_run_results model documentation to reflect that the query_id field is now supported in ClickHouse in addition to Snowflake.

@29antonioac 29antonioac requested a deployment to elementary_test_env May 7, 2026 13:54 — with GitHub Actions Waiting
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 7, 2026

Review Change Stack

📝 Walkthrough

Walkthrough

The query_id column description in the dbt_run_results model is updated to document that this field is returned by both Snowflake and ClickHouse adapters, replacing the previous Snowflake-only statement.

Changes

Adapter Support Documentation

Layer / File(s) Summary
Column Description Update
models/run_results.yml
The query_id column description is expanded to indicate support for both Snowflake and ClickHouse adapters, with null for others.

🎯 1 (Trivial) | ⏱️ ~2 minutes

🐰 A query finds its way through the snow,
Now ClickHouse joins the flow,
Two adapters, both so bright,
Documentation set aright.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the main change: adding ClickHouse as a compatible adapter for the query_id column in dbt_run_results.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Tip

💬 Introducing Slack Agent: The best way for teams to turn conversations into code.

Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.

  • Generate code and open pull requests
  • Plan features and break down work
  • Investigate incidents and troubleshoot customer tickets together
  • Automate recurring tasks and respond to alerts with triggers
  • Summarize progress and report instantly

Built for teams:

  • Shared memory across your entire org—no repeating context
  • Per-thread sandboxes to safely plan and execute work
  • Governance built-in—scoped access, auditability, and budget controls

One agent for your entire SDLC. Right inside Slack.

👉 Get started


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 7, 2026

👋 @29antonioac
Thank you for raising your pull request.
Please make sure to add tests and document all user-facing changes.
You can do this by editing the docs files in the elementary repository.

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@models/run_results.yml`:
- Line 217: The description for the "query_id" field in models/run_results.yml
incorrectly states ClickHouse is currently supported; update the description
string for the query_id field to either remove ClickHouse from the supported
adapters list or explicitly mark ClickHouse as "planned/unreleased" (e.g.,
"supported in Snowflake; ClickHouse support planned/unreleased") so users aren't
misled—modify the description value referenced as the description for query_id
in run_results.yml accordingly.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: bfc575b0-9945-4308-b5d8-1d0af59711d5

📥 Commits

Reviewing files that changed from the base of the PR and between 91d04fd and d80f30a.

📒 Files selected for processing (1)
  • models/run_results.yml

Comment thread models/run_results.yml
- name: query_id
data_type: string
description: Query ID in the data warehouse, if returned by the adapter (currently only supported in Snowflake, is null for any other adapter).
description: Query ID in the data warehouse, if returned by the adapter (currently only supported in Snowflake and ClickHouse, is null for any other adapter).
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot May 7, 2026

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

🧩 Analysis chain

🌐 Web query:

What is the first released dbt-clickhouse version that includes AdapterResponse.query_id support from PR https://github.com/ClickHouse/dbt-clickhouse/pull/634?

💡 Result:

No released version of dbt-clickhouse includes AdapterResponse.query_id support from PR #634. The feature request to populate ClickHouse query_id in AdapterResponse was opened on 2026-02-25 [1], and the current main branch code in connections.py still returns AdapterResponse(_message=status) without setting query_id [2]. No changelog or release notes mention this feature [3][4][5][6], and PR #634 does not appear in search results or open pull requests [7]. Latest release is v1.10.0 from 2026-02-16 [8][4], predating the issue. The PR likely does not exist or has not been merged/released as of 2026-05-07.

Citations:


Remove or qualify ClickHouse from current support list

Line 217 claims ClickHouse is currently supported for query_id, but this feature has not been released in any dbt-clickhouse version and does not appear to be implemented in the main branch. Remove ClickHouse from the description or explicitly mark it as "planned/unreleased" to prevent misleading users.

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@models/run_results.yml` at line 217, The description for the "query_id" field
in models/run_results.yml incorrectly states ClickHouse is currently supported;
update the description string for the query_id field to either remove ClickHouse
from the supported adapters list or explicitly mark ClickHouse as
"planned/unreleased" (e.g., "supported in Snowflake; ClickHouse support
planned/unreleased") so users aren't misled—modify the description value
referenced as the description for query_id in run_results.yml accordingly.

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

It is merged to main, just not tagged & released, so this PR should wait until that point 😄

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

@29antonioac, thanks for the clarification! That makes sense — since the feature is merged to main in dbt-clickhouse but not yet tagged/released, the current description could mislead users on published versions.

A few suggestions to make it easier to track and land this PR at the right time:

  1. Convert to a draft PR until the dbt-clickhouse release is published, so it's clear it's pending a dependency.
  2. Add a PR description note linking to the specific dbt-clickhouse release once it's tagged (e.g., Requires dbt-clickhouse >= vX.Y.Z), so reviewers and mergers know exactly when it's safe to land.
  3. Optionally, you could update the description in this PR to include the minimum version requirement once known, e.g.:
    description: Query ID in the data warehouse, if returned by the adapter (currently only supported in Snowflake and ClickHouse >= vX.Y.Z, is null for any other adapter).

Once the dbt-clickhouse release is out, this PR should be straightforward to merge! 🎉

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.

1 participant