|
| 1 | +.. _scala-bson: |
| 2 | + |
| 3 | +=================== |
| 4 | +BSON Implementation |
| 5 | +=================== |
| 6 | + |
| 7 | +.. facet:: |
| 8 | + :name: genre |
| 9 | + :values: reference |
| 10 | + |
| 11 | +.. meta:: |
| 12 | + :keywords: documents, storage, codec |
| 13 | + |
| 14 | +The BSON library comprehensively supports `BSON |
| 15 | +<https://bsonspec.org/>`__, the data storage and network transfer format |
| 16 | +that MongoDB uses for documents. BSON, short |
| 17 | +for Binary `JSON <https://www.json.org/json-en.html>`__, is a |
| 18 | +binary-encoded serialization of JSON-like documents. |
| 19 | + |
| 20 | +For everyday usage there are type aliases and companion objects |
| 21 | +available from the ``org.mongodb.scala.bson`` package. To learn more, |
| 22 | +see the `API documentation |
| 23 | +<{+api+}/org/mongodb/scala/bson/index.html>`__ for the Scala BSON |
| 24 | +implementation. |
| 25 | + |
| 26 | +The following sections describe aspects of the driver's BSON |
| 27 | +implementation: |
| 28 | + |
| 29 | +.. TODO add links |
| 30 | + |
| 31 | +- Documents: describes the driver’s support for BSON document |
| 32 | + representations |
| 33 | +- Macros: describes the case classes you can use to represent documents in a collection |
| 34 | +- Extended JSON: describes the driver’s support for MongoDB Extended |
| 35 | + JSON |
| 36 | + |
| 37 | +For advanced usage you might need to use ``org.bson`` directly. See the |
| 38 | +Java Sync driver documentation to learn about the following topics: |
| 39 | + |
| 40 | +- :driver:`Readers and Writers </java/sync/current/fundamentals/data-formats/codecs/#codec>`: describes |
| 41 | + the driver’s support for stream-based reading and writing of BSON documents |
| 42 | +- :driver:`Codec and CodecRegistry </java/sync/current/fundamentals/data-formats/codecs/>`: describes |
| 43 | + the driver’s Codec API, an abstraction for producing and consuming BSON document representations |
| 44 | + using the stream-based readers and writers |
0 commit comments