模式类型

阵列

array包含多个特定类型的值。 BSONarray 模式使用标准 JSON schema大量 格式。

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

布尔

bool 要么为 true 要么为 false。

{ "bsonType": "bool" }

混合

mixed 字段可能包含除嵌入式对象、集合或任何 SDK 支持的计数器外的任何模式类型。App Services 不会跨文档强制使用一致的类型，因此两个不同文档可能具有不同类型的值。

混合字段可以存储混合数据的数组和字典。同步分别将它们转换为 MongoDB 中的数组和对象。这些混合数据集合还可以包含其他混合数据集合，其中最大深度为 100 层。您可以利用这种灵活性来存储不适合预定义模式的复杂数据结构，例如可变 JSON 数据或复杂的 MongoDB 文档。

混合字段也可以表示关系。同步将这些关系作为 DBRef 转换为 MongoDB，保留数据库名称、集合名称和链接的主键。

{ "bsonType": "mixed" }

数值

number 通常会配置某种类型的数字。BSON 模式使用其他类型来扩展 JSON schema 数值，以便定义整数、浮点数和小数。

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

对象

object 是结构化对象，有 string 个键，每个键都有一个类型值。对象表示同步领域中的 Realm 对象和嵌入对象，以及其在 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

objectId是BSON对象的12字节标识符。 ObjectId 值最常用作MongoDB集合中文档或同步域中对象的唯一_id值。

{ "bsonType": "objectId" }

字符串

string 是编码为一系列字符的文本。BSON string 模式使用标准的 JSON schema 字符串 格式。

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

UUID

uuid（通用唯一标识符）是一种标准化的 16 字节唯一对象标识符。

{ "bsonType": "uuid" }

二进制数据

binData 是一段非结构化二进制数据。映射到二进制 BSON 类型。始终使用子类型 0。

{ "bsonType": "binData" }

计数器

计数器是一种特殊的数字类型，其值可以递增或递减。它映射到 App Services 中的 long 数字类型。

{ "bsonType": "long" }

仅以下 SDK 支持计数器数据类型：

• 计数器 - Java SDK

• MutableRealmInt（计数器）- Kotlin SDK

• RealmInteger — .NET SDK

• 计数器 - Node.js SDK

集

集合是一组唯一值。

设置模式是一种 array 模式，其中 uniqueItems 会设为 true。

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

Dictionary

字典是与给定类型的值配对的一组动态且唯一的 string 键。字典在功能上是没有预定义字段名称的对象或文档。

字典模式是一种 object 模式，其中未定义 properties，而 additionalProperties 的值是字典值类型的模式。

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

GeoJSON Point (GeoPoint) 是地球表面上的单个位置。GeoPoint 模式必须是必填的 type 字段，类型为 string，始终设置为“点”。

您还必须提供一个 coordinates 字段，它是一个 double 数组。coordinates 数组必须包含至少 2 个 double 值，并且可以包含第三个值：

• 第一个 double 是该点的经度，介于 -180 到 180 之间。

• 第二个是纬度（介于 -90 到 90 之间）。

• 可选的第三个值表示点的高程/高度，以米为单位。Atlas 在执行查询时忽略此值。

如果不使用 Device Sync，还可以使用常规地理空间操作符查询地理空间数据。但是，如果您正在使用 Atlas Device Sync，则以下规则也适用于 GeoPoint 对象：

• 它的类型必须是 object。

• 它必须嵌入到其他类型中。

• 只要是 double，coordinates 数组还支持其他值。

• 还支持在 GeoPoint 对象中添加其他属性。

以下是一个对象的 Device Sync 模式，其具有名为“location”的嵌入式 GeoPoint 属性：

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

以下代码块显示了遵循此模式的文档。它有一个名为“location”的嵌入式 GeoPoint 对象。

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