Skip to content

Add docs for the changefeed kafka header option #19588

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

katmayb
Copy link
Contributor

@katmayb katmayb commented May 6, 2025

Fixes DOC-12596

This PR adds docs for the new Kafka header option:

  • Section added to Changefeed Messages page that provides a full use case example.
  • Shorter description added to full list of options on CREATE CHANGEFEED page, which links back to the new section example on the message page.

Preview

https://deploy-preview-19588--cockroachdb-docs.netlify.app/docs/v25.2/changefeed-messages.html#specify-a-column-as-a-kafka-header

Copy link

github-actions bot commented May 6, 2025

Copy link

netlify bot commented May 6, 2025

Deploy Preview for cockroachdb-interactivetutorials-docs canceled.

Name Link
🔨 Latest commit 6a87581
🔍 Latest deploy log https://app.netlify.com/sites/cockroachdb-interactivetutorials-docs/deploys/681e78c64ce81100084324ae

Copy link

netlify bot commented May 6, 2025

Deploy Preview for cockroachdb-api-docs canceled.

Name Link
🔨 Latest commit 6a87581
🔍 Latest deploy log https://app.netlify.com/sites/cockroachdb-api-docs/deploys/681e78c6bbd5a70008c7db6e

Copy link

netlify bot commented May 6, 2025

Netlify Preview

Name Link
🔨 Latest commit 6a87581
🔍 Latest deploy log https://app.netlify.com/sites/cockroachdb-docs/deploys/681e78c6613b0e0008972d17
😎 Deploy Preview https://deploy-preview-19588--cockroachdb-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@katmayb katmayb force-pushed the headers-kafka-cdc-25.2 branch from 04d8216 to d3fe09b Compare May 7, 2025 14:19
@katmayb katmayb requested a review from asg0451 May 7, 2025 15:18
@katmayb
Copy link
Contributor Author

katmayb commented May 7, 2025

cc @rohan-joshi


The Kafka topic receives the message payload containing the row-level change:

~~~json
Copy link

Choose a reason for hiding this comment

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

can you also show the headers that would be received by kafka? rather than showing a query which would simulate it.

perhaps something like

| key | value | headers |
| A    |  {..}     | x=y, z=q|

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I don't know if I've covered how you want this — I added in a rendered table to make it easier to read. Lmk if you want a change

@katmayb katmayb requested a review from asg0451 May 9, 2025 21:54
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.

2 participants