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" }

Mixto

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 a MongoDB como una DBRef para conservar el nombre de la base de datos, el nombre de la colección y la clave principal del enlace.

{ "bsonType": "mixed" }

Número

Un number configura genéricamente algún tipo de número. Los esquemas BSON extienden los esquemas numéricos JSON con tipos adicionales para definir números 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 claves string, cada una con un valor tipificado. Los objetos representan objetos de dominio y objetos incrustados en dominios sincronizados, así como los documentos a los que se asignan 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

Un binData es un dato binario no estructurado. Se asigna al tipo binario BSON. Siempre usa el 0 subtipo.

{ "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:

• Contadores - SDK de Java

• MutableRealmInt (Contador) - Kotlin SDK

• RealmInteger - .NET SDK

• Contadores - SDK de Node.js

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

Un diccionario es una colección de claves string dinámicas y únicas, emparejadas con valores de un tipo determinado. Funcionalmente, un diccionario es un objeto o documento sin nombres de campo predefinidos.

Un esquema de diccionario es un esquema object donde properties no está definido y el valor de additionalProperties es un esquema para el tipo del valor del diccionario.

{
   "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" }
         }
   }
}

Punto GeoJSON

Un punto GeoJSON (GeoPoint) es una ubicación única en la superficie terrestre. El esquema GeoPoint debe ser un type campo obligatorio, de string tipo, que siempre se establece en "Punto".

También debe proporcionar un campo coordinates, que es una matriz de valores dobles. La matriz coordinates debe contener al menos 2 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.

Si no utiliza Device Sync, puede consultar sus datos geoespaciales con operadores geoespaciales habituales. Sin embargo, si utiliza Atlas Device Sync, las siguientes reglas también se aplican al objeto GeoPoint:

• 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 sincronización de dispositivo de un objeto con una propiedad GeoPoint incorporada denominada "ubicación":

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

El siguiente bloque de código muestra un documento que sigue el esquema. Contiene un único objeto GeoPoint incrustado llamado "ubicación".

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