start

状態

startエンドポイントを使用するには、 mongosyncがIDLE状態である必要があります。

権限

mongosync 接続stringで指定されたユーザーには、ソースクラスターと宛先クラスターで必要な権限が必要です。 「ユーザー権限」を参照して、ユーザーが同期を開始するための適切な権限を持っていることを確認します。

複数のmongosyncインスタンス

mongosyncを起動するときに、 cluster0またはcluster1設定の接続文字列で構成済みのmongosyncユーザーを使用していることを確認します。

リクエスト ボディ パラメータ

db.adminCommand( { setUserWriteBlockMode: 1, global: false } )

シャーディング パラメータ

レプリカセットからシャーディングされたクラスターに同期するには、 shardingオプションを設定して、宛先クラスターのコレクションをシャードします。

レプリカセットから シャーディングシャーディングされたクラスターにレプリカセットときに sharding オプションが設定されていない場合、mongosync はエラーをスローします。 また、sharding オプションが他の構成で設定されている場合、mongosync ではエラーがスローされます。

shardingオプションには次のパラメーターがあります。

同期ジョブの開始

The following example starts a sync job between cluster0 and cluster1. ソースクラスターはcluster0で、宛先クラスターはcluster1です。

リクエスト:

curl localhost:27182/api/v1/start -XPOST \
--data '
   {
      "source": "cluster0",
      "destination": "cluster1"
   } '

応答:

{"success":true}

可用性同期ジョブの開始

The following example starts a sync job between cluster0 and cluster1. ソースクラスターはcluster0で、宛先クラスターはcluster1です。

reversibleとenableUserWriteBlockingフィールドでは同期を元に戻すことができます。 同期方向を逆にするには、「逆 」を参照してください。

リクエスト:

curl localhost:27182/api/v1/start -XPOST \
--data '
   {
      "source": "cluster0",
      "destination": "cluster1",
      "reversible": true,
      "enableUserWriteBlocking": true
   } '

応答:

{"success":true}

フィルタリングされた同期ジョブの開始

The following example starts a sync job between cluster0 and cluster1. ソースクラスターはcluster0で、宛先クラスターはcluster1です。

cluster0にはsales 、 marketing 、およびengineeringデータベースが含まれています。

salesデータベースには、 EMEA 、 APAC 、 AMERのコレクションが含まれています。

この例のincludeNamespaces配列は、 salesとmarketingの 2 つのデータベースに対するフィルターを定義しています。

salesEMEAデータベースは、APAC コレクションと コレクションでもフィルタリングします。

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

/startこのフィルターを使用して API を呼び出すと、mongosync は次のようになります。

• marketingデータベース内のすべてのコレクションを同期します

• engineeringデータベースをフィルタリング除外します

• EMEAAPACデータベースからsales コレクションと コレクションを同期します

• AMERコレクションをフィルタリングで除外します

includeNamespacesオプションはフィルターを作成します。 同期をフィルタリングするには、「 フィルタリングされた同期」を参照してください。

リクエスト:

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

応答:

{"success":true}

レプリカセットからシャーシャードクラスタへの同期の開始

リクエスト:

curl localhost:27182/api/v1/start -XPOST \
--data '
   {
      "source": "cluster0",
      "destination": "cluster1",
      "sharding": {
         "createSupportingIndexes": true,
         "shardingEntries": [
            {
                "database": "accounts",
                "collection": "us_east",
                "shardCollection": {
                   "key": [
                      { "location": 1 },
                      { "region": 1 }
                   ]
                }
            }
         ]
      }
   } '

応答:

{"success":true}

検証子を無効にして を開始する

1.9 以降では、移行を開始すると 埋め込み検証子がデフォルトで実行されます。 無効にする必要がある場合は、verification.enabled を false に設定します。

リクエスト:

curl localhost:27182/api/v1/start -XPOST \
--data '
   {
      "source": "cluster0",
      "destination": "cluster1",
      "verification": {
         "enabled": false
      }
   } '

応答:

{"success":true}

アプリケーションの負荷を宛先クラスターに転送する前に、移行が成功したことを確認する必要があります。 何らかの理由で検証子を無効にする必要がある場合は、別の方法を使用して同期を検証してください。

埋め込み検証子

1.9 以降、mongosync は、ソースクラスターから宛先へのデータ転送が成功したかどうかを判断するための埋め込み検証子を提供します。

有効にすると、検証ツールは宛先クラスターに対して一連の検証チェックを実行します。 これらのチェックのいずれかでエラーが返された場合、検証子は移行を失敗します 。 すべてのチェックが成功すると、mongosync は COMMITTED 状態に移行します。

検証子を無効にするには、「 検証子を無効にして起動する 」を参照してください。

ソースクラスターまたは宛先クラスターでサポートされていない検証チェックを有効にした場合、またはメモリが不足している場合、/start エンドポイントはエラーを返します。

状態

startリクエストが成功すると、 mongosyncはRUNNING状態になります。

レプリカセットのシャーディング

レプリカセットからシャーディングされたクラスターへの同期にはshardingオプションが必要です。 このオプションは、 mongosyncがコレクションをシャーディングする方法を構成します。

sharding.shardingEntries配列は、シャーディングするコレクションを指定します。 この配列にリストされていないコレクションは、シャーディングされていないコレクションとして複製されます。

詳しくは、「シャードクラスタの動作 」を参照してください。

サポートインデックス

mongosync は、ソースクラスターから宛先クラスターにインデックスを同期します。 レプリカセットからシャーディングされたクラスターに同期する場合、mongosync はソースクラスターに存在しない場合があるシャードキーをサポートするために追加のインデックスが必要になる場合があります。

mongosyncは、同期中にシャーディングされたコレクション用のサポート インデックスを作成できます。 これは、 sharding.createSupportingIndexesオプションを設定することで可能です。

sharding.createSupportingIndexesがfalse （デフォルト）の場合

• sharding.shardingEntriesオプションに指定する各シャードキーには、ソースクラスターに既存のインデックスが必要です。

• コレクションで他の照合を使用する場合、シャードキーに使用されるインデックスの 1 つは単純照合が必要です。

• シャードキーで一意のインデックスを使用するには、ソースクラスターでインデックスを作成するときに、その一意性を指定する必要があります。

• 宛先クラスターのリクエストされたシャードキーと互換性のないソースクラスターのユニークインデックス（宛先のプレフィックスとして、リクエストされたシャードキーを含まないソースクラスターのユニークインデックスなど）では、 mongosyncが失敗する可能性があります。

sharding.createSupportingIndexesがtrueの場合:

• サポートするインデックスがソースクラスターに存在する場合、 mongosyncはインデックスを宛先クラスターに同期し、シャードキーとして使用します。

• サポート インデックスが存在しない場合、 mongosyncは宛先クラスターにそれらを作成します。

sharding.createSupportingIndexesオプションは、すべてのシャーディングされたコレクションに影響します。

同期中の名前変更

レプリカセットからシャーディングされたクラスターに同期されたときにsharding.shardingEntries配列にリストされているコレクションは、宛先クラスターでシャーディングされたコレクションになります。

startを呼び出した後、 mongosyncがコレクションのコピーを開始する前に、ソースクラスターでコレクションの名前を変更すると（ renameCollectionコマンドなど）、宛先でコレクションがシャーディングできなくなる可能性があります。

コレクションの名前を変更しても安全かどうかを確認するには、 progressエンドポイントを呼び出し、返されたドキュメントのcollectionCopy.estimatedCopiedBytesフィールドの値を確認します。

• 値が 0 の場合、 mongosyncによるコレクションのコピーが開始されていないことを示します。

  この時点でコレクションの名前を変更すると、ソースで名前変更が有効になる前にコピーへの移行が行われる可能性があるため、宛先クラスターでシャーディングされないコレクションが作成される可能性があります。

• 値が 0 より大きい場合は、 mongosyncがコピーを開始したことを示します。 この時点からコレクションの名前を変更しても、クラッシュが発生した場合でも、宛先クラスターでのシャーディングはブロックされません。

必要なインデックス

buildIndexesオプションをneverに設定して/startを呼び出すと、 mongosyncは不要なインデックスの構築をスキップします。

常に構築されるインデックスには、次のものが含まれます。

• mongosyncは、コピーしたすべてのコレクションの_idフィールドにインデックスを構築します。

• mongosyncは、宛先クラスターでシャードキーをサポートするためのインデックスがないシャーディングされたコレクションごとにダミーのインデックスを構築します。 buildIndexesがneverに設定されている場合、 mongosyncはコミット後にこのインデックスを保持します。

エンドポイント保護

mongosyncはstartエンドポイントを保護しません。 However, by default the API binds to localhost only and does not accept calls from other sources. さらに、 start呼び出しでは接続認証情報やユーザー データは公開されません。