diff --git a/docs/integrations/interfaces/tcp.md b/docs/integrations/interfaces/tcp.md index 2085d026724..f1438dfb1b1 100644 --- a/docs/integrations/interfaces/tcp.md +++ b/docs/integrations/interfaces/tcp.md @@ -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 some language clients (e.g. [clickhouse-go](/integrations/go#connection-details)). + +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. diff --git a/plugins/floating-pages-exceptions.txt b/plugins/floating-pages-exceptions.txt index 0e6068e8df3..69e434951c2 100644 --- a/plugins/floating-pages-exceptions.txt +++ b/plugins/floating-pages-exceptions.txt @@ -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 diff --git a/sidebars.js b/sidebars.js index 977e76e65e2..6e930aba098 100644 --- a/sidebars.js +++ b/sidebars.js @@ -963,6 +963,16 @@ const sidebars = { 'integrations/interfaces/arrowflight', ], }, + { + type: 'category', + label: 'Specifications', + collapsed: true, + collapsible: true, + items: [ + 'interfaces/specs/NativeProtocol', + 'interfaces/specs/NativeFormat', + ], + }, 'integrations/sql-clients/sql-console', 'interfaces/third-party/index', ],