サーバーパケット
value | name | description |
---|---|---|
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
クライアントhello へのレスポンス。
field | type | value | description |
---|---|---|---|
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
クエリ処理中のサーバー例外。
field | type | value | description |
---|---|---|---|
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
クエリ実行の進捗がサーバーから定期的に報告されます。
ヒント
進捗はデルタで報告されます。合計値はクライアント側で蓄積してください。
field | type | value | description |
---|---|---|---|
rows | UVarInt | 65535 | 行数 |
bytes | UVarInt | 871799 | バイト数 |
total_rows | UVarInt | 0 | 合計行数 |
wrote_rows | UVarInt | 0 | クライアントからの行数 |
wrote_bytes | UVarInt | 0 | クライアントからのバイト数 |
Pong
クライアントpingへのレスポンス、パケット本体はなし。
ストリームの終わり
これ以上のDataパケットは送信されず、クエリ結果はサーバーからクライアントに完全にストリーミングされます。
パケット本体はありません。
プロファイル情報
field | type |
---|---|
rows | UVarInt |
blocks | UVarInt |
bytes | UVarInt |
applied_limit | Bool |
rows_before_limit | UVarInt |
calculated_rows_before_limit | Bool |
Log
データブロックにサーバーログが含まれています。
ヒント
カラムのデータブロックとしてエンコードされていますが、圧縮されることはありません。
column | type |
---|---|
time | DateTime |
time_micro | UInt32 |
host_name | String |
query_id | String |
thread_id | UInt64 |
priority | Int8 |
source | String |
text | String |
プロファイルイベント
データブロックにプロファイルイベントが含まれています。
ヒント
カラムのデータブロックとしてエンコードされていますが、圧縮されることはありません。
value
の型はサーバーのリビジョンに応じてUInt64
またはInt64
になります。
column | type |
---|---|
host_name | String |
current_time | DateTime |
thread_id | UInt64 |
type | Int8 |
name | String |
value | UInt64 or Int64 |