基础知识

注意

客户端协议参考正在进行中。

大多数示例仅使用 Go 语言。

本文档描述了 ClickHouse TCP 客户端的二进制协议。

Varint

对于长度、数据包代码和其他情况，使用无符号 varint 编码。使用 binary.PutUvarint 和 binary.ReadUvarint。

注意

不使用有符号 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!

十六进制转储

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,
}

Integers

提示

ClickHouse 对固定大小的整数使用 Little Endian。

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

十六进制转储

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

Base64

6AMAAAAAAAA

Boolean

布尔值由单个字节表示，1 为 true，0 为 false。