JSON extendido

Overview

JSON es un formato de datos que representa los valores de objetos, matrices, números, cadenas, valores booleanos y nulos. El formato JSON extendido define un conjunto reservado de claves con el prefijo "$" para representar información de tipo de campo que corresponde directamente a cada tipo en BSON, el formato que MongoDB utiliza para almacenar datos.

Formatos JSON extendidos

MongoDB Extended JSON ofrece diferentes formatos de cadena para representar datos BSON. Cada formato cumple con la RFC de JSON y satisface casos de uso específicos. El formato extendido, también conocido como formato canónico, ofrece representaciones específicas para cada tipo de BSON, lo que permite una conversión bidireccional sin pérdida de información. El formato de modo relajado es más conciso y similar al JSON convencional, pero no representa toda la información de tipo, como el tamaño de bytes específico de los campos numéricos.

Consulte la siguiente tabla para ver una descripción de cada formato:

Para obtener más información sobre JSON, BSON y JSON extendido, consulte nuestro artículo sobre JSON, BSON y JSON extendido en el manual de MongoDB Server.

{
  "_id": { "$oid": "573a1391f29313caabcd9637" },
  "createdAt": { "$date": { "$numberLong": "1601499609" }},
  "numViews": { "$numberLong": "36520312" }
}

{
  "_id": { "$oid": "573a1391f29313caabcd9637" },
  "createdAt": { "$date": "2020-09-30T18:22:51.648Z" },
  "numViews": 36520312
}

{
  "_id": ObjectId("573a1391f29313caabcd9637"),
  "createdAt": ISODate("2020-09-30T18:22:51.648Z"),
  "numViews": NumberLong("36520312")
}

{
  "_id": { "$oid": "573a1391f29313caabcd9637" },
  "createdAt": { "$date": 1601499609 },
  "numViews": { "$numberLong": "36520312" }
}

Leer JSON extendido

Puedes leer una string extendida de JSON en un objeto de Python llamando al método bson.json_util.loads(). Este método analiza una string extendida de JSON y devuelve una lista de Python que contiene los datos.

El siguiente ejemplo muestra cómo se puede leer una cadena JSON extendida en una lista de diccionarios utilizando el método loads():

from bson.json_util import loads
ejson_str = '''[
   {"foo": [1, 2]},
   {"bar": {"hello": "world"}},
   {"code": {
      "$scope": {},
      "$code": "function x() { return 1; }"
   }},
   {"bin": {
      "$type": "80",
      "$binary": "AQIDBA=="
   }}
]'''
doc = loads(ejson_str)
print(doc)

[
   {'foo': [1, 2]},
   {'bar': {'hello': 'world'}},
   {'code': Code('function x() { return 1; }', {})},
   {'bin': Binary(b'\x01\x02\x03\x04', 128)}
]

from bson.json_util import loads
doc = loads('{"b": {"$binary': b'this is a byte string'})
print(doc)

{u'b': Binary('this is a byte string', 0)}

from bson.json_util import loads
doc = loads('{"b": {"$binary': b'this is a byte string'})
print(doc)

{'b': b'this is a byte string'}

Escribir JSON extendido

Puede escribir una cadena JSON extendida a partir de una lista de diccionarios llamando al método bson.json_util.dumps(). El siguiente ejemplo genera una cadena JSON extendida en formato relajado:

from bson import Code, Binary
from bson.json_util import dumps
doc = [
   {'foo': [1, 2]},
   {'bar': {'hello': 'world'}},
   {'code': Code('function x() { return 1; }', {})},
   {'bin': Binary(b'\x01\x02\x03\x04', 128)}
]
ejson_str = dumps(doc)
print(ejson_str)

'''[
   {"foo": [1, 2]},
   {"bar": {"hello": "world"}},
   {"code": {
      "$code": "function x() { return 1; }",
      "$scope": {}
   }},
   {"bin": {
      "$binary": {
         "base64": "AQIDBA==",
         "subType": "80"
   }}}
]'''

De forma predeterminada, el método dumps() devuelve la cadena JSON extendida en formato relajado. Para especificar un formato diferente, pase uno de los siguientes valores al parámetro json_options:

• CANONICAL_JSON_OPTIONS: Devuelve la string Extended JSON en formato canónico.

• LEGACY_JSON_OPTIONSDevuelve la cadena JSON extendida en formato heredado. Recomendamos usar el formato relajado o canónico.

El siguiente ejemplo muestra cómo generar JSON extendido en formato canónico:

from bson import Code, Binary
from bson.json_util import dumps, CANONICAL_JSON_OPTIONS
doc = [
   {'foo': [1, 2]},
   {'bar': {'hello': 'world'}},
   {'code': Code('function x() { return 1; }', {})},
   {'bin': Binary(b'\x01\x02\x03\x04', 128)}
]
ejson_str = dumps(doc, json_options=CANONICAL_JSON_OPTIONS)
print(ejson_str)

'''[
   {"foo": [
      {"$numberInt": "1"},
      {"$numberInt": "2"}
   ]},
   {"bar": {"hello": "world"}},
   {"code": {
      "$code": "function x() { return 1; }",
      "$scope": {}
   }},
   {"bin": {
      "$binary": {
         "base64": "AQIDBA==",
         "subType": "80"
   }}}
]'''

Información Adicional

Los recursos en las siguientes secciones proporcionan más información sobre cómo trabajar con JSON extendido.