Tipos de esquema

Arreglo

Un array contiene varios valores de un tipo específico. Los esquemas BSON array utilizan el estándar Matriz de esquemas JSON formato.

{
  "bsonType": "array",
  "items": <Schema Document> | [<Schema Document>, ...],
  "additionalItems": <boolean> | <Schema Document>,
  "maxItems": <integer>,
  "minItems": <integer>,
  "uniqueItems": <boolean>
}

Booleano

Un bool es true o false.

{ "bsonType": "bool" }

Mezclado

Un mixed campo puede contener cualquier tipo de esquema, excepto objetos incrustados, conjuntos(sets) o cualquier contador{@(counters) compatible con el SDK. Aplicación Services no aplica un tipo coherente en los documentos, por lo que dos documentos diferentes pueden tener valores de distintos tipos.

Los campos mixtos pueden almacenar matrices y diccionarios de datos mixtos. Sync los traduce a MongoDB como matrices y objetos, respectivamente. Estas colecciones de datos mixtos también pueden contener otras colecciones de datos mixtos, con una profundidad máxima de 100 niveles. Puede aprovechar esta flexibilidad para almacenar estructuras de datos complejas que, de otro modo, no encajarían en un esquema predefinido, como datos JSON variables o documentos complejos de MongoDB.

Los campos mixtos también pueden representar relaciones. Sync traduce estas relaciones en MongoDB como DBRef para preservar el nombre de la base de datos, el nombre de la colección y la llave primaria del vínculo.

{ "bsonType": "mixed" }

Número

Un number configura genéricamente algún tipo de número. Los esquemas BSON amplían numéricos de JSON Schema con tipos adicionales que permiten definir enteros, flotantes y decimales.

{
  "bsonType": "number" | "int" | "long" | "double" | "decimal",
  "multipleOf": <number>,
  "maximum": <number>,
  "exclusiveMaximum": <boolean>,
  "minimum": <number>,
  "exclusiveMinimum": <boolean>
}

Objeto

Un object es un objeto estructurado con string claves que cada una tiene un valor tipado. Objetos representan objetos Realm y objetos incrustados en realms sincronizados así como los documentos a los que hacen referencia en MongoDB.

{
  "bsonType": "object",
  "title": "<Type Name>",
  "required": ["<Required Field Name>", ...],
  "properties": {
    "<Field Name>": <Schema Document>
  },
  "minProperties": <integer>,
  "maxProperties": <integer>,
  "patternProperties": {
    "<Field Name Regex>": <Schema Document>
  },
  "additionalProperties": <boolean> | <Schema Document>,
  "dependencies": {
    "<Field Name>": <Schema Document> | ["<Field Name>", ...]
  }
}

ObjectId

Un objectId es un 12identificador de bytes para objetos BSON. Los valores ObjectId se utilizan habitualmente como _id valores únicos de documentos en una colección de MongoDB o de objetos en un dominio sincronizado.

{ "bsonType": "objectId" }

String

Un string es texto codificado como una serie de caracteres. Los string esquemas BSON utilizan el formato de cadena de esquema JSON estándar.

{
  "bsonType": "string",
  "maxLength": <integer>,
  "minLength": <integer>,
  "pattern": "<Regular Expression>"
}

UUID

Un uuid (Identificador Universal Único) es un estandarizado object identifier de 16bytes.

{ "bsonType": "uuid" }

Datos binarios

A binData is a piece of unstructured binary data. Maps to the binary BSON type. Always uses subtype 0.

{ "bsonType": "binData" }

Contador

Un contador es un tipo numérico especial cuyo valor puede incrementarse o decrementarse. Se asigna al long tipo de número en App Services.

{ "bsonType": "long" }

Los tipos de datos de contador solo se admiten en los siguientes SDK:

• Counters - Java SDK

• MutableRealmInt (Contador) - Kotlin SDK

• RealmInteger - .NET SDK

• Counters - Node.js SDK

Configura

Un conjunto es una colección de valores únicos.

Un esquema establecido es un esquema array donde uniqueItems se establece en true.

{
   "bsonType": "array",
   "uniqueItems": true,
   "items": {
      "bsonType": "long"
   }
}

Dictionary

A dictionary is a collection of dynamic and unique string keys paired with values of a given type. A dictionary is functionally an object or document without pre-defined field names.

A dictionary schema is an object schema where properties is not defined and the value of additionalProperties is a schema for the dictionary value's type.

{
   "bsonType": "object",
      "additionalProperties": {
         "bsonType": "string"
      }
   }
}

{
   "bsonType": "object",
      "additionalProperties": true
   }
}

{
   "bsonType": "object",
      "additionalProperties": {
         "bsonType": "mixed"
      }
   }
}

{
   "bsonType": "object",
      "additionalProperties": {
         "bsonType": "object",
         "title": "Address",
         "properties": {
           "streetNumber": { "bsonType": "string" },
           "street": { "bsonType": "string" },
           "city": { "bsonType": "string" },
           "province": { "bsonType": "string" },
           "country": { "bsonType": "string" },
           "postalCode": { "bsonType": "string" }
         }
   }
}

GeoJSON Point

A GeoJSON Point (GeoPoint) is a single location on the Earth's surface. The GeoPoint schema must be a required type field, of type string, which is always set to "Point".

También debe proporcionar un campo coordinates, que es una matriz de valores dobles. La matriz coordinates debe contener al menos dos valores dobles y puede contener un tercero:

• El primer doble es la longitud del punto, entre -180 y 180.

• La segunda es la latitud, entre -90 y 90.

• El tercer valor opcional representa la elevación/altitud del punto, en metros. Atlas ignora este valor al realizar queries.

If you are not using Device Sync, you can query your geospatial data with regular geospatial operators. However, if you are using Atlas Device Sync, the following rules also apply to the GeoPoint object:

• Debe ser del tipo object.

• Debe estar incrustado dentro de otro tipo.

• Se permiten valores adicionales dentro del arreglo coordinates, siempre que sean doubles (decimales).

• También se permiten propiedades adicionales en el objeto GeoPoint.

El siguiente es el esquema de Device Sync de un objeto con una propiedad GeoPoint incrustada llamada «ubicación»:

{
  "title": "MyObject",
  "properties": {
     "_id": {
       "bsonType": "objectId"
     },
     "location": {
       "bsonType": "object",
       "required": [ "type" ],
       "properties": {
         "type": {
           "bsonType": "string",
         },
         "coordinates": {
           "bsonType": "array",
           "items": {
             "bsonType": "double"
           }
         }
       }
     }
   }
}

The following code block shows a document that follows the schema. It has a single embedded GeoPoint object named "location".

{
  "_id": { "$oid": "65039d09fe4e46dddee31a3f" },
  "location": {
    "type": "Point",
    "coordinates": [-122.4, 48.12, 23.0]
   }
}