Skip to content

Apache Flink connector docs#5527

Merged
kurnoolsaketh merged 19 commits intomainfrom
flink-connector-docs
Mar 13, 2026
Merged

Apache Flink connector docs#5527
kurnoolsaketh merged 19 commits intomainfrom
flink-connector-docs

Conversation

@kurnoolsaketh
Copy link
Contributor

@kurnoolsaketh kurnoolsaketh commented Feb 14, 2026

Summary

Introduce documentation for the official Flink connector. This doc page is adapted from the flink connector repo's README.

closes: ClickHouse/flink-connector-clickhouse#110

@vercel
Copy link

vercel bot commented Feb 14, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
clickhouse-docs Ready Ready Preview, Comment Mar 13, 2026 0:50am
clickhouse-docs-jp Building Building Preview, Comment Mar 13, 2026 0:50am
3 Skipped Deployments
Project Deployment Actions Updated (UTC)
clickhouse-docs-ko Ignored Ignored Preview Mar 13, 2026 0:50am
clickhouse-docs-ru Ignored Ignored Preview Mar 13, 2026 0:50am
clickhouse-docs-zh Ignored Ignored Preview Mar 13, 2026 0:50am

Request Review

@alexfrancoeur
Copy link
Contributor

The docs look great! A couple of small pieces of feedback, but lgtm overall. I can't wait to get these in there

I reviewed this preview on mobile: https://clickhouse-docs-9zj3bpftf-clickhouse.vercel.app/docs/integrations/apache-flink

  • The apache flink icon in the integrations view links to the repo still, we'll need to update in the CMS to link to these docs and make it consistent across the different entry points
  • I feel like we should link to the repo explicitly early in the docs with the connector name
  • I don't know if we need the "to be filled out later" section for the table api. We could probably just remove until it's added

Copy link
Contributor

@BentsiLeviav BentsiLeviav left a comment

Choose a reason for hiding this comment

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

Left a few comments. In addition, can we go over the repo and find relevant locations where Flink is mentioned, and make sure we link them to this page?

Found these locations, but we might have more:

@kurnoolsaketh
Copy link
Contributor Author

In addition, can we go over the repo and find relevant locations where Flink is mentioned, and make sure we link them to this page?

@BentsiLeviav yes - i confirmed the locations you identified are the only other mentions of flink in the repo besides the same pages in japanese & other languages. Should I update those as well?

@kurnoolsaketh
Copy link
Contributor Author

thanks @alexfrancoeur!

  • The apache flink icon in the integrations view links to the repo still, we'll need to update in the CMS to link to these docs and make it consistent across the different entry points

i've updated the flink icon link to point to the new docs page 👍

  • I feel like we should link to the repo explicitly early in the docs with the connector name

sure will do

  • I don't know if we need the "to be filled out later" section for the table api. We could probably just remove until it's added

yup, it's removed now

Comment on lines +367 to +370
## Advanced and recommended usage {#advanced-and-recommended-usage}

- For optimal performance, ensure your DataStream element type is **not** a Generic type - see [here for Flink's type distinction](https://nightlies.apache.org/flink/flink-docs-release-2.2/docs/dev/datastream/fault-tolerance/serialization/types_serialization/#flinks-typeinformation-class). Non-generic elements will avoid the serialization overhead incurred by Kryo and improve throughput to ClickHouse.
- We recommend setting `maxBatchSize` to at least 1000 and ideally between 10,000 to 100,000. See [this guide on bulk inserts](https://clickhouse.com/docs/optimize/bulk-inserts) for more information.
Copy link
Contributor Author

@kurnoolsaketh kurnoolsaketh Feb 27, 2026

Choose a reason for hiding this comment

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

items 12 and 15 in the doc matrix

Co-authored-by: Bentsi Leviav <bentsi.997@gmail.com>
@Blargian
Copy link
Member

Blargian commented Mar 2, 2026

In addition, can we go over the repo and find relevant locations where Flink is mentioned, and make sure we link them to this page?

@BentsiLeviav yes - i confirmed the locations you identified are the only other mentions of flink in the repo besides the same pages in japanese & other languages. Should I update those as well?

@kurnoolsaketh no need to update any of the translations, there is a bot which will open a PR after this gets merged with any updates to translations.

Copy link
Member

@Blargian Blargian left a comment

Choose a reason for hiding this comment

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

LGTM, with exception that static/integrations-fallback.json shouldn't be checked in I don't think

@kurnoolsaketh kurnoolsaketh merged commit b4d2b49 into main Mar 13, 2026
16 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.

Document recommended usage patterns and troubleshooting

6 participants