BSONEachRow

Вход	Выход	Псевдоним
✔	✔

Описание

Формат BSONEachRow разбирает данные как последовательность документов в формате Binary JSON (BSON) без каких-либо разделителей между ними. Каждая строка представлена одним документом, а каждый столбец — одним полем BSON-документа, где в качестве ключа используется имя столбца.

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

При выводе используется следующее соответствие между типами ClickHouse и типами BSON:

Тип ClickHouse	Тип BSON
Bool	`\x08` boolean
Int8/UInt8/Enum8	`\x10` int32
Int16/UInt16/Enum16	`\x10` int32
Int32	`\x10` int32
UInt32	`\x12` int64
Int64/UInt64	`\x12` int64
Float32/Float64	`\x01` double
Date/Date32	`\x10` int32
DateTime	`\x12` int64
DateTime64	`\x09` datetime
Decimal32	`\x10` int32
Decimal64	`\x12` int64
Decimal128	`\x05` binary, `\x00` подтип binary, размер = 16
Decimal256	`\x05` binary, `\x00` подтип binary, размер = 32
Int128/UInt128	`\x05` binary, `\x00` подтип binary, размер = 16
Int256/UInt256	`\x05` binary, `\x00` подтип binary, размер = 32
String/FixedString	`\x05` binary, `\x00` подтип binary или \x02 string, если включена настройка output_format_bson_string_as_string
UUID	`\x05` binary, `\x04` подтип uuid, размер = 16
Array	`\x04` array
Tuple	`\x04` array
Named Tuple	`\x03` document
Map	`\x03` document
IPv4	`\x10` int32
IPv6	`\x05` binary, `\x00` подтип binary

При вводе используется следующее соответствие между типами BSON и типами ClickHouse:

Тип BSON	Тип ClickHouse
`\x01` double	Float32/Float64
`\x02` string	String/FixedString
`\x03` document	Map/Named Tuple
`\x04` array	Array/Tuple
`\x05` binary, `\x00` двоичный подтип	String/FixedString/IPv6
`\x05` binary, `\x02` старый двоичный подтип	String/FixedString
`\x05` binary, `\x03` старый подтип uuid	UUID
`\x05` binary, `\x04` подтип uuid	UUID
`\x07` ObjectId	String/FixedString
`\x08` boolean	Bool
`\x09` datetime	DateTime64
`\x0A` null value	NULL
`\x0D` JavaScript code	String/FixedString
`\x0E` symbol	String/FixedString
`\x10` int32	Int32/UInt32/Decimal32/IPv4/Enum8/Enum16
`\x12` int64	Int64/UInt64/Decimal64/DateTime64

Другие типы BSON не поддерживаются. Кроме того, выполняется преобразование между различными целочисленными типами. Например, можно вставить значение BSON типа int32 в ClickHouse как UInt8.

Большие целые и десятичные числа, такие как Int128/UInt128/Int256/UInt256/Decimal128/Decimal256, могут быть получены при разборе значения BSON типа Binary с двоичным подтипом \x00. В этом случае формат проверяет, что размер двоичных данных равен размеру ожидаемого значения.

Примечание

Этот формат работает некорректно на платформах с порядком байтов Big-Endian.

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

Вставка данных

Используем BSON-файл со следующими данными с именем football.bson:

    ┌───────date─┬─season─┬─home_team─────────────┬─away_team───────────┬─home_team_goals─┬─away_team_goals─┐
 1. │ 2022-04-30 │   2021 │ Sutton United         │ Bradford City       │               1 │               4 │
 2. │ 2022-04-30 │   2021 │ Swindon Town          │ Barrow              │               2 │               1 │
 3. │ 2022-04-30 │   2021 │ Tranmere Rovers       │ Oldham Athletic     │               2 │               0 │
 4. │ 2022-05-02 │   2021 │ Port Vale             │ Newport County      │               1 │               2 │
 5. │ 2022-05-02 │   2021 │ Salford City          │ Mansfield Town      │               2 │               2 │
 6. │ 2022-05-07 │   2021 │ Barrow                │ Northampton Town    │               1 │               3 │
 7. │ 2022-05-07 │   2021 │ Bradford City         │ Carlisle United     │               2 │               0 │
 8. │ 2022-05-07 │   2021 │ Bristol Rovers        │ Scunthorpe United   │               7 │               0 │
 9. │ 2022-05-07 │   2021 │ Exeter City           │ Port Vale           │               0 │               1 │
10. │ 2022-05-07 │   2021 │ Harrogate Town A.F.C. │ Sutton United       │               0 │               2 │
11. │ 2022-05-07 │   2021 │ Hartlepool United     │ Colchester United   │               0 │               2 │
12. │ 2022-05-07 │   2021 │ Leyton Orient         │ Tranmere Rovers     │               0 │               1 │
13. │ 2022-05-07 │   2021 │ Mansfield Town        │ Forest Green Rovers │               2 │               2 │
14. │ 2022-05-07 │   2021 │ Newport County        │ Rochdale            │               0 │               2 │
15. │ 2022-05-07 │   2021 │ Oldham Athletic       │ Crawley Town        │               3 │               3 │
16. │ 2022-05-07 │   2021 │ Stevenage Borough     │ Salford City        │               4 │               2 │
17. │ 2022-05-07 │   2021 │ Walsall               │ Swindon Town        │               0 │               3 │
    └────────────┴────────┴───────────────────────┴─────────────────────┴─────────────────┴─────────────────┘

Вставьте данные:

INSERT INTO football FROM INFILE 'football.bson' FORMAT BSONEachRow;

Чтение данных

Считывайте данные в формате BSONEachRow:

SELECT *
FROM football INTO OUTFILE 'docs_data/bson/football.bson'
FORMAT BSONEachRow

Совет

BSON — это двоичный формат, который не отображается в человекочитаемом виде в терминале. Используйте INTO OUTFILE для вывода файлов BSON.

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

Параметр	Описание	Значение по умолчанию
`output_format_bson_string_as_string`	Использовать тип BSON String вместо Binary для строковых столбцов.	`false`
`input_format_bson_skip_fields_with_unsupported_types_in_schema_inference`	Разрешить пропуск столбцов с неподдерживаемыми типами при определении схемы для формата BSONEachRow.	`false`

Описание​

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

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

Вставка данных​

Чтение данных​

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