Azure Cosmos DB の MongoDB 用 API での変更ストリーム

適用対象: MongoDB 用 Azure Cosmos DB API

Azure Cosmos DB の MongoDB 用 API での変更フィードのサポートは、変更ストリーム API を使用することで利用できます。 アプリケーションで変更ストリーム API を使用すると、単一のシャード内のコレクションまたは項目に対して行われた変更を取得できます。 その後、結果に基づいてさらにアクションを実行できます。 コレクション内の項目に対する変更は、変更時刻の順序でキャプチャされ、並べ替え順序はシャード キーごとに保証されます。

注意

変更ストリームを使用するには、サーバー バージョン 3.6 以降で Azure Cosmos DB の MongoDB 用 API アカウントを作成します。 変更ストリームの例を以前のバージョンに対して実行すると、"Unrecognized pipeline stage name: $changeStream (認識できないパイプライン ステージ名: $changeStream) " エラーが表示されることがあります。

次の例では、コレクション内のすべての項目で変更ストリームを取得する方法を示します。 この例では、項目の挿入、更新、置換を監視するためのカーソルを作成します。 変更ストリームを取得するには、$match ステージ、$project ステージ、および fullDocument オプションが必要です。 変更ストリームを使用した削除操作の監視は、現在はサポートされていません。 回避策として、削除される項目にソフト マーカーを追加できます。 たとえば、"deleted" という名前の項目に属性を追加できます。 項目を削除するときは、"deleted" を true に設定し、項目で TTL を設定します。 "deleted" の true への更新が更新されるまで、この変更は変更ストリームに表示されます。

var cursor = db.coll.watch(
    [
        { $match: { "operationType": { $in: ["insert", "update", "replace"] } } },
        { $project: { "_id": 1, "fullDocument": 1, "ns": 1, "documentKey": 1 } }
    ],
    { fullDocument: "updateLookup" });

while (!cursor.isExhausted()) {
    if (cursor.hasNext()) {
        printjson(cursor.next());
    }
}

1 つのシャード内の変更

次の例では、1 つのシャード内の項目に対する変更を取得する方法を示します。 この例では、シャード キーが "a" で、シャード キー値が "1" の項目の変更を取得します。 異なるシャードの変更を複数のクライアントで並列に読み取ることができます。

var cursor = db.coll.watch(
    [
        { 
            $match: { 
                $and: [
                    { "fullDocument.a": 1 }, 
                    { "operationType": { $in: ["insert", "update", "replace"] } }
                ]
            }
        },
        { $project: { "_id": 1, "fullDocument": 1, "ns": 1, "documentKey": 1} }
    ],
    { fullDocument: "updateLookup" });

現在の制限

変更ストリームを使用する場合、次の制限が適用されます。

  • operationType および updateDescription プロパティは、出力ドキュメントではまだサポートされていません。
  • insertupdatereplace の操作の種類は、現在サポートされています。 ただし、削除操作またはその他のイベントは、まだサポートされていません。

これらの制限により、前の例で示したように、$match ステージ、$project ステージ、および fullDocument オプションが必要になります。

Azure Cosmos DB の SQL API での変更フィードとは異なり、変更ストリームの使用や、リース コンテナーのニーズのために、個別の変更フィード プロセッサ ライブラリはありません。 現在、変更ストリームを処理するための Azure Functions トリガーはサポートされていません。

エラー処理

変更ストリームを使用するときは、次のエラー コードとメッセージがサポートされます。

  • HTTP エラー コード 16500 - 変更ストリームが調整されると、空のページが返されます。

  • NamespaceNotFound (OperationType 無効化) - 存在しないコレクションで変更ストリームを実行した場合、またはコレクションが削除された場合は、NamespaceNotFound エラーが返されます。 出力ドキュメントでは operationType プロパティを返すことができないため、operationType Invalidate エラーの代わりに、NamespaceNotFound エラーが返されます。

次のステップ