> ## Documentation Index
> Fetch the complete documentation index at: https://private-7c7dfe99-parallel-read-in-order-multi-part.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

> Documentation for the BSONEachRow format

# BSONEachRow

| Input | Output | Alias |
| - | - | - |
| ✔ | ✔ | |

<h2 id="description">
  Description
</h2>

The `BSONEachRow` format parses data as a sequence of Binary JSON (BSON) documents without any separator between them.
Each row is formatted as a single document and each column is formatted as a single BSON document field with the column name as a key.

<h2 id="data-types-matching">
  Data types matching
</h2>

For output it uses the following correspondence between ClickHouse types and BSON types:

| ClickHouse type | BSON Type |
| - | - |
| [Bool](/reference/data-types/boolean) | `\x08` boolean |
| [Int8/UInt8](/reference/data-types/int-uint)/[Enum8](/reference/data-types/enum) | `\x10` int32 |
| [Int16/UInt16](/reference/data-types/int-uint)/[Enum16](/reference/data-types/enum) | `\x10` int32 |
| [Int32](/reference/data-types/int-uint) | `\x10` int32 |
| [UInt32](/reference/data-types/int-uint) | `\x12` int64 |
| [Int64/UInt64](/reference/data-types/int-uint) | `\x12` int64 |
| [Float32/Float64](/reference/data-types/float) | `\x01` double |
| [Date](/reference/data-types/date)/[Date32](/reference/data-types/date32) | `\x10` int32 |
| [DateTime](/reference/data-types/datetime) | `\x12` int64 |
| [DateTime64](/reference/data-types/datetime64) | `\x09` datetime |
| [Decimal32](/reference/data-types/decimal) | `\x10` int32 |
| [Decimal64](/reference/data-types/decimal) | `\x12` int64 |
| [Decimal128](/reference/data-types/decimal) | `\x05` binary, `\x00` binary subtype, size = 16 |
| [Decimal256](/reference/data-types/decimal) | `\x05` binary, `\x00` binary subtype, size = 32 |
| [Int128/UInt128](/reference/data-types/int-uint) | `\x05` binary, `\x00` binary subtype, size = 16 |
| [Int256/UInt256](/reference/data-types/int-uint) | `\x05` binary, `\x00` binary subtype, size = 32 |
| [String](/reference/data-types/string)/[FixedString](/reference/data-types/fixedstring) | `\x05` binary, `\x00` binary subtype or \x02 string if setting output\_format\_bson\_string\_as\_string is enabled |
| [UUID](/reference/data-types/uuid) | `\x05` binary, `\x04` uuid subtype, size = 16 |
| [Array](/reference/data-types/array) | `\x04` array |
| [Tuple](/reference/data-types/tuple) | `\x04` array |
| [Named Tuple](/reference/data-types/tuple) | `\x03` document |
| [Map](/reference/data-types/map) | `\x03` document |
| [IPv4](/reference/data-types/ipv4) | `\x10` int32 |
| [IPv6](/reference/data-types/ipv6) | `\x05` binary, `\x00` binary subtype |

For input it uses the following correspondence between BSON types and ClickHouse types:

| BSON Type | ClickHouse Type |
| - | - |
| `\x01` double | [Float32/Float64](/reference/data-types/float) |
| `\x02` string | [String](/reference/data-types/string)/[FixedString](/reference/data-types/fixedstring) |
| `\x03` document | [Map](/reference/data-types/map)/[Named Tuple](/reference/data-types/tuple) |
| `\x04` array | [Array](/reference/data-types/array)/[Tuple](/reference/data-types/tuple) |
| `\x05` binary, `\x00` binary subtype | [String](/reference/data-types/string)/[FixedString](/reference/data-types/fixedstring)/[IPv6](/reference/data-types/ipv6) |
| `\x05` binary, `\x02` old binary subtype | [String](/reference/data-types/string)/[FixedString](/reference/data-types/fixedstring) |
| `\x05` binary, `\x03` old uuid subtype | [UUID](/reference/data-types/uuid) |
| `\x05` binary, `\x04` uuid subtype | [UUID](/reference/data-types/uuid) |
| `\x07` ObjectId | [String](/reference/data-types/string)/[FixedString](/reference/data-types/fixedstring) |
| `\x08` boolean | [Bool](/reference/data-types/boolean) |
| `\x09` datetime | [DateTime64](/reference/data-types/datetime64) |
| `\x0A` null value | [NULL](/reference/data-types/nullable) |
| `\x0D` JavaScript code | [String](/reference/data-types/string)/[FixedString](/reference/data-types/fixedstring) |
| `\x0E` symbol | [String](/reference/data-types/string)/[FixedString](/reference/data-types/fixedstring) |
| `\x10` int32 | [Int32/UInt32](/reference/data-types/int-uint)/[Decimal32](/reference/data-types/decimal)/[IPv4](/reference/data-types/ipv4)/[Enum8/Enum16](/reference/data-types/enum) |
| `\x12` int64 | [Int64/UInt64](/reference/data-types/int-uint)/[Decimal64](/reference/data-types/decimal)/[DateTime64](/reference/data-types/datetime64) |

Other BSON types are not supported. Additionally, it performs conversion between different integer types.
For example, it is possible to insert a BSON `int32` value into ClickHouse as [`UInt8`](/reference/data-types/int-uint).

Big integers and decimals such as `Int128`/`UInt128`/`Int256`/`UInt256`/`Decimal128`/`Decimal256` can be parsed from a BSON Binary value with the `\x00` binary subtype.
In this case, the format will validate that the size of the binary data equals the size of the expected value.

<Note>
  This format does not work properly on Big-Endian platforms.
</Note>

<h2 id="example-usage">
  Example usage
</h2>

<h3 id="inserting-data">
  Inserting data
</h3>

Using a BSON file with the following data, named as `football.bson`:

```text theme={null}
    ┌───────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 the data:

```sql theme={null}
INSERT INTO football FROM INFILE 'football.bson' FORMAT BSONEachRow;
```

<h3 id="reading-data">
  Reading data
</h3>

Read data using the `BSONEachRow` format:

```sql theme={null}
SELECT *
FROM football INTO OUTFILE 'docs_data/bson/football.bson'
FORMAT BSONEachRow
```

<Tip>
  BSON is a binary format that does not display in a human-readable form on the terminal. Use the `INTO OUTFILE` to output BSON files.
</Tip>

<h2 id="format-settings">
  Format settings
</h2>

| Setting | Description | Default |
| - | - | - |
| [`output_format_bson_string_as_string`](/reference/settings/formats/output-format#output_format_bson_string_as_string) | Use BSON String type instead of Binary for String columns. | `false` |
| [`input_format_bson_skip_fields_with_unsupported_types_in_schema_inference`](/reference/settings/formats/input-format#input_format_bson_skip_fields_with_unsupported_types_in_schema_inference) | Allow skipping columns with unsupported types while schema inference for format BSONEachRow. | `false` |