기본 사항

네이티브 프로토콜 기본 사항

클라이언트 프로토콜 참고 문서는 현재 작성 중입니다.

대부분의 예시는 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!"

// 문자열 길이를 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)
}

// make()에서 OOM 또는 런타임 예외가 발생하지 않도록 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는 고정 크기 정수형에 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

16진수 덤프

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

Base64

6AMAAAAAAAA

​

불리언

불리언 값은 1바이트로 표현되며, 1은 true이고 0은 false입니다.