Основы

Примечание

Справочник по клиентскому протоколу находится в разработке.

Большинство примеров приведено только на Go.

Этот документ описывает бинарный протокол для TCP‑клиентов ClickHouse.

Varint

Для длин, кодов пакетов и в других случаях используется кодирование в формате unsigned varint. Используйте binary.PutUvarint и binary.ReadUvarint.

Примечание

Signed varint не используется.

Строка

Строки переменной длины кодируются как (длина, значение), где длина — это varint, а значение — строка в кодировке UTF-8.

Справочные материалы

Проверяйте длину, чтобы избежать OOM:

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

// Проверяем n, чтобы предотвратить OOM или исключение времени выполнения в make().
const maxSize = 1024 * 1024 * 10 // 10 МБ
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,
}

Целые числа

Совет

ClickHouse использует Little Endian для целых чисел фиксированной длины.

Int32

v := int32(1000)

// Кодирование.
buf := make([]byte, 8)
binary.LittleEndian.PutUint32(buf, uint32(v))

// Декодирование.
d := int32(binary.LittleEndian.Uint32(buf))
fmt.Println(d) // 1000

Hex-дамп

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

Base64

6AMAAAAAAAA

Boolean

Булевы значения представлены одним байтом: значение 1 соответствует true, а 0 — false.