Overview
En esta guía, puede aprender a utilizar el formato de datos JSON extendido al interactuar con documentos MongoDB.
JSON es un formato de datos legible para humanos que representa los valores de objetos, arreglos, números, cadenas, booleanos y valores nulos. Este formato solo admite un subconjunto de tipos de datos BSON, que es el formato que MongoDB utiliza para almacenar datos. El formato JSON extendido es compatible con más tipos BSON, definiendo un conjunto reservado de claves con el prefijo "$" para representar información de tipo de campo que corresponde directamente a cada tipo en BSON.
Para obtener más información sobre JSON, BSON y Extended JSON, consulte el Entrada manual del servidorMongoDB JSON, BSON y recursos JSON extendidos.
Formatos JSON extendidos
MongoDB Extended JSON proporciona formatos de string para representar datos BSON. Cada formato cumple con la RFC JSON y satisface casos de uso específicos.
La siguiente tabla describe cada formato JSON extendido:
Nombre | Descripción |
|---|---|
Canónico | A string format that avoids loss of BSON type information during data conversions. This format prioritizes type preservation at the loss of human-readability and
interoperability with older formats. To specify this mode, pass bsoncxx::ExtendedJsonMode::k_canonical as a mode argument to the to_json() method. |
Relajado | A string format that describes BSON documents with some type information loss. This format prioritizes human-readability and interoperability at the loss of
certain type information. To specify this mode, pass bsoncxx::ExtendedJsonMode::k_relaxed as a mode argument to the to_json() method. |
Legacy | A string format that describes BSON documents with some type information loss. This format matches Relaxed Extended JSON with some exceptions. The C++ driver uses this mode by default. |
Nota
El driver C++ analiza el tipo $uuid Extended JSON de una string a un objeto b_binary de subtipo binario 4. Para obtener más información acerca del análisis de campos $uuid, consulte la sección reglas especiales para analizar campos $uuid en la especificación del Extended JSON.
Ejemplos de JSON extendidos
Los siguientes ejemplos muestran un documento que contiene un campo ObjectId, una fecha y un número largo representado en cada formato Extendido de JSON. Haz clic en la pestaña que corresponda al formato del ejemplo que desees ver:
{ "_id": { "$oid": "573a1391f29313caabcd9637" }, "createdAt": { "$date": { "$numberLong": "1601499609" }}, "numViews": { "$numberLong": "36520312" } }
{ "_id": { "$oid": "573a1391f29313caabcd9637" }, "createdAt": { "$date": "2020-09-30T18:22:51.648Z" }, "numViews": 36520312 }
{ "_id": { "$oid": "573a1391f29313caabcd9637" }, "createdAt": { "$date": "1601499771648" }, "numViews": 36520312 }
Leer JSON extendido
Se puede leer una string Extended JSON en un documento BSON de C++ llamando al método bsoncxx::from_json(). Este método analiza una string Extended JSON y devuelve un bsoncxx::document::value que contiene los datos.
El siguiente ejemplo muestra cómo puede leer un string JSON extendido en un documento BSON utilizando el método from_json():
bsoncxx::document::value doc = bsoncxx::from_json(R"( { "_id": {"$oid": "507f1f77bcf86cd799439011"}, "myNumber": {"$numberLong": "4794261"} } )");
Guardar Extended JSON
Puedes guardar una cadena Extended JSON utilizando el método bsoncxx::to_json(). Por defecto, este método devuelve la string JSON extendida en el formato heredado, pero puedes especificar formatos canónicos o relajados pasando un argumento mode.
Nota
Versión heredada
La opción de formato heredado indica al driver C++ que serialice los BSON types usando el formato Libbson Legacy Extended JSON. El driver utiliza esto como el modo por defecto.
Para obtener más información, consulta la página de Legacy Extended JSON en la documentación de la API del Driver C.
El método bsoncxx::to_json() está disponible para varios tipos del núcleo y de la librería estándar, incluidos array y document. El siguiente ejemplo convierte un valor document en una cadena Extended JSON en el formato canónico:
bsoncxx::builder::basic::document doc_builder; doc_builder.append(kvp("myNumber", 11223344)); doc_builder.append(kvp("myString", "String value")); bsoncxx::document::value doc = doc_builder.extract(); std::string json_str = bsoncxx::to_json(doc, bsoncxx::ExtendedJsonMode::k_canonical); std::cout << json_str << std::endl;
{"myNumber":{"$numberInt":"11223344"},"myString":"String value"}
Información Adicional
Documentación de la API
Para obtener más información sobre los tipos y métodos mencionados en esta guía, consulta la siguiente documentación de la API:
Páginas de manual del servidor
Para obtener más información sobre el Extended JSON, consulte MongoDB Extended JSON (v2) en el manual del servidor de MongoDB.