Skip to content

Commit 51b0045

Browse files
authored
Merge pull request #6425 from ClickHouse/kavirajk/link-official-specs-protocol-format
2 parents 382ad2c + 647706d commit 51b0045

3 files changed

Lines changed: 16 additions & 6 deletions

File tree

docs/integrations/interfaces/tcp.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,9 @@ doc_type: 'reference'
88
---
99

1010

11-
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.
11+
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)).
12+
13+
ClickHouse provides official specifications for the native protocol and the columnar format it carries:
14+
15+
- [Native Protocol](/interfaces/specs/NativeProtocol) — packet framing, the connection state machine, version negotiation, and the body of every non-`Block` message.
16+
- [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.

plugins/floating-pages-exceptions.txt

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,3 @@ use-cases/observability/clickstack/managed-onboarding/instrument-application.md
2020
use-cases/observability/clickstack/managed-onboarding/tuning-clickstack-schema.md
2121
use-cases/observability/clickstack/managed-onboarding/managed-getting-started.md
2222

23-
# NOTE(kavi): To be removed after core PRs are merged
24-
# https://github.com/ClickHouse/ClickHouse/pull/106723
25-
26-
interfaces/specs/NativeProtocol.md
27-
interfaces/specs/NativeFormat.md

sidebars.js

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -963,6 +963,16 @@ const sidebars = {
963963
'integrations/interfaces/arrowflight',
964964
],
965965
},
966+
{
967+
type: 'category',
968+
label: 'Specifications',
969+
collapsed: true,
970+
collapsible: true,
971+
items: [
972+
'interfaces/specs/NativeProtocol',
973+
'interfaces/specs/NativeFormat',
974+
],
975+
},
966976
'integrations/sql-clients/sql-console',
967977
'interfaces/third-party/index',
968978
],

0 commit comments

Comments
 (0)