メインコンテンツへスキップ
名前説明
0Helloクライアントハンドシェイクの開始
1Queryクエリリクエスト
2Dataデータを含むブロック
3キャンセルクエリのキャンセル
4PingPing リクエスト
5TableStatusテーブルステータスのリクエスト
Data は圧縮できます。

Hello

たとえば、54451 のプロトコルバージョンに対応した Go Client v1.10 を使用し、 default ユーザーと secret パスワードで default データベースに接続するとします。
フィールド説明
client_nameString"Go Client"クライアント実装名
version_majorUVarInt1クライアントのメジャーバージョン
version_minorUVarInt10クライアントのマイナーバージョン
protocol_versionUVarInt54451TCP プロトコルのバージョン
databaseString"default"データベース名
usernameString"default"ユーザー名
passwordString"secret"パスワード

プロトコルバージョン

プロトコルバージョンは、クライアントのTCPプロトコルのバージョンです。 通常、これは最新の互換性のあるサーバーリビジョンと同じですが、 これと混同しないでください。

デフォルト

すべての値は明示的に設定する必要があります。サーバー側にはデフォルト値はありません。 クライアント側では、デフォルトとして "default" データベース、"default" ユーザー名、"" (空文字列) の パスワードを使用します。

クエリ

フィールド説明
query_idString1ff-a123Query ID。UUIDv4も使用可能
client_infoClientInfo型を参照クライアントに関するデータ
settingsSettings型を参照設定の一覧
secretStringsecretサーバー間のシークレット
stageUVarInt2クエリステージまで実行する
compressionUVarInt0無効=0、有効=1
bodyStringSELECT 1クエリテキスト

クライアント情報

フィールド説明
query_kindbyteNone=0、Initial=1、Secondary=2
initial_userString初期ユーザー
initial_query_idString初期クエリ ID
initial_addressString初期アドレス
initial_timeInt64初期時刻
interfacebyteTCP=1、HTTP=2
os_userStringOSユーザー
client_hostnameStringクライアントのホスト名
client_nameStringクライアント名
version_majorUVarIntクライアントのメジャーバージョン
version_minorUVarIntクライアントのマイナーバージョン
protocol_versionUVarIntクライアントのプロトコルバージョン
quota_keyStringクォータキー
distributed_depthUVarIntDistributed の深度
version_patchUVarIntクライアントのパッチバージョン
otelBoolトレース関連フィールドが存在する
trace_idFixedString(16)トレース ID
span_idFixedString(8)スパン ID
trace_stateStringトレース状態
trace_flagsByteトレースフラグ

設定

フィールド説明
keyStringsend_logs_level設定のキー
valueStringtrace設定の値
importantBooltrue無視できるかどうか
リストとしてエンコードされ、キーと値が空であればリストの終端を示します。

Stage

名前説明
0FetchColumnsカラムの型のみ取得
1WithMergeableStateマージ可能な状態まで
2Complete完全な状態まで (デフォルトにするべき)

Data

フィールド説明
infoBlockInfoエンコード済みのブロック情報
columnsUVarIntカラム数
rowsUVarInt行数
columns[]カラムデータを含むカラム

カラム

フィールド説明
nameStringfooカラム名
typeStringDateTime64(9)カラムの型
databytes~カラムデータ

キャンセル

パケット本文はありません。サーバーはクエリをキャンセルする必要があります。

Ping

パケット本文はありません。サーバーはpong を返す必要があります。
最終更新日 2026年6月10日