json/docs/mkdocs/docs/features/binary_formats/bson.md

BSON

BSON, short for Binary JSON, is a binary-encoded serialization of JSON-like documents. Like JSON, BSON supports the embedding of documents and arrays within other documents and arrays. BSON also contains extensions that allow representation of data types that are not part of the JSON spec. For example, BSON has a Date type and a BinData type.

!!! abstract "References"

- [BSON Website](http://bsonspec.org) - the main source on BSON
- [BSON Specification](http://bsonspec.org/spec.html) - the specification

Byte layout

A BSON document is a length-prefixed sequence of elements. The first four bytes hold the total size of the document (little-endian int32), followed by the elements, and a final 0x00 byte ends the document. Each element starts with a one-byte type, followed by its key as a NUL-terminated string and the value, whose encoding depends on the type. Arrays are documents whose keys are the decimal indices "0", "1", ...; nesting is expressed by embedding documents. Because every document announces its size, a reader can skip over it without parsing its content. The top level of a BSON value is always a document, which is why only JSON objects can be serialized.

Consider the following JSON value (shown formatted for readability):

{
  "id": 300,
  "name": "json",
  "pi": 3.14,
  "tags": [
    "a",
    "b"
  ]
}

to_bson encodes it to 69 bytes (shown in hexadecimal; the encoding contains no whitespace). The colors mark the role of each byte: type/marker length/count/size data.

JSON	Bytes	Meaning
{	45 00 00 00	document size: 69 bytes (int32, little-endian)
"id": 300,	10 69 64 00 2C 01 00 00	int32 element; key as NUL-terminated string; value (little-endian)
"name": "json",	02 6E 61 6D 65 00 05 00 00 00 6A 73 6F 6E 00	string element; key; length incl. NUL (int32); NUL-terminated UTF-8 bytes
"pi": 3.14,	01 70 69 00 1F 85 EB 51 B8 1E 09 40	double element; key; value (little-endian)
"tags": [	04 74 61 67 73 00 17 00 00 00	array element; key; embedded document of 23 bytes (keys are the indices)
"a",	02 30 00 02 00 00 00 61 00	string element; key "0"; length 2; a + NUL
"b"	02 31 00 02 00 00 00 62 00	string element; key "1"; length 2; b + NUL
]	00	end of the array document
}	00	end of the document

Serialization

The library uses the following mapping from JSON values types to BSON types:

JSON value type	value/range	BSON type	marker
null	null	null	0x0A
boolean	true, false	boolean	0x08
number_integer	-9223372036854775808..-2147483649	int64	0x12
number_integer	-2147483648..2147483647	int32	0x10
number_integer	2147483648..9223372036854775807	int64	0x12
number_unsigned	0..2147483647	int32	0x10
number_unsigned	2147483648..9223372036854775807	int64	0x12
number_unsigned	9223372036854775808..18446744073709551615	uint64	0x11
number_float	any value	double	0x01
string	any value	string	0x02
array	any value	document	0x04
object	any value	document	0x03
binary	any value	binary	0x05

!!! warning "Incomplete mapping"

The mapping is **incomplete**, since only JSON-objects (and things contained therein) can be serialized to BSON.
Also, keys may not contain U+0000, since they are serialized a zero-terminated c-strings.

!!! warning "BSON type 0x11 interoperability"

The BSON specification defines type `0x11` as a Timestamp. This library uses marker `0x11` when serializing
`number_unsigned` values in the range `9223372036854775808..18446744073709551615`. Other BSON implementations may
therefore interpret these values as Timestamps instead of unsigned integers.

!!! info "Binary values without a subtype"

BSON requires every binary value to have a subtype. If a binary value has no subtype, this library serializes it
with the generic subtype `0x00`. After deserialization, `has_subtype()` returns `true` and `subtype()` returns `0`.
As a result, serializing and deserializing a JSON object containing such a value produces a different JSON object,
even though the binary data is unchanged.

??? example "Example: serialize a JSON value to BSON"

```cpp
--8<-- "examples/to_bson.cpp"
```

Output:

```c
--8<-- "examples/to_bson.output"
```

Deserialization

The library maps BSON record types to JSON value types as follows:

BSON type	BSON marker byte	JSON value type
double	0x01	number_float
string	0x02	string
document	0x03	object
array	0x04	array
binary	0x05	binary
undefined	0x06	unsupported
ObjectId	0x07	unsupported
boolean	0x08	boolean
UTC Date-Time	0x09	unsupported
null	0x0A	null
Regular Expr.	0x0B	unsupported
DB Pointer	0x0C	unsupported
JavaScript Code	0x0D	unsupported
Symbol	0x0E	unsupported
JavaScript Code w/ scope	0x0F	unsupported
int32	0x10	number_integer
uint64(Timestamp)	0x11	number_unsigned
int64	0x12	number_integer
128-bit decimal float	0x13	unsupported
Max Key	0x7F	unsupported
Min Key	0xFF	unsupported

!!! warning "Incomplete mapping"

The mapping is **incomplete**. The unsupported mappings are indicated in the table above.

!!! note "Handling of BSON type 0x11"

This library deserializes BSON type `0x11` (Timestamp) as a `number_unsigned` value. The 64-bit value is preserved,
but the Timestamp type information is not.

!!! warning "Lenient BSON input handling"

The BSON reader is lenient in a few areas where the BSON specification is more restrictive:

- array element keys are not checked against the required decimal sequence (`0`, `1`, `2`, ...),
- any non-zero byte is accepted as `true` for the boolean type, and
- the payload for binary subtype `0x02` is returned as-is, including its inner length prefix.

If BSON input must be validated for strict specification compliance, validate it separately before passing it to
`from_bson()`.

!!! warning "Ill-formed UTF-8 in string values"

The BSON specification requires `string` values (type `0x02`) to be valid UTF-8, but this is not required of a
decoder, so checking is opt-in: with the [`error_handler`](../../api/basic_json/from_bson.md) parameter left at
`keep` (the default), `from_bson()` accepts a `string` value whose bytes are not valid UTF-8 and hands them back
unchanged. Passing `error_handler_t::strict` makes `from_bson()` check and throw
[`parse_error.113`](../../home/exceptions.md#jsonexceptionparse_error113) for ill-formed UTF-8, and
`replace`/`ignore` sanitize the string instead of keeping it. However, [`dump()`](../../api/basic_json/dump.md)
still requires valid UTF-8 and throws [`type_error.316`](../../home/exceptions.md#jsonexceptiontype_error316) for a
value read with the default `keep` handler, unless an error handler is passed that replaces or ignores the
ill-formed bytes. `to_bson()`'s own `error_handler` parameter defaults to `keep`, so such a string value or element
(key) name is written unchanged; with `strict` (the default if
[`JSON_STRICT_BINARY_UTF8`](../../api/macros/json_strict_binary_utf8.md) is enabled), it throws the same exception
instead. Element (key) names are never validated on read, since they are read byte-by-byte as a C string. `binary`
values (type `0x05`) are unaffected, since they are not required to hold text.

??? example "Example: deserialize a JSON value from BSON"

```cpp
--8<-- "examples/from_bson.cpp"
```

Output:

```json
--8<-- "examples/from_bson.output"
```