Skip to content

kafka table engine, modernize table creation, add tip on limitations,… #3666

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 5 commits into
base: main
Choose a base branch
from

Conversation

randomizedcoder
Copy link

Summary

Minor improvements to the kafka table engine page

  • Tips on limitations of the kafka table engine ( no kafka schema, and no protobufList )
  • Modernize the table creation
  • Add links to full table creation options
  • Add extra debug command

Checklist

@randomizedcoder randomizedcoder requested review from a team as code owners April 13, 2025 16:19
Copy link

vercel bot commented Apr 13, 2025

@randomizedcoder is attempting to deploy a commit to the ClickHouse Team on Vercel.

A member of the Team first needs to authorize it.

Copy link

vercel bot commented Apr 14, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
clickhouse-docs ✅ Ready (Inspect) Visit Preview Apr 14, 2025 10:59am
2 Skipped Deployments
Name Status Preview Comments Updated (UTC)
clickhouse-docs-ru ⬜️ Ignored (Inspect) Visit Preview Apr 14, 2025 10:59am
clickhouse-docs-zh ⬜️ Ignored (Inspect) Visit Preview Apr 14, 2025 10:59am

@randomizedcoder
Copy link
Author

@chernser - g'day mate - How does this PR look please?

Copy link
Contributor

@gingerwizard gingerwizard left a comment

Choose a reason for hiding this comment

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

This contains factual inaccuracies i believe, @Blargian to confirm

:::tip
The Kafka Engine does have some limitations:
- [Kafka message header](https://docs.confluent.io/platform/current/schema-registry/fundamentals/serdes-develop/index.html#wire-format) is not currently supported, so schema registry cannot be used
- Protobuf, ProtobufSingle are supported, while [ProtobufList](https://github.com/ClickHouse/ClickHouse/issues/78746) is not
Copy link
Contributor

Choose a reason for hiding this comment

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

full stop needed but i believe this is supported @Blargian

Notes
[Full Kafka Engine Table creation options](https://clickhouse.com/docs/engines/table-engines/integrations/kafka#creating-a-table)

[kafka_format must be the last setting](https://github.com/ClickHouse/ClickHouse/issues/37895)
Copy link
Contributor

Choose a reason for hiding this comment

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

This is confusing, the link is with respect to INSERT commands not use in this table engine.

@randomizedcoder
Copy link
Author

@gingerwizard

Thanks for the feedback Dale

I've update the PR, please let me know if that looks ok

Regarding ProtobufList and Schemas - I've spent quite some time digging into this, and even have an open source repo which replicates the issues, and allows you see what is and is not supported. ( To be honest, I wasted ~1-2 months of elapsed time trying to get ProtobufList to work, which is why I wanted to warn others NOT to waste their time. )

Repo: https://github.com/randomizedcoder/gdp

Doc: https://docs.google.com/document/d/18vrd92pDs2Mj2FwAcCcPdDhAdCwN0lXM1WaoPkyntRY/edit?tab=t.0#heading=h.bw8lr0fzxz8p

If you have any issues running the example, please let me know.

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