オープンChange Streams

例

この例では、 myCollコレクションで変更ストリームを開き、変更ストリーム イベントを発生に応じて出力する方法を示します。

ドライバーは変更ストリーム イベントをChangeStreamIterable型の変数に保存します。 次の例では、ドライバーがChangeStreamIterableオブジェクトにDocument型を入力することを指定します。 その結果、ドライバーは個々の変更ストリーム イベントをChangeStreamDocumentオブジェクトとして保存します。

MongoCollection<Document> collection = database.getCollection("myColl");
ChangeStreamIterable<Document> changeStream = collection.watch();
changeStream.forEach(event ->
        System.out.println("Received a change: " + event));

コレクションに対して挿入操作を実行すると、次の出力が生成されます。

Received a change: ChangeStreamDocument{
   operationType=insert,
   resumeToken={"_data": "..."},
   namespace=myDb.myColl,
   ...
}

実行可能な例については、「 変更監視 」の使用例ページを参照してください。

watch()メソッドの詳細については、次の API ドキュメントを参照してください。

• MongoCollection.watch()

• MongoDatabase.watch()

• MongoClient.watch()

例

次のコード例は、集計パイプラインを適用して、挿入操作とアップデート操作のみの変更イベントを受け取るように変更ストリームを構成する方法を示しています。

MongoCollection<Document> collection = database.getCollection("myColl");
List<Bson> pipeline = Arrays.asList(
        Aggregates.match(Filters.in("operationType", Arrays.asList("insert", "update"))));
ChangeStreamIterable<Document> changeStream = collection.watch(pipeline);
changeStream.forEach(event ->
        System.out.println("Received a change to the collection: " + event));

コレクションに対してアップデート操作を実行すると、次の出力が生成されます。

Received a change: ChangeStreamDocument{
   operationType=update,
   resumeToken={"_data": "..."},
   namespace=myDb.myColl,
   ...
}

変更前と変更後のイメージが有効になっているコレクションの作成

ドライバーを使用して、変更前イメージと変更後イメージ オプションが有効になっているコレクションを作成するには、次の例に示すように、 ChangeStreamPreAndPostImagesOptionsのインスタンスを指定し、 createCollection()メソッドを呼び出します。

CreateCollectionOptions collectionOptions = new CreateCollectionOptions();
collectionOptions.changeStreamPreAndPostImagesOptions(new ChangeStreamPreAndPostImagesOptions(true));
database.createCollection("myColl", collectionOptions);

MongoDB Shell からcollModコマンドを実行すると、既存のコレクションの変更前イメージと変更後イメージ オプションを変更できます。 この操作を実行する方法については、サーバー マニュアルのcollModに関するエントリを参照してください。

変更前のイメージの構成例

次のコード例は、 myCollコレクションの変更ストリームを構成して、変更前のイメージを含め、変更イベントを出力する方法を示しています。

MongoCollection<Document> collection = database.getCollection("myColl");
ChangeStreamIterable<Document> changeStream = collection.watch()
        .fullDocumentBeforeChange(FullDocumentBeforeChange.REQUIRED);
changeStream.forEach(event ->
        System.out.println("Received a change: " + event));

上記の例では、変更ストリームがFullDocumentBeforeChange.REQUIREDオプションを使用するように構成されています。 このオプションは、置換、アップデート、削除する変更イベントに変更前のイメージを要求するように変更ストリームを構成します。 変更前のイメージが利用できない場合、ドライバーはエラーを発生させます。

ドキュメントのamountフィールドの値を150から2000に更新するとします。 この変更イベントにより、次の出力が生成されます。

Received a change: ChangeStreamDocument{
   operationType=update,
   resumeToken={"_data": "..."},
   namespace=myDb.myColl,
   destinationNamespace=null,
   fullDocument=null,
   fullDocumentBeforeChange=Document{{_id=..., amount=150, ...}},
   ...
}

オプションのリストについては、次を参照して ください API ドキュメント。

変更後のイメージの構成例

次のコード例は、 myCollコレクションの変更ストリームを構成して、変更前のイメージを含め、変更イベントを出力する方法を示しています。

MongoCollection<Document> collection = database.getCollection("myColl");
ChangeStreamIterable<Document> changeStream = collection.watch()
        .fullDocument(FullDocument.WHEN_AVAILABLE);
changeStream.forEach(event ->
        System.out.println("Received a change: " + event));

上記の例では、変更ストリームがFullDocument.WHEN_AVAILABLEオプションを使用するように構成されています。 このオプションは、使用可能な場合、置換および更新の変更されたドキュメントの変更後のイメージを返すように変更ストリームを構成します。

ドキュメントのcolorフィールドの値を"purple"から"pink"に更新するとします。 変更イベントによって、次の出力が生成されます。

Received a change: ChangeStreamDocument{
   operationType=update,
   resumeToken={"_data": "..."},
   namespace=myDb.myColl,
   destinationNamespace=null,
   fullDocument=Document{{_id=..., color=purple, ...}},
   updatedFields={"color": purple},
   ...
}

オプションのリストについては、 FullDocument を参照してください API ドキュメント。