Tipos de esquema

Array

Um array contém vários valores de um tipo específico. BSON array Os esquemas usam o JSON schema array de padrão formato.

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

Boolean

Um bool é true ou false.

{ "bsonType": "bool" }

Misto

Um campo mixed pode conter qualquer tipo de esquema, exceto objetos incorporados, conjuntos ou qualquer contador compatível com o SDK. O App Services não impõe um tipo consistente entre documentos, de modo que dois documentos diferentes podem ter valores de tipos diferentes.

Os campos mistos podem armazenar arrays e dicionários de dados mistos. A sincronização os traduz para o MongoDB como arrays e objetos, respectivamente. Essas coleções de dados mistos também podem conter outras coleções de dados mistos, com uma profundidade máxima de 100 níveis. Você pode aproveitar essa flexibilidade para armazenar estruturas de dados complexas que, de outra forma, não se encaixariam em um esquema predefinido, como dados JSON variáveis ou documentos complexos do MongoDB.

Os campos mistos também podem representar relacionamentos. A sincronização converte esses relacionamentos para o MongoDB como um DBRef para preservar o nome do banco de dados, o nome da coleção e a chave primária do link.

{ "bsonType": "mixed" }

Número

Um number configura genericamente algum tipo de número. Os esquemas BSON ampliam os números do JSON schema com tipos adicionais para definir números inteiros, flutuantes e decimais.

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

Objeto

Um object é um objeto estruturado com string chaves que cada uma tem um valor digitado. Os Objeto de Realm representam Objeto de Realm e objetos incorporados em realms sincronizados, bem como os documentos que eles mapeiam no 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

Um objectId é um identificador de 12bytes para objetos BSON . Os valores ObjectId são mais comumente usados como valores _id exclusivos de documentos em uma collection do MongoDB ou objetos em um Realm sincronizado.

{ "bsonType": "objectId" }

String

Um string é codificado por texto como uma série de caracteres. Os esquemas BSON string usam o formato padrão de string do JSON schema.

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

UUID

Um uuid (Identificador Único Universal) é um identificador de objeto exclusivo de 16bytes. padronizado.

{ "bsonType": "uuid" }

Dados binários

Um binData é um fragmento de dados binários não estruturados. Mapeia para o tipo de BSON binário. Sempre usa o subtipo 0.

{ "bsonType": "binData" }

Contador

Um contador é um tipo numérico especial cujo valor pode ser incrementado ou diminuído. Ele mapeia para o tipo de número long no App Services.

{ "bsonType": "long" }

Os tipos de dados de contador são suportados apenas nos seguintes SDKs:

• Contadores - Java SDK

• MutableRealmInt (Contador) - Kotlin SDK

• RealmInteger - .NET SDK

• Contadores - Node.js SDK

definir

Um conjunto é uma collection de valores únicos.

Um esquema de conjunto é um esquema array onde uniqueItems está configurado para true.

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

Dictionary

Um dicionário é uma coleção de chaves string dinâmicas e exclusivas emparelhadas com valores de um determinado tipo. Um dicionário é funcionalmente um objeto ou documento sem nomes de campo predefinidos.

Um esquema de dicionário é um esquema object em que properties não está definido e o valor de additionalProperties é um esquema para o tipo de valor do dicionário.

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

Ponto GeoJSON

Um ponto GeoJSON (GeoPoint) é um local único na superfície da Terra. O esquema do GeoPoint deve ser um campo type obrigatório, do tipo string, que está sempre definido como "Point ".

Você também deve fornecer um campo coordinates, que é uma array de double. A array coordinates deve conter pelo menos 2 valores double e pode conter um terceiro:

• O primeiro double é a longitude do ponto, entre -180 e 180.

• O segundo é a latitude, entre -90 e 90.

• O terceiro valor opcional representa a elevação/altitude do ponto, em metros. O Atlas ignora este valor ao executar consultas.

Se você não estiver usando o Device Sync, poderá consultar seus dados geoespaciais com operadores geoespaciais regulares. No entanto, se você estiver usando o Atlas Device Sync, as seguintes regras também se aplicam ao objeto GeoPoint:

• Deve ser do tipo object.

• Deve ser incorporado em outro tipo.

• Valores adicionais são permitidos dentro da array coordinates, desde que sejam double.

• Propriedades adicionais no objeto GeoPoint também são permitidas.

A seguir está o esquema Device Sync de um objeto com uma propriedade GeoPoint incorporada chamada "localização":

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

O seguinte bloco de código mostra um documento que segue o esquema. Ele tem um único objeto GeoPoint incorporado chamado "localização".

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