Skip to content

Add docs for the changefeed kafka header option#19588

Merged
katmayb merged 2 commits intomainfrom
headers-kafka-cdc-25.2
May 13, 2025
Merged

Add docs for the changefeed kafka header option#19588
katmayb merged 2 commits intomainfrom
headers-kafka-cdc-25.2

Conversation

@katmayb
Copy link
Copy Markdown
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

@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 6, 2025

@netlify
Copy link
Copy Markdown

netlify Bot commented May 6, 2025

Deploy Preview for cockroachdb-interactivetutorials-docs canceled.

Name Link
🔨 Latest commit 5dce98c
🔍 Latest deploy log https://app.netlify.com/sites/cockroachdb-interactivetutorials-docs/deploys/68233678d2cc51000809eb18

@netlify
Copy link
Copy Markdown

netlify Bot commented May 6, 2025

Deploy Preview for cockroachdb-api-docs canceled.

Name Link
🔨 Latest commit 5dce98c
🔍 Latest deploy log https://app.netlify.com/sites/cockroachdb-api-docs/deploys/68233678b80ef100089b963b

@netlify
Copy link
Copy Markdown

netlify Bot commented May 6, 2025

Netlify Preview

Name Link
🔨 Latest commit 5dce98c
🔍 Latest deploy log https://app.netlify.com/sites/cockroachdb-docs/deploys/68233678b4ebe90008f6004f
😎 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
Copy Markdown
Contributor Author

katmayb commented May 7, 2025

cc @rohan-joshi

Comment thread src/current/v25.2/changefeed-messages.md Outdated

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

~~~json
Copy link
Copy Markdown
Contributor

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
Copy Markdown
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

Comment thread src/current/v25.2/changefeed-messages.md Outdated
Comment thread src/current/v25.2/changefeed-messages.md Outdated
Comment thread src/current/v25.2/changefeed-messages.md Outdated
Comment thread src/current/v25.2/create-changefeed.md Outdated
@katmayb katmayb requested a review from asg0451 May 9, 2025 21:54
@katmayb katmayb requested a review from rmloveland May 12, 2025 17:57
Copy link
Copy Markdown
Contributor

@rmloveland rmloveland left a comment

Choose a reason for hiding this comment

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

LGTM

@katmayb katmayb force-pushed the headers-kafka-cdc-25.2 branch from 6a87581 to 5dce98c Compare May 13, 2025 12:09
@katmayb katmayb merged commit 79a68c9 into main May 13, 2025
6 checks passed
@katmayb katmayb deleted the headers-kafka-cdc-25.2 branch May 13, 2025 12:20
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.

3 participants