Перейти к основному содержимому
Перейти к основному содержимому

CapnProto

Not supported in ClickHouse Cloud
ВходВыходПсевдоним

Описание

Формат CapnProto — это бинарный формат сообщений, похожий на формат Protocol Buffers и Thrift, но не похожий на JSON или MessagePack. Сообщения CapnProto строго типизированы и не самоописываемы, что означает, что им необходима внешняя схема описания. Схема применяется на лету и кешируется для каждого запроса.

Смотрите также Схема формата.

Соответствие типов данных

В таблице ниже показаны поддерживаемые типы данных и то, как они соответствуют типам данных ClickHouse data types в запросах INSERT и SELECT.

Тип данных CapnProto (INSERT)Тип данных ClickHouseТип данных CapnProto (SELECT)
UINT8, BOOLUInt8UINT8
INT8Int8INT8
UINT16UInt16, DateUINT16
INT16Int16INT16
UINT32UInt32, DateTimeUINT32
INT32Int32, Decimal32INT32
UINT64UInt64UINT64
INT64Int64, DateTime64, Decimal64INT64
FLOAT32Float32FLOAT32
FLOAT64Float64FLOAT64
TEXT, DATAString, FixedStringTEXT, DATA
union(T, Void), union(Void, T)Nullable(T)union(T, Void), union(Void, T)
ENUMEnum(8/16)ENUM
LISTArrayLIST
STRUCTTupleSTRUCT
UINT32IPv4UINT32
DATAIPv6DATA
DATAInt128/UInt128/Int256/UInt256DATA
DATADecimal128/Decimal256DATA
STRUCT(entries LIST(STRUCT(key Key, value Value)))MapSTRUCT(entries LIST(STRUCT(key Key, value Value)))
  • Целочисленные типы могут конвертироваться в другие во время ввода/вывода.
  • Для работы с Enum в формате CapnProto используйте настройку format_capn_proto_enum_comparising_mode.
  • Массивы могут быть вложенными и могут иметь значение типа Nullable в качестве аргумента. Типы Tuple и Map также могут быть вложенными.

Пример использования

Вставка и выборка данных

Вы можете вставить данные CapnProto из файла в таблицу ClickHouse, используя следующую команду:

Где schema.capnp выглядит следующим образом:

Вы можете выбрать данные из таблицы ClickHouse и сохранить их в файл в формате CapnProto, используя следующую команду:

Использование сгенерированной схемы

Если у вас нет внешней схемы CapnProto для ваших данных, вы все равно можете выводить/вводить данные в формате CapnProto, используя сгенерированную схему.

Например:

В этом случае ClickHouse автоматически сгенерирует схему CapnProto в соответствии со структурой таблицы с помощью функции structureToCapnProtoSchema и будет использовать эту схему для сериализации данных в формате CapnProto.

Вы также можете прочитать файл CapnProto с сгенерированной схемой (в этом случае файл должен быть создан с использованием той же схемы):

Настройки формата

Настройка format_capn_proto_use_autogenerated_schema включена по умолчанию и применяется, если format_schema не задана.

Вы также можете сохранить сгенерированную схему в файл во время ввода/вывода, используя настройку output_format_schema.

Например:

В этом случае сгенерированная схема CapnProto будет сохранена в файл path/to/schema/schema.capnp.