フィルタリングされた同期

フィルター構文

start API エンドポイントは、フィルタリング同期を構成する 2 つのフィールドincludeNamespacesとexcludeNamespaces ）を受け入れます。 各フィールドは、同期に含める、または除外するデータベースとコレクションを指定するフィルターの配列を受け取ります。

フィルターの構文は次のとおりです。

"includeNamespaces": [
    {
       "database": "<database-name>",
       "collections": [
          "<collection-name>"
       ]
       "databaseRegex": {
          "pattern": "<regex-pattern>",
          "options": "<options>"
       },
       "collectionsRegex": {
          "pattern": "<regex-pattern>",
          "options": "<options>"
       }
    }
 ],
 "excludeNamespaces": [
    {
       "database": "<database-name>",
       "collections": [
          "<collection-name>"
       ]
       "databaseRegex": {
          "pattern": "<regex-pattern>",
          "options": "<options>"
       },
       "collectionsRegex": {
          "pattern": "<regex-pattern>",
          "options": "<options>"
       }
    }
 ]

フィルターには、 databaseフィールドまたはdatabaseRegexフィールドのいずれかを含める必要があります。

特定のコレクションに一致するためにフィルターが必要な場合は、 collections配列を使用してコレクションを個別に指定するか、 collectionsRegexフィールドを使用して正規表現を定義できます。

フィルターを構成する

"includeNamespaces": [
   {
      "database": "sales",
      "collectionsRegex": {
         "pattern": "^accounts_.+?$",
         "options": "ms"
      }
],
"excludeNamespaces": [
    {
        "database": "sales",
        "collections": [
            "accounts_old"
        ]
    }
]

curl -X POST "http://localhost:27182/api/v1/start" --data '
   {
      "source": "cluster0",
      "destination": "cluster1",
      "includeNamespaces": [
         {
             "database": "sales",
             "collectionsRegex": {
                "pattern": "^accounts_.+$",
                "options": "i"
             }
         }, {
            "database": "marketing"
         }
      ]
   } '

構成の例については、「フィルターでmongosyncを起動する 」を参照してください。

既存のフィルターの置き換え

既存のフィルターを更新することはできません。 進行中の同期プロセスを停止し、宛先クラスターを準備し、新しいフィルターでmongosyncを再起動する必要があります。

mongosyncが元のフィルターを実行すると、データを含むデータベース（「ユーザー データベース」）と宛先クラスターにmongosync_reserved_for_internal_useシステム データベースが作成されました。 新しいフィルターでmongosyncを再起動する前に、それらのデータベースを削除する必要があります。

新しいフィルター用に宛先クラスターを準備するには、次の手順に従います。

コレクションの追加と名前変更

フィルタリングされた同期中に またはrename a collectionを追加することもできます。

mapReduce と $out によるフィルタリング

フィルタリングとともに$out集計ステージまたはmapReduceコマンド（コレクションを作成または置換するように設定されている場合）を使用するには、指定されたコレクションだけでなくデータベース全体をフィルタリングする必要があります。

たとえば、次の集計パイプラインについて考えてみましょう。

use library
db.books.aggregate( [
   { $group : { _id : "$author", titles: { $push: "$title" } } },
   { $out : "authors" }
] )

$outステージは、 libraryデータベースにauthorsコレクションを作成します。 authorsコレクションを同期する場合は、フィルターでlibraryデータベース全体を指定する必要があります。 authorsコレクションのみを指定している場合、フィルターは機能しません。

このフィルターは、次の機能を行います。

"includeNamespaces": [
  {
    "database": "library"
  }
]

このフィルターは次の場合、機能しません。

"includeNamespaces": [
  {
    "database": "library",
    "collections": [ "authors", "books" ]  // DOES NOT WORK WITH $OUT
  }
]

制限

• フィルタリングは、元の同期ではサポートされていません。

• 起動前に、宛先クラスターにはユーザー データが含まれていない必要があります。

• 起動前に、宛先クラスターにmongosync_reserved_for_internal_useシステムデータベースが含まれていない必要があります。

• 使用中のフィルターは変更できません。 新しいフィルターを作成するには、「既存のフィルターの置き換え 」を参照してください。

• コレクションの名前を変更できるのは、特定の状況のみです。 詳細については、「コレクションの追加と名前変更 」を参照してください。

• フィルターにビューが含まれ、基本コレクションは含まれていない場合、ビュー メタデータのみが宛先クラスターに同期されます。 ビュー ドキュメントを含めるには、基本コレクションも同期する必要があります。

• フィルターではシステム コレクションまたはシステム データベースを指定できません。

• フィルタリングとともに$out集計ステージまたはmapReduceコマンド（コレクションを作成または置換するように設定されている場合）を使用するには、データベース全体を使用するようにフィルターを構成する必要があります。 フィルターを データベース内のコレクションに制限することはできません。

  詳細については、「 mapReduce と $out によるフィルタリング 」を参照してください。

例

"includeNamespaces" : [
      {
          "database" : "sales",
          "collections": [ "EMEA", "APAC" ]
      },
      {
          "database" : "marketing"
      }
   ]

{
   "source": "cluster0",
   "destination": "cluster1",
   "includeNamespaces":
      [
         { "database" : "students", "collections": ["undergrad", "graduate", "adjuncts"] },
         { "database" : "staff" }
      ]
}

// This code works
use admin
db.runCommand( { renameCollection: "staff.employees", to: "staff.salaried" } )

// This code works
use admin
db.runCommand( { renameCollection: "students.graduate", to: "students.adjuncts" } )

// This code produces an error and mongosync stops syncing
use admin
db.runCommand( { renameCollection: "students.graduate", to: "students.notAFilteredCollection" } )

use admin
db.runCommand( { renameCollection: "staff.employees", to: "staff.onPayroll" } )