スキーマの定義と強制

スキーマ画面に移動する

左側のナビゲーション メニューで、 の下の をクリックして、スキーマSchema Data Accessエディターを開きます。[Collections（コレクションCollections ] タブに [Collections（コレクション）] タブに表示されます。 Atlas App Services はリンクされたクラスターで既存のコレクションをスキャンし、スキーマ エディターの左側に一覧表示します。

メニューからコレクションを検索して選択すると、スキーマ エディターの右側にコレクション構成が表示されます。

クリックして拡大します

既存のデータからスキーマを生成する（任意）

コレクションにすでにデータがある場合は、App Services はコレクション内のドキュメントのサブセットをサンプリングし、サンプルに基づいてスキーマを生成できます。 すでにスキーマがある場合、またはスキーマを手動で定義したい場合は、次の手順に進みます。

サンプリングするドキュメント数を構成し、MongoDB クエリ言語を使用して、サンプルを特定のドキュメントに制限できます。 デフォルトでは、App Services はコレクション全体から最大 500 のドキュメントをランダムにサンプリングします。

既存のデータからスキーマを生成するには、次の手順に従います。

1. スキーマ エディターの右側のコレクション構成から、 Generate Schemaをクリックしてサンプル構成画面を開きます。

2. サンプル サイズを最大 50,000 ドキュメントまで指定します。

3. 必要に応じて、 Advancedをクリックし、クエリ、プロジェクション、並べ替えを指定してサンプル クエリを絞り込みます。 クエリフィルターとソート フィルターを使用してドキュメントの特定のサブセットをサンプリングし、プロジェクション フィルターを使用して各ドキュメントからフィールドの特定のサブセットをサンプリングします。

4. [ Generateをクリックしてサンプル クエリを実行し、スキーマを生成します。 サンプリングされたドキュメントの数と内容によっては、このプロセスには最大 分かかる場合があります。

クリックして拡大します

スキーマを定義または変更する

スキーマを手動で定義したり、フィールドレベルのスキーマ定義を追加して既存のスキーマを変更したりできます。

コレクションごとに 1 つの BSON スキーマを定義できます。 各コレクション スキーマのルートレベル タイプは、コレクション内のドキュメントを表す objectスキーマです。 ルート スキーマのpropertiesフィールド内のドキュメント フィールドに追加のスキーマを定義できます。

JSON schema オブジェクトで使用できるフィールドは、スキーマが定義する値の型によって異なります。 サポートされているタイプのリストとその構成方法の詳細については、「スキーマ タイプ 」を参照してください。

{
  "name": "Jane Doe",
  "age": 42,
  "favoriteColors": [
    { "rank": 1, "name": "RebeccaPurple", "hexCode": "#663399" },
    { "rank": 2, "name": "DodgerBlue", "hexCode": "#1E90FF" },
    { "rank": 3, "name": "SeaGreen", "hexCode": "#2E8B57" },
  ]
}

{
  "bsonType": "object",
  "required": ["name", "age", "favoriteColors"],
  "properties": {
    "name": {
      "bsonType": "string"
    },
    "age": {
      "bsonType": "int",
      "minimum": 13,
      "exclusiveMinimum": false
    },
    "favoriteColors": {
      "bsonType": "array",
      "uniqueItems": true,
      "items": {
        "bsonType": "object",
        "properties": {
          "rank": { "bsonType": "int" },
          "name": { "bsonType": "string" },
          "hexCode": {
            "bsonType": "string",
            "pattern": "^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$"
          }
        }
      }
    }
  }
}

変更検証式を追加する（任意）

各フィールドの内容を構成するだけでなく、スキーマのvalidateフィールドに検証式を定義することで、ドキュメントへの変更を検証できます。 検証式は、 %%prevおよび%%prevRootの展開を使用して、挿入またはアップデート操作が発生する前にフィールドまたはドキュメントの値にアクセスできます。

"owner_id": {
  "validate": {
    "%or": [
      { "%%prev": { "%exists": false } },
      { "%%prev": "%%this" }
    ]
  }
}

"owner_id": {
  "validate": {
    "%or": [
      { "%%prevRoot.owner_id": { "%exists": false } },
      { "%%prevRoot.owner_id": "%%root.owner_id" }
    ]
  }
}

スキーマの保存

スキーマを設定したら、[ Save ] をクリックします。 保存後、App Services によってすぐに、今後のすべてのクエリに対するスキーマの強制が開始されます。

スキーマに対するドキュメントの検証

コレクション スキーマを保存したら、コレクション内の既存のドキュメントがスキーマに準拠していることを検証できます。

App Services は、スキーマの自動生成で行われるのと同様に、検証のためにドキュメントをサンプリングします。

コレクション内のデータを検証するには、次のようにします。

1. Run Validation ] ボタンをクリックして、検証構成ウィンドウを開きます。

2. サンプル サイズを最大 50,000 ドキュメントまで指定します。

3. オプションで、 Advancedをクリックし、クエリやソートを指定して、ドキュメントの特定のサブセットへの検証を絞り込みます。

4. コレクションのドキュメントをサンプリングし、スキーマに対して各ドキュメントを検証するには、 Run Validationをクリックします。

検証が完了すると、App Services はサンプルからの検証エラーをJSON Validation Errorsテーブルに一覧表示します。 表の各行は、特定のフィールドに対する特定のタイプの検証エラーを表し、その方法で検証に失敗したドキュメントの数を示します。

検証エラーごとに、 Actionsメニューを使用して、失敗した未加工のドキュメントをダウンロードしたり、失敗したドキュメントを検索する MongoDB クエリをコピーしたりできます。

クリックして拡大します

MongoDB Cloud へのログイン

appservices を使用してアプリを構成するには、アプリを含む組織またはプロジェクトにスコープが設定された API キーを使用して MongoDB Cloud にログインする必要があります。

appservices login --api-key="<MongoDB Cloud Public API Key>" --private-api-key="<MongoDB Cloud Private API Key>"

アプリの最新バージョンを取得する

appservicesを使用してドキュメント スキーマを定義するには、アプリケーションの構成ファイルのローカル コピーが必要です。

アプリの最新バージョンのローカルコピーを取得するには、次のコマンドを実行します。

appservices pull --remote="<Your App ID>"

スキーマを定義する

コレクションのスキーマを定義または変更するには、コレクションの構成ディレクトリ内のschema.json構成ファイルを開きます。

# Create the collection's configuration directory
mkdir -p data_sources/<service>/<db>/<collection>
# Create the collection's schema file
echo '{}' >> data_sources/<service>/<db>/<collection>/schema.json

すべてのドキュメントのルートレベル スキーマは タイプobjectである必要があります。 追加のスキーマを使用して、 properties配列内の特定のフィールドを構成できます。 少なくとも、スキーマは次のようになります。

{
  "bsonType": "object",
  "properties": {
    "<Field Name>": <Schema Document>,
    ...
  }
}

変更検証の定義（任意）

スキーマのvalidateフィールドに検証式を定義することで、ドキュメントに対する変更を検証できます。 検証式は、 %%prevおよび%%prevRootの展開を使用して、挿入またはアップデート操作が発生する前にフィールドまたはドキュメントの値にアクセスできます。

"owner_id": {
  "validate": {
    "%or": [
      { "%%prev": { "%exists": false } },
      { "%%prev": "%%this" }
    ]
  }
}

"owner_id": {
  "validate": {
    "%or": [
      { "%%prevRoot.owner_id": { "%exists": false } },
      { "%%prevRoot.owner_id": "%%root.owner_id" }
    ]
  }
}

更新されたスキーマの配置

schema.jsonを定義して保存したら、更新された構成をリモート アプリにプッシュできます。 App Services CLI はプッシュ時に新しいスキーマをすぐに配置します。

appservices push --remote="<Your App ID>"