Skip to content

chore: link official specs of Native protocol and format #6425

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.

Sign up for GitHub

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

Merged
kavirajk merged 3 commits into from
Jun 22, 2026
Merged

chore: link official specs of Native protocol and format #6425

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
985a92d
chore: link official specs of Native protocol and format
kavirajk Jun 22, 2026
be697a2
chore: remove the deprecated TODO from floating exceptions
kavirajk Jun 22, 2026
647706d
chore: add specs to sidebar
kavirajk Jun 22, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion docs/integrations/interfaces/tcp.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,9 @@ doc_type: 'reference'
---


The native protocol is used in the [command-line client](/interfaces/cli), for inter-server communication during distributed query processing, and also in other C++ programs. Unfortunately, native ClickHouse protocol doesn't have formal specification yet, but it can be reverse-engineered from ClickHouse source code (starting [around here](https://github.com/ClickHouse/ClickHouse/tree/master/src/Client)) and/or by intercepting and analyzing TCP traffic.
The native protocol is used in the [command-line client](/interfaces/cli), for inter-server communication during distributed query processing, and also in other C++ programs.

ClickHouse provides official specifications for the native protocol and the columnar format it carries:

- [Native Protocol](/interfaces/specs/NativeProtocol) — packet framing, the connection state machine, version negotiation, and the body of every non-`Block` message.
- [Native Format](/interfaces/specs/NativeFormat) — the `Block` and column structure, the per-type encodings, and the compression frame. This format also appears outside the TCP protocol, for example with `FORMAT Native` over HTTP.
5 changes: 0 additions & 5 deletions plugins/floating-pages-exceptions.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,3 @@ use-cases/observability/clickstack/managed-onboarding/instrument-application.md
use-cases/observability/clickstack/managed-onboarding/tuning-clickstack-schema.md
use-cases/observability/clickstack/managed-onboarding/managed-getting-started.md

# NOTE(kavi): To be removed after core PRs are merged
# https://github.com/ClickHouse/ClickHouse/pull/106723

interfaces/specs/NativeProtocol.md
interfaces/specs/NativeFormat.md
Loading