メインコンテンツへスキップ
メインコンテンツへスキップ

サーバーパケット

valuenamedescription
0Helloサーバーからのハンドシェイク応答
1Dataクライアントデータ と同じ
2Exceptionクエリ処理時の例外
3Progressクエリの進行状況
4PongPing に対する応答
5EndOfStreamすべてのパケットが転送済み
6ProfileInfoプロファイリングデータ
7Totals合計値
8Extremes極値(最小値・最大値)
9TablesStatusResponseTableStatus リクエストへの応答
10Logクエリのシステムログ
11TableColumnsカラムの説明
12UUIDsパーツの一意 ID の一覧
13ReadTaskRequest次のタスクが必要なリクエストを表す文字列(UUID)
14ProfileEventsサーバーからのプロファイルイベントを含むパケット

DataTotalsExtremes は圧縮可能です。

Hello

client hello への応答。

fieldtypevaluedescription
nameStringClickhouseサーバー名
version_majorUVarInt21サーバーのメジャーバージョン
version_minorUVarInt12サーバーのマイナーバージョン
revisionUVarInt54452サーバーのリビジョン
tzStringEurope/Moscowサーバーのタイムゾーン
display_nameStringClickhouseUI 用のサーバー名
version_patchUVarInt3サーバーのパッチバージョン

例外

クエリ処理中にサーバーで発生した例外。

fieldtypevaluedescription
codeInt3260ErrorCodes.cpp を参照
nameStringDB::Exception例外クラス名
messageStringDB::Exception: Table X doesn't exist例外メッセージ
stack_traceString~C++ のスタックトレース
nestedBooltrueさらにネストされたエラー

nestedfalse になるまで、例外が連続したリストとして含まれる場合があります。

進捗

クエリ実行の進捗はサーバーから定期的に報告されます。

ヒント

進捗は差分として報告されます。累計値が必要な場合は、クライアント側で集計してください。

fieldtypevaluedescription
rowsUVarInt65535行数
bytesUVarInt871799バイト数
total_rowsUVarInt0総行数
wrote_rowsUVarInt0クライアントから書き込まれた行数
wrote_bytesUVarInt0クライアントから書き込まれたバイト数

Pong

クライアント ping に対する応答であり、パケット本文はありません。

ストリーム終了

以降 Data パケットは送信されず、クエリ結果はサーバーからクライアントへすべて送信済みです。

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

プロファイル情報

フィールド
rowsUVarInt
blocksUVarInt
bytesUVarInt
applied_limitBool
rows_before_limitUVarInt
calculated_rows_before_limitBool

Log

サーバーログを表すデータブロックです。

ヒント

列からなるデータブロックとしてエンコードされますが、圧縮されることはありません。

columntype
timeDateTime
time_microUInt32
host_nameString
query_idString
thread_idUInt64
priorityInt8
sourceString
textString

プロファイルイベント

プロファイルイベントの データブロック

ヒント

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

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

columntype
host_nameString
current_timeDateTime
thread_idUInt64
typeInt8
nameString
valueUInt64 or Int64