Skip to content

Update v2 status documentation - #780

Merged
koletzilla merged 4 commits into
mainfrom
koletzilla/clickhouse-update-v2-docs
Nov 6, 2026
Merged

koletzilla merged 4 commits into
mainfrom
koletzilla/clickhouse-update-v2-docs

Conversation

@koletzilla

@koletzilla koletzilla commented Nov 5, 2026 •

Copy link
Copy Markdown
Contributor

Summary

  • Update on new V2 features available:
    • Headline pass rate changed to ~98% after latests PR merges (270 of 276 applicable tests).
    • Five parity rows flipped to Supported: distributed materializations, ON CLUSTER, grants, dbt clone, docs persistence.
    • Remaining gaps are query comments, query_id, source freshness.
  • New "dbt v2 specific functionality" table:
    • SQL dialect, static analysis, lineage (platform and engine), LSP, source freshness (In progress), MetricFlow, record/replay, usage tracking, platform auth.
    • Column-level lineage row moved here from "Testing and docs".
  • New section "Not planned for v2":
    • verify moved table with the security rationale.

Note

Low Risk
Documentation-only changes with no runtime or adapter code; risk is limited to doc accuracy if status claims drift from reality.

Overview
Updates docs/dbt-core-v2-fusion-and-platform.mdx to reflect current dbt v2 ClickHouse adapter maturity: integration coverage is now ~98% (270/276) with remaining gaps called out as engine-side (query comments, query_id, hook naming), and the status section is renamed to Details on current status.

The v1 vs v2 parity tables are revised so several former gaps are marked Supported (distributed materializations, ON CLUSTER, grants, dbt clone, docs persistence), while pending work and v2-only capabilities (SQL dialect/static analysis, lineage, Semantic Layer, platform auth, etc.) are split into new Not planned for v2 and dbt v2 specific functionality sections instead of living in the Beta warning/out-of-scope bullets.

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

<Warning>
**Beta, not yet GA.** The ClickHouse adapter for dbt OSS and dbt v2 is in Beta, and the dbt platform connection is in Private Beta. The dbt Core 1.x adapter, `dbt-clickhouse`, is GA and supported for production use; nothing on this page changes that.

Beta means that every materialization (including `incremental` with all its strategies), model contracts, data and unit tests and the ClickHouse Cloud feature set work today and pass the dbt Core 1.x integration test suite. The features that are still pending are listed in [v1 vs v2 parity](#parity) and that list shrinks with every release. We recommend evaluating dbt v2 in development or staging first, and keeping production on dbt Core 1.x if your project depends on any of the pending features or you need the guarantees of a GA release.

@koletzilla koletzilla Nov 5, 2026 •

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Moved to Details on current status

| Docs persistence | Descriptions written as ClickHouse comments. | <Badge color="yellow">Partial</Badge> | Descriptions containing `;` fail. |
| Docs persistence | Descriptions written as ClickHouse comments. | <Badge color="green">Supported</Badge> | |
| Catalog and docs generation | Column metadata for the docs site. | <Badge color="green">Supported</Badge> | |
| Column-level lineage | Trace columns through the DAG. | <Badge color="yellow">Partial</Badge> | New in v2 via the SQL compiler, not available in v1. dbt platform lineage renders only with identifier quoting disabled in `dbt_project.yml`; engine-side lineage needs the ClickHouse SQL dialect. |

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Moved to v2 specifics

| `dbt clone` | Zero-copy `CLONE AS` between environments. | <Badge color="green">Supported</Badge> | MergeTree tables, seeds, snapshots and incrementals are cloned with `CLONE AS`; views and other engines fall back to views, as in v1. |
| Query ID in run results | `query_id` in `adapter_response` for `system.query_log` correlation. | <Badge color="red">Not yet</Badge> | |
| `query-comment` | Query comment configuration. | <Badge color="red">Not yet</Badge> | `query-comment: null` is not honored yet. |
| Catalog integration (Iceberg) | Materialize into external catalogs. | <Badge color="red">Not yet</Badge> | Not in v1 either; workarounds documented. |

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Not in v1 anyway, and it's documented in the general docs.


| Feature | What it does in v1 | Why it is not planned |
|---------|--------------------|-----------------------|
| `verify: false` | Skips TLS certificate validation. | It keeps the encryption but drops the authentication, so anyone on the path can impersonate the server and read the credentials. v2 always validates certificates and ignores the key. Use a certificate signed by a CA the client trusts. Open an issue if you need it in v2. |

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Not really needed right now. I think we should wait for users requesting it.

@koletzilla koletzilla added the sync-docs Sync workflow to open or refreshes a pull request in `ClickHouse/ClickHouse` with new docs label Nov 5, 2026
@koletzilla
koletzilla merged commit 7210dd6 into main Nov 6, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

sync-docs Sync workflow to open or refreshes a pull request in `ClickHouse/ClickHouse` with new docs

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants