docs: Add ClickHouse as compatible with query_id in dbt_run_results#1004
docs: Add ClickHouse as compatible with query_id in dbt_run_results#100429antonioac wants to merge 1 commit intoelementary-data:masterfrom
query_id in dbt_run_results#1004Conversation
📝 WalkthroughWalkthroughThe ChangesAdapter Support Documentation
🎯 1 (Trivial) | ⏱️ ~2 minutes
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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.
Built for teams:
One agent for your entire SDLC. Right inside Slack. 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. Comment |
|
👋 @29antonioac |
There was a problem hiding this comment.
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
| - 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). |
There was a problem hiding this comment.
🧩 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:
- 1: Populate ClickHouse query_id in AdapterResponse ClickHouse/dbt-clickhouse#617
- 2: https://github.com/ClickHouse/dbt-clickhouse/blob/main/dbt/adapters/clickhouse/connections.py
- 3: https://github.com/ClickHouse/dbt-clickhouse/blob/main/CHANGELOG.md
- 4: https://github.com/ClickHouse/dbt-clickhouse/releases/tag/v1.10.0
- 5: https://github.com/ClickHouse/dbt-clickhouse/releases
- 6: https://github.com/ClickHouse/dbt-clickhouse/releases/tag/v1.9.7
- 7: https://github.com/ClickHouse/dbt-clickhouse/pulls
- 8: https://github.com/ClickHouse/dbt-clickhouse
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.
There was a problem hiding this comment.
It is merged to main, just not tagged & released, so this PR should wait until that point 😄
There was a problem hiding this comment.
@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:
- Convert to a draft PR until the dbt-clickhouse release is published, so it's clear it's pending a dependency.
- 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. - 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! 🎉
What
query_idpopulation indbt_run_resultsmodel.Why
query_idinAdapterResponsehas been merged to main indbt-clickhouse, feat: populate query_id in AdapterResponse ClickHouse/dbt-clickhouse#634Dependencies
Summary by CodeRabbit
dbt_run_resultsmodel documentation to reflect that thequery_idfield is now supported in ClickHouse in addition to Snowflake.