基本

注記

クライアントプロトコルのリファレンスは進行中です。

ほとんどの例はGoのみで提供されています。

この文書はClickHouse TCPクライアントのバイナリプロトコルについて説明します。

Varint

長さ、パケットコードおよびその他のケースには、unsigned varint エンコーディングが使用されます。 binary.PutUvarint および binary.ReadUvarint を使用してください。

注記

Signed varintは使用されません。

String

可変長の文字列は (length, value) としてエンコードされ、length は varint、value はutf8文字列です。

参考

OOMを防ぐために長さを検証してください：

0 ≤ len < MAX

エンコード

s := "Hello, world!"

// Writing string length as uvarint.
buf := make([]byte, binary.MaxVarintLen64)
n := binary.PutUvarint(buf, uint64(len(s)))
buf = buf[:n]

// Writing string value.
buf = append(buf, s...)

デコード

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

// Read length.
n, err := binary.ReadUvarint(r)
if err != nil {
        panic(err)
}

// Check n to prevent OOM or runtime exception in make().
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)

// Encode.
buf := make([]byte, 8)
binary.LittleEndian.PutUint32(buf, uint32(v))

// Decode.
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です。