Skip to content

The README lists the symptoms people search for and shows a finding in one command - #12

Merged
avison9 merged 1 commit into
mainfrom
docs/symptoms-and-demo
Sep 25, 2026
Merged

avison9 merged 1 commit into
mainfrom
docs/symptoms-and-demo

Conversation

@avison9

@avison9 avison9 commented Sep 25, 2026

Copy link
Copy Markdown
Owner

What changes

  • Symptoms it prevents: a table from what people type when they hit this ("a column is 0 on every row", "table.include.list not working", "no topic appears", "a column added in Postgres never shows up") to the usual cause and the cdclint rule that catches it. Every row names a rule that exists today; the table.include.list row says it applies when a sink reads the table. A closing line states the limits: Postgres sources only, no type checks, files only.
  • Try it on a known failure: runs the include-list-typo corpus entry from a clone and shows its real output (1 error, 1 warning, exit 1).
  • mv-column-match row: ClickHouse 25.4 and later reject a streaming view that writes a column the target lacks, at CREATE (ClickHouse PR 74481, merged 2025-03-26; in v25.4.1.2934-stable, not in v25.3.1.2703-lts). The 24.8/26.8 line is about a refreshable view's order mismatch, and now reads that way.

Verified

  • The demo output in the README is copied from running the command against corpus/include-list-typo on this branch's code.
  • The rule each symptom names was checked against the code: include patterns are anchored (^(?:p)$), so an entry without a schema, or a glob like public.bg_*, matches no table and a sink reading it raises sink-table-not-captured; column.include.list is applied to every captured table in CapturesColumn.
  • README only; no code, corpus or expectation changes.

Why

The phrases come from a read-only scan of the ClickHouse, Debezium and sink connector trackers, Debezium's Zulip and Google Group, and Stack Overflow. The page should answer the search people already make.

Next for you

Merge when happy. Repository topics were added separately (they are a repository setting, not part of this PR).

…n one command

Someone who hits this failure searches for what they see ("column is 0 on
every row", "table.include.list not working", "no topic created"), not
for "CDC contract linter". A symptoms table maps those phrases to the
cause and the rule, so the page answers the search. Each row names a rule
that exists today; the table.include.list row holds only when a sink
reads the table, and says so.

A try-it section runs the include-list-typo corpus entry and shows its
real output, so a visitor sees a finding and the fix before installing
anything in CI.

The mv-column-match row now says ClickHouse 25.4 and later reject a
streaming view that writes a missing column at CREATE (ClickHouse PR
74481, first released in 25.4), so the 24.8/26.8 line reads as what it
is, a refreshable view's order mismatch.
@avison9 avison9 self-assigned this Sep 25, 2026
@avison9
avison9 merged commit d098deb into main Sep 25, 2026
2 checks passed
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