スキーマ タイプ

配列

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 でサポートされている counter は除きます。App Services ではドキュメント間で一貫したタイプが強制されないため、2 つの異なるドキュメントで値のタイプが異なる場合があります。

混合フィールドには、混合データの配列と辞書を格納できます。Sync はそれぞれを MongoDB の配列とオブジェクトとして変換します。これらの混合データのコレクションには、最大深度が 100 レベルの他の混合データのコレクションも含めることができます。この柔軟性を活用して、変数 JSON データや複雑な MongoDB ドキュメントなど、事前定義されたスキーマに適さない複雑なデータ構造を保存できます。

混合フィールドは関係を表すこともできます。Sync はこれらの関係を DBRef として MongoDB に変換し、データベース名、コレクション名、リンクのプライマリキーを保持します。

{ "bsonType": "mixed" }

番号

number では、通常、あるタイプの数値が構成されます。BSON schema は、整数、浮動少数、小数を定義するための追加のタイプで 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 コレクション内のドキュメントまたは同期された Realm 内のオブジェクトのユニークな _id 値として最もよく使用されます。

{ "bsonType": "objectId" }

文字列

string は一連の文字としてエンコードされたテキストです。BSON string スキーマは標準の JSON スキーマ文字列 形式を使用します。

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

UUID

uuid（汎用一意識別子）は標準化された 16 バイトのユニークなオブジェクト識別子です。

{ "bsonType": "uuid" }

バイナリ データ

binData は非構造化バイナリ データであり、バイナリBSON 型 にマップします。サブタイプ 0 を常に使用します。

{ "bsonType": "binData" }

カウンター

counter は、値をインクリメントまたはデクリメント可能な特殊な数値型であり、App Services の long number 型にマッピングします。

{ "bsonType": "long" }

counter　データ型がサポートされるのは次の SDK のみです。

• カウンター - Java SDK

• MutableRealmInt（counter） - Kotlin SDK

• RealmInteger - .NET SDK

• カウンター - Node.js SDK

セット

set はユニークな値のコレクションです。

set schema は、uniqueItems が true に設定されている array スキーマです。

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

Dictionary

辞書は、特定の type の値とペアになった動的なユニークな string キーのコレクションです。機能的には、フィールド名が事前に定義されていないオブジェクトまたはドキュメントです。

辞書スキーマは object スキーマで、properties は定義されておらず、additionalProperties 値は辞書の値の 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 ポイント

GeoJSON ポイント（GeoPoint） は、地上の単一のロケーションです。GeoPoint スキーマは string タイプの必須 type フィールドである必要があり、常に「Point」に設定されます。

また、double 型の配列である coordinates フィールドも指定する必要があります。次のように、coordinates 配列には 2 つ目までの double 型の値が必ず含まれている必要があり、3 つ目の値も 1 つ含めることができます。

• 最初の double 型の値は地点の経度で、範囲は -180 から 180 です。

• 2 つ目の値は緯度で、範囲は -90 から 90 です。

• 任意の 3 つ目の値は、地点の標高/高度をメートル単位で表します。Atlas はクエリの実行時にこの値を無視します。

地理空間データは、Device Sync を使用していない場合、通常の地理空間演算子を使用してクエリできます。ただし、Atlas Device Sync を使用している場合は、GeoPoint オブジェクトに次のルールも適用されます。

• タイプは objectである必要があります。

• 別のタイプに埋め込む必要があります。

• double である限り、coordinates 配列内で別の値が許容されます。

• GeoPoint オブジェクトの追加プロパティも許可されます。

以下に示しているのは、「location」という名前の GeoPoint プロパティが埋め込まれたオブジェクトの Device Sync スキーマです。

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

以下のコード ブロックはスキーマに従ったドキュメントを示しており、「location」という名前の GeoPoint オブジェクトが 1 つ埋め込まれています。

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