Skip to content

Docs: [Kafka Sink] Update compatibility and Java client configuration - #113222

Merged
Blargian merged 2 commits into
masterfrom
codex/migrate-kafka-sink-docs-6606
Aug 4, 2026
Merged

Docs: [Kafka Sink] Update compatibility and Java client configuration#113222
Blargian merged 2 commits into
masterfrom
codex/migrate-kafka-sink-docs-6606

Conversation

@dhtclk

@dhtclk dhtclk commented Aug 4, 2026

Copy link
Copy Markdown
Contributor

Related: ClickHouse/clickhouse-docs#6606

Migrate the Kafka Connect Sink documentation update from the former documentation repository into ClickHouse/ClickHouse. This updates the compatibility matrix, documents the client_version setting, and explains how to configure the Java client network buffer through jdbcConnectionProperties.

The two substantive source commits retain Sergey Chernov's authorship and original author dates. The merge-only source commit is omitted because it contains no documentation changes.

Changelog category (leave one):

  • Documentation (changelog entry is not required)

Changelog entry (a user-readable short description of the changes that goes into CHANGELOG.md):

Not applicable.

Version info

  • Merged into: 26.8.1.729 (included in 26.8 and later)

@mintlify

mintlify Bot commented Aug 4, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
ClickHouse-docs 🟢 Ready View Preview Aug 4, 2026, 2:31 AM

@clickhouse-gh

clickhouse-gh Bot commented Aug 4, 2026

Copy link
Copy Markdown
Contributor

Workflow [PR], commit [3c871f4]

Summary:


AI Review

Summary

This PR migrates and refreshes the ClickHouse Kafka Connect Sink documentation by expanding the compatibility matrix, documenting client_version, and adding guidance for configuring the Java client network buffer. The new buffer section is directionally correct, but the page still contains a contradictory timeout example that sends Java client options through clickhouseSettings, so I would not merge it without that consistency fix.

Findings
⚠️ Majors

[docs/integrations/connectors/data-ingestion/kafka/kafka-clickhouse-connect-sink.mdx:884] The new paragraph says Java client options belong in jdbcConnectionProperties, but the preceding Connection pooling and timeouts example still configures socket_timeout and connection_timeout via clickhouseSettings. In the connector implementation, jdbcConnectionProperties is appended to the client URL while clickhouseSettings are passed as per-query server settings, so the page now documents two incompatible ways to configure the same class of client-side options. Update the earlier timeout example and wording in the same PR so users do not keep putting client options into clickhouseSettings.

Final Verdict

Changes requested.

@clickhouse-gh clickhouse-gh Bot added the pr-documentation Documentation PRs for the specific code PR label Aug 4, 2026

When using client V2 (`"client_version": "V2"`), data is copied between the socket and application memory through a buffer controlled by `client_network_buffer_size` (in bytes). The default size is `300000` bytes. A larger buffer can improve throughput on high-latency or high-bandwidth links, but increases memory usage per connection task.

All client options are configured via `jdbcConnectionProperties` rather than `clickhouseSettings`. For example:

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.

The clarification in this paragraph matches the connector implementation, but it leaves the page self-contradictory because the Connection pooling and timeouts section right above still tells users to put socket_timeout and connection_timeout into clickhouseSettings. In the current connector code, jdbcConnectionProperties is appended to the client URL, while clickhouseSettings are passed as per-query server settings, so following the timeout example would configure those client-side options in the wrong place. Please update the earlier timeout example and the surrounding wording in the same PR so all Java client options are documented consistently.

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.

Here is followup PR #113236

@dhtclk
dhtclk marked this pull request as ready for review August 4, 2026 02:11
@dhtclk
dhtclk requested a review from a team as a code owner August 4, 2026 02:11
@Blargian Blargian changed the title [Kafka Sink] Update compatibility and Java client configuration Docs: [Kafka Sink] Update compatibility and Java client configuration Aug 4, 2026
@Blargian
Blargian added this pull request to the merge queue Aug 4, 2026
Merged via the queue into master with commit da2a121 Aug 4, 2026
180 checks passed
@Blargian
Blargian deleted the codex/migrate-kafka-sink-docs-6606 branch August 4, 2026 06:44
@robot-ch-test-poll4 robot-ch-test-poll4 added the pr-synced-to-cloud The PR is synced to the cloud repo label Aug 4, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

pr-documentation Documentation PRs for the specific code PR pr-synced-to-cloud The PR is synced to the cloud repo

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants