サーバーパケット

値	名前	説明
0	Hello	サーバーハンドシェイク応答
1	Data	クライアントデータと同じ
2	Exception	クエリ処理例外
3	Progress	クエリの進捗
4	Pong	Ping応答
5	EndOfStream	すべてのパケットが転送されました
6	ProfileInfo	プロファイリングデータ
7	Totals	合計値
8	Extremes	極端な値（最小、最大）
9	TablesStatusResponse	TableStatusリクエストへの応答
10	Log	クエリシステムログ
11	TableColumns	カラムの説明
12	UUIDs	ユニークパーツIDのリスト
13	ReadTaskRequest	次のタスクが必要なリクエストを表す文字列（UUID）
14	ProfileEvents	サーバーからのプロファイルイベントを含むパケット

Data、Totals、および Extremes は圧縮可能です。

Hello

クライアントハローへの応答。

フィールド	種類	値	説明
name	String	Clickhouse	サーバー名
version_major	UVarInt	21	サーバーのメジャーバージョン
version_minor	UVarInt	12	サーバーのマイナーバージョン
revision	UVarInt	54452	サーバーのリビジョン
tz	String	Europe/Moscow	サーバーのタイムゾーン
display_name	String	Clickhouse	UI用のサーバー名
version_patch	UVarInt	3	サーバーのパッチバージョン

Exception

クエリ処理中のサーバー例外。

フィールド	種類	値	説明
code	Int32	60	ErrorCodes.cppを参照。
name	String	DB::Exception	サーバーのメジャーバージョン
message	String	DB::Exception: Table X doesn't exist	サーバーのマイナーバージョン
stack_trace	String	~	C++スタックトレース
nested	Bool	true	追加のエラー

nestedがfalseになるまで連続する例外のリストになる可能性があります。

Progress

サーバーによって定期的に報告されるクエリ実行の進捗。

ヒント

進捗はデルタで報告されます。合計はクライアント側で蓄積します。

フィールド	種類	値	説明
rows	UVarInt	65535	行のカウント
bytes	UVarInt	871799	バイトカウント
total_rows	UVarInt	0	合計行数
wrote_rows	UVarInt	0	クライアントからの行数
wrote_bytes	UVarInt	0	クライアントからのバイト数

Pong

クライアントPingへの応答。パケットボディはありません。

End of stream

これ以上のDataパケットは送信されず、クエリ結果はサーバーからクライアントに完全にストリーミングされます。

パケットボディはありません。

Profile info

フィールド	種類
rows	UVarInt
blocks	UVarInt
bytes	UVarInt
applied_limit	Bool
rows_before_limit	UVarInt
calculated_rows_before_limit	Bool

Log

サーバーログを含むデータブロック。

ヒント

データブロックのカラムとしてエンコードされていますが、圧縮されることはありません。

カラム	種類
time	DateTime
time_micro	UInt32
host_name	String
query_id	String
thread_id	UInt64
priority	Int8
source	String
text	String

Profile events

プロファイルイベントを含むデータブロック。

ヒント

データブロックのカラムとしてエンコードされていますが、圧縮されることはありません。

valueの型はサーバーのリビジョンに応じてUInt64またはInt64です。

カラム	種類
host_name	String
current_time	DateTime
thread_id	UInt64
type	Int8
name	String
value	UInt64またはInt64