異なるスキーマバージョンを維持する

項目一覧

このタスクについて

始める前に
手順
コレクションへの schemaVersion フィールドの追加
更新されたスキーマを含むドキュメントの挿入
次のステップ
コレクションをクエリする
コレクション内のドキュメントを更新する
詳細

アプリケーションのスキーマ要件は徐々に変化していく可能性があります。たとえば、新しいサービスが利用可能になると、ドキュメントに新しいフィールドを追加する必要がある場合があります。 MongoDB の柔軟なデータモデルにより、コレクション全体で非均一のドキュメント構造を使用でき、更新されたスキーマと並行して古いドキュメント構造を保持できます。

スキーマバージョン管理パターンを使用すると、同じコレクション内に異なるバージョンのスキーマを設定できるため、要件が変更された場合に大規模なスキーマの移行を回避できます。

このタスクについて

ドキュメント内に異なるレベルで表示されるフィールドがある場合、スキーマバージョン管理パターンはインデックスに影響を与える可能性があります。たとえば、同じフィールドを最上位フィールドと異なるドキュメントの埋め込みフィールドとして保存する場合、そのフィールドのクエリをサポートするには複数のインデックスが必要になる場合があります。

始める前に

次の例では、オンラインショップがコレクションを使用して顧客の連絡先情報を追跡しています。最初は、コレクションには自宅と職場の電話番号のみが含まれています。時間の経過とともに、新しい連絡先メソッドが追加され、古いメソッドは不要になります。

サンプルドキュメントを挿入します。

db.contacts.insertOne(
   {
      _id: 1,
      name: "Taylor",
      home: "209-555-7788",
      work: "503-555-0110"
   }
)

手順

次の手順では、コレクションの初期スキーマバージョンを設定し、別のスキーマを持つ新しいドキュメントを挿入します。

コレクションへの schemaVersion フィールドの追加

コレクション内の異なるスキーマを区別するには、 schemaVersionフィールドを追加します。

次のコマンドは、値1を持つschemaVersionフィールドを初期スキーマを持つドキュメントに追加します。

db.contacts.updateMany(
   { },
   {
      $set: { schemaVersion: 1 }
   }
)

更新されたスキーマを含むドキュメントの挿入

更新されたスキーマでは、カスタマーはソーシャルメディアアカウントをリンクできます。新しい要件を考慮し、 schemaVersionが2であるドキュメントを挿入します。

db.contacts.insertOne(
   {
      _id: 2,
      schemaVersion: 2,
      name: "Cameron",
      contactInfo: {
         cell: "903-555-1122",
         work: "670-555-7878",
         instagram: "@camcam9090",
         linkedIn: "CameronSmith123"
      }
   }
)

次のステップ

スキーマバージョン管理パターンを実装した後、アプリケーションがデータをクエリして更新する方法を変更する必要があります。

コレクションをクエリする

contactsコレクションには 2 つの異なるスキーマがあるため、クエリは、ドキュメントのスキーマバージョンに応じて、フィールド値の可能なすべてのロケーションを確認する必要があります。

次のクエリは、カスタマーのwork番号に基づいて検索します。クエリは、 workフィールドが利用可能な両方の場所を確認します。

db.contacts.find(
   {
      $or: [
         {
            work: "503-555-0110"
         },
         {
            "contactInfo.work": "503-555-0110"
         }
      ]
   }
)

出力:

{
   _id: 1,
   name: 'Taylor',
   home: '209-555-7788',
   work: '503-555-0110',
   schemaVersion: 1
}

コレクション内のドキュメントを更新する

データの挿入と同様に、コレクションを更新する際、アプリケーションは更新されるフィールドが利用可能なすべての場所を確認する必要があります。データを更新するときは、 schemaVersionフィールドを使用して更新するフィールドを決定できます。

_id: 2を使用してユーザーのworkの電話番号を更新するには、次のコマンドを実行します。

db.contacts.updateOne(
   { _id: 2 },
   [
      {
         $set: {
            "work": {
               $cond: {
                  if: { $eq: [ "$schemaVersion", 1 ] },
                  then: "999-999-9999",
                  else: null
               }
            },
            "contactInfo.work": {
               $cond: {
                  if: { $eq: [ "$schemaVersion", 2 ] },
                  then: "999-999-9999",
                  else: null
               }
            }
         }
      }
   ]
)

前の例では、次のようになります。

一致したドキュメントのschemaVersionが1の場合、 workフィールドには更新された値が設定されます。
一致したドキュメントのschemaVersionが2の場合、 contactInfo.workフィールドには更新された値が設定されます。

詳細

戻る

ドキュメント履歴の保持

スキーマ設計のアンチパターン