基本

ネイティブプロトコルの基本

クライアントプロトコルのリファレンスは現在作成中です。

例のほとんどは Go のみです。

このドキュメントでは、ClickHouse TCP クライアント向けのバイナリプロトコルについて説明します。

​

Varint

長さやパケットコードなどでは、符号なし varint エンコーディングを使用します。 binary.PutUvarint と binary.ReadUvarint を使用してください。

符号付き varint は使用しません。

​

文字列

可変長文字列は (length, value) の形式でエンコードされます。ここで length は varint、value は UTF-8 文字列です。

OOM を防ぐため、length を検証してください:

0 ≤ len < MAX

エンコード

s := "Hello, world!"

// 文字列の長さを uvarint として書き込む。
buf := make([]byte, binary.MaxVarintLen64)
n := binary.PutUvarint(buf, uint64(len(s)))
buf = buf[:n]

// 文字列本体を書き込む。
buf = append(buf, s...)

デコード

r := bytes.NewReader([]byte{
    0xd, 0x48, 0x65, 0x6c, 0x6c, 0x6f, 0x2c,
    0x20, 0x77, 0x6f, 0x72, 0x6c, 0x64, 0x21,
})

// 長さを読み取る。
n, err := binary.ReadUvarint(r)
if err != nil {
        panic(err)
}

// OOM や make() での実行時例外を防ぐために n を確認する。
const maxSize = 1024 * 1024 * 10 // 10 MB
if n > maxSize || n < 0 {
    panic("invalid n")
}

buf := make([]byte, n)
if _, err := io.ReadFull(r, buf); err != nil {
        panic(err)
}

fmt.Println(string(buf))
// Hello, world!

16進ダンプ

00000000  0d 48 65 6c 6c 6f 2c 20  77 6f 72 6c 64 21        |.Hello, world!|

Base64

DUhlbGxvLCB3b3JsZCE

Go

data := []byte{
    0xd, 0x48, 0x65, 0x6c, 0x6c, 0x6f, 0x2c,
    0x20, 0x77, 0x6f, 0x72, 0x6c, 0x64, 0x21,
}

​

整数

ClickHouse では、固定長整数に リトルエンディアン を使用します。

​

Int32

v := int32(1000)

// エンコード。
buf := make([]byte, 8)
binary.LittleEndian.PutUint32(buf, uint32(v))

// デコード。
d := int32(binary.LittleEndian.Uint32(buf))
fmt.Println(d) // 1000

16進ダンプ

00000000  e8 03 00 00 00 00 00 00                           |........|

Base64

6AMAAAAAAAA

​

真偽値

真偽値は1バイトで表され、1 は true、0 は false を表します。