> ## Documentation Index
> Fetch the complete documentation index at: https://private-7c7dfe99-mintlify-8a08bda2.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.
> Документация по CapnProto
# CapnProto
export const CloudNotSupportedBadge = () => {
return
Not supported in ClickHouse Cloud
;
};
| Ввод | Вывод | Псевдоним |
| ---- | ----- | --------- |
| ✔ | ✔ | |
## Описание
`CapnProto` — это формат бинарных сообщений, похожий на [`Protocol Buffers`](https://developers.google.com/protocol-buffers/) и [Thrift](https://en.wikipedia.org/wiki/Apache_Thrift), но не на [JSON](/ru/reference/formats/JSON/JSON) или [MessagePack](https://msgpack.org/).
Сообщения CapnProto строго типизированы и не являются самоописываемыми, то есть требуют внешнего описания схемы. Схема применяется на лету и кэшируется для каждого запроса.
См. также [Format Schema](/ru/reference/formats#formatschema).
## Сопоставление типов данных
В таблице ниже показаны поддерживаемые типы данных и их соответствие [типам данных](/ru/reference/data-types) ClickHouse в запросах `INSERT` и `SELECT`.
| Тип данных CapnProto (`INSERT`) | Тип данных ClickHouse | Тип данных CapnProto (`SELECT`) |
| ---------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------- |
| `UINT8`, `BOOL` | [UInt8](/ru/reference/data-types/int-uint) | `UINT8` |
| `INT8` | [Int8](/ru/reference/data-types/int-uint) | `INT8` |
| `UINT16` | [UInt16](/ru/reference/data-types/int-uint), [Date](/ru/reference/data-types/date) | `UINT16` |
| `INT16` | [Int16](/ru/reference/data-types/int-uint) | `INT16` |
| `UINT32` | [UInt32](/ru/reference/data-types/int-uint), [DateTime](/ru/reference/data-types/datetime) | `UINT32` |
| `INT32` | [Int32](/ru/reference/data-types/int-uint), [Decimal32](/ru/reference/data-types/decimal) | `INT32` |
| `UINT64` | [UInt64](/ru/reference/data-types/int-uint) | `UINT64` |
| `INT64` | [Int64](/ru/reference/data-types/int-uint), [DateTime64](/ru/reference/data-types/datetime), [Decimal64](/ru/reference/data-types/decimal) | `INT64` |
| `FLOAT32` | [Float32](/ru/reference/data-types/float) | `FLOAT32` |
| `FLOAT64` | [Float64](/ru/reference/data-types/float) | `FLOAT64` |
| `TEXT, DATA` | [String](/ru/reference/data-types/string), [FixedString](/ru/reference/data-types/fixedstring) | `TEXT, DATA` |
| `union(T, Void), union(Void, T)` | [Nullable(T)](/ru/reference/data-types/date) | `union(T, Void), union(Void, T)` |
| `ENUM` | [Enum(8/16)](/ru/reference/data-types/enum) | `ENUM` |
| `LIST` | [Array](/ru/reference/data-types/array) | `LIST` |
| `STRUCT` | [Tuple](/ru/reference/data-types/tuple) | `STRUCT` |
| `UINT32` | [IPv4](/ru/reference/data-types/ipv4) | `UINT32` |
| `DATA` | [IPv6](/ru/reference/data-types/ipv6) | `DATA` |
| `DATA` | [Int128/UInt128/Int256/UInt256](/ru/reference/data-types/int-uint) | `DATA` |
| `DATA` | [Decimal128/Decimal256](/ru/reference/data-types/decimal) | `DATA` |
| `STRUCT(entries LIST(STRUCT(key Key, value Value)))` | [Map](/ru/reference/data-types/map) | `STRUCT(entries LIST(STRUCT(key Key, value Value)))` |
* Целочисленные типы можно преобразовывать друг в друга при вводе и выводе.
* Для работы с `Enum` в формате CapnProto используйте настройку [format\_capn\_proto\_enum\_comparising\_mode](/ru/reference/settings/formats#format_capn_proto_enum_comparising_mode).
* Массивы могут быть вложенными и принимать в качестве аргумента значение типа `Nullable`. Типы `Tuple` и `Map` также могут быть вложенными.
## Пример использования
### Вставка и выборка данных
Вы можете вставить данные CapnProto из файла в таблицу ClickHouse с помощью следующей команды:
```bash theme={null}
$ cat capnproto_messages.bin | clickhouse-client --query "INSERT INTO test.hits SETTINGS format_schema = 'schema:Message' FORMAT CapnProto"
```
При этом `schema.capnp` выглядит так:
```capnp theme={null}
struct Message {
SearchPhrase @0 :Text;
c @1 :Uint64;
}
```
Вы можете выбрать данные из таблицы ClickHouse и сохранить их в файл в формате `CapnProto` с помощью следующей команды:
```bash theme={null}
$ clickhouse-client --query = "SELECT * FROM test.hits FORMAT CapnProto SETTINGS format_schema = 'schema:Message'"
```
### Использование автоматически сгенерированной схемы
Если у вас нет внешней схемы `CapnProto` для ваших данных, вы всё равно можете выполнять вывод и ввод данных в формате `CapnProto`, используя автоматически сгенерированную схему.
Например:
```sql theme={null}
SELECT * FROM test.hits
FORMAT CapnProto
SETTINGS format_capn_proto_use_autogenerated_schema=1
```
В этом случае ClickHouse автоматически сгенерирует схему CapnProto в соответствии со структурой таблицы с помощью функции [structureToCapnProtoSchema](/ru/reference/functions/regular-functions/other-functions#structureToCapnProtoSchema) и будет использовать эту схему для сериализации данных в формате CapnProto.
Вы также можете читать файл CapnProto, используя автоматически сгенерированную схему (в этом случае файл должен быть создан с использованием той же схемы):
```bash theme={null}
$ cat hits.bin | clickhouse-client --query "INSERT INTO test.hits SETTINGS format_capn_proto_use_autogenerated_schema=1 FORMAT CapnProto"
```
## Настройки формата
Параметр [`format_capn_proto_use_autogenerated_schema`](/ru/reference/settings/formats#format_capn_proto_use_autogenerated_schema) включен по умолчанию и используется, если [`format_schema`](/ru/reference/formats#formatschema) не задан.
Вы также можете сохранить автоматически сгенерированную схему в файл при вводе/выводе с помощью параметра [`output_format_schema`](/ru/reference/settings/formats#output_format_schema).
Например:
```sql theme={null}
SELECT * FROM test.hits
FORMAT CapnProto
SETTINGS
format_capn_proto_use_autogenerated_schema=1,
output_format_schema='path/to/schema/schema.capnp'
```
В этом случае автоматически сгенерированная схема `CapnProto` будет сохранена в файле `path/to/schema/schema.capnp`.