オープンChange Streams

例

次の例では、 directorsコレクションの変更ストリームを開きます。 このコードは、各 インスタンスの フィールドと フィールドにアクセスすることで、各変更イベントの操作タイプと変更されたドキュメントを出力します。operation_typefull_documentChangeStreamEvent

let mut change_stream = my_coll.watch().await?;
while let Some(event) = change_stream.next().await.transpose()? {
    println!("Operation performed: {:?}", event.operation_type);
    println!("Document: {:?}", event.full_document);
}

name値が"Wes Anderson"であるドキュメントをdirectorsコレクションに挿入すると、上記のコードによって次の出力が生成されます。

Operation performed: Insert
Document: Some(Director { name: "Wes Anderson", movies: [...], oscar_noms: 7 })

例

次の例では、アップデート操作でフィルタリングするための集計パイプラインを作成します。 次に、コードはパイプラインをpipeline()メソッドに渡し、アップデート操作用の変更イベントのみを受信して出力するように変更ストリームを構成します。

let mut update_change_stream = my_coll.watch()
    .pipeline(vec![doc! { "$match" : doc! { "operationType" : "update" } }])
    .await?;
while let Some(event) = update_change_stream.next().await.transpose()? {
    println!("Update performed: {:?}", event.update_description);
}

oscar_nomsフィールドの値を増やして、 name値が"Todd Haynes"であるドキュメントを更新すると、上記のコードによって次の出力が生成されます。

Update performed: Some(UpdateDescription { updated_fields: Document({
"oscar_noms": Int64(2)}), removed_fields: [], truncated_arrays: Some([]) })

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

コレクションでイメージ前ドキュメントとイメージ後ドキュメントを有効にするには、 change_stream_pre_and_post_images()オプション ビルダー メソッドを使用します。 次の例では、このビルダ メソッドを使用してコレクション オプションを指定し、変更前と変更後のイメージが利用可能なコレクションを作成します。

let enable = ChangeStreamPreAndPostImages::builder().enabled(true).build();
let result = my_db.create_collection("directors")
    .change_stream_pre_and_post_images(enable)
    .await?;

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

変更前のイメージ構成例

変更前イメージを含む変更イベントを返す変更ストリームを構成するには、 full_document_before_change()オプション ビルダー メソッドを使用します。 次の例では、変更ストリーム オプションを指定し、イメージ前ドキュメントを返す変更ストリームを作成します。

let pre_image = FullDocumentBeforeChangeType::Required;
let mut change_stream = my_coll.watch()
    .full_document_before_change(pre_image)
    .await?;
while let Some(event) = change_stream.next().await.transpose()? {
    println!("Operation performed: {:?}", event.operation_type);
    println!("Pre-image: {:?}", event.full_document_before_change);
}

上記の例では、 FullDocumentBeforeChangeType::Requiredの値をfull_document_before_change()オプション ビルダ メソッドに渡します。 この方法では、変更イベントの置換、アップデート、削除に変更前のイメージが必要になるように変更ストリームが構成されます。 変更前のイメージが利用できない場合、ドライバーはエラーを発生させます。

nameの値が"Jane Campion"であるドキュメントを更新すると、変更イベントによって次の出力が生成されます。

Operation performed: Update
Pre-image: Some(Director { name: "Jane Campion", movies: ["The Piano",
"Bright Star"], oscar_noms: 5 })

イメージ後構成の例

変更後イメージを含む変更イベントを返す変更ストリームを構成するには、 full_document()オプション ビルダー メソッドを使用します。 次の例では、ストリーム オプションを指定し、イメージ後ドキュメントを返す変更ストリームを作成します。

let post_image = FullDocumentType::WhenAvailable;
let mut change_stream = my_coll.watch()
    .full_document(post_image)
    .await?;
while let Some(event) = change_stream.next().await.transpose()? {
    println!("Operation performed: {:?}", event.operation_type);
    println!("Post-image: {:?}", event.full_document);
}

上記の例では、 FullDocument::WhenAvailableの値をfull_document()オプション ビルダ メソッドに渡します。 このメソッドは、変更後のイメージが利用可能な場合、置換、アップデート、削除の変更イベントの変更後のイメージを返すように変更ストリームを構成します。

nameの値が"Todd Haynes"であるドキュメントを削除すると、変更イベントによって次の出力が生成されます。

Operation performed: Delete
Post-image: None

API ドキュメント

このガイドで言及されているメソッドや型の詳細については、以下のAPIドキュメントを参照してください。

• watch()

• CreateCollectionOptions

• ChangeStreamOptions

• fullDocumentBeforechangeType

• fullDocumentType