$jsonSchema - Amazon DocumentDB
例 (MongoDB シェル)コードの例

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

$jsonSchema

バージョン 4.0 の新機能。

Elastic クラスターではサポートされていません。

Amazon DocumentDB の $jsonSchema演算子は、指定された JSON スキーマに基づいてドキュメントをフィルタリングするために使用されます。この演算子を使用すると、特定の JSON スキーマに一致するドキュメントをクエリし、取得したドキュメントが特定の構造要件とデータ型要件に準拠していることを確認できます。

コレクション作成の一部として$jsonSchema評価クエリ演算子を使用すると、コレクションに挿入されるドキュメントのスキーマを検証できます。詳細については、「JSON スキーマ検証の使用」を参照してください。

パラメータ

  • required (配列): ドキュメント内の必須フィールドを指定します。

  • properties (オブジェクト): ドキュメント内の各フィールドのデータ型とその他の制約を定義します。

例 (MongoDB シェル)

次の例は、 $jsonSchema演算子を使用してemployeesコレクションをフィルタリングしname、 フィールド、 ageフィールド、employeeIdおよび フィールドを持つドキュメントのみを取得する方法を示しています。 employeeIdフィールドのタイプは ですstring。

サンプルドキュメントを作成する

db.employees.insertMany([
  { "name": { "firstName": "Carol", "lastName": "Smith" }, "employeeId": "1" },
  { "name": { "firstName": "Emily", "lastName": "Brown" }, "employeeId": "2", "age": 25 },
  { "name": { "firstName": "William", "lastName": "Taylor" }, "employeeId": 3, "age": 24 },
  { "name": { "firstName": "Jane", "lastName": "Doe" }, "employeeId": "4" }
]);

クエリの例

db.employees.aggregate([
  { $match: {
    $jsonSchema: {
      required: ["name", "employeeId", "age"],
      properties: { "employeeId": { "bsonType": "string" } }
    }
  }}
]);

出力

{ "_id" : ObjectId("6908e8b61f77fc26b2ecd26f"), "name" : { "firstName" : "Emily", "lastName" : "Brown" }, "employeeId" : "2", "age" : 25 }

コードの例

$jsonSchema コマンドを使用するコード例を表示するには、使用する言語のタブを選択します。

Node.js
const { MongoClient } = require('mongodb');

async function filterByJsonSchema() {
  const client = await MongoClient.connect('mongodb://<username>:<password>@<cluster-endpoint>:27017/?tls=true&tlsCAFile=global-bundle.pem&replicaSet=rs0&readPreference=secondaryPreferred&retryWrites=false');
  const db = client.db('test');
  const collection = db.collection('employees');

  const result = await collection.aggregate([
    {
      $match: {
        $jsonSchema: {
          required: ['name', 'employeeId', 'age'],
          properties: { 'employeeId': { 'bsonType': 'string' } }
        }
      }
    }
  ]).toArray();

  console.log(result);
  await client.close();
}

filterByJsonSchema();
Python
from pymongo import MongoClient

def filter_by_json_schema():
  client = MongoClient('mongodb://<username>:<password>@<cluster-endpoint>:27017/?tls=true&tlsCAFile=global-bundle.pem&replicaSet=rs0&readPreference=secondaryPreferred&retryWrites=false')
  db = client['test']
  collection = db['employees']

  result = list(collection.aggregate([
    {
      '$match': {
        '$jsonSchema': {
          'required': ['name', 'employeeId', 'age'],
          'properties': {'employeeId': {'bsonType': 'string'}}
        }
      }
    }
  ]))

  print(result)
  client.close()

filter_by_json_schema()