データの変更を監視

項目一覧

Overview

サンプルデータ
変更ストリームを開く
変更ストリーム出力の変更
watch()の動作を変更
変更前と変更後のイメージを含めます
詳細情報
API ドキュメント

Overview

このガイドでは、変更ストリームを使用してデータベースへのリアルタイムの変更を監視する方法を学習できます。変更ストリームは、アプリケーションがコレクション、データベース、または配置のデータ変更をサブスクライブできる MongoDB Server の機能です。

サンプルデータ

このガイドの例では、 Atlas サンプルデータセットの sample_restaurants.restaurantsコレクションを使用します。無料の MongoDB Atlas クラスターを作成し、サンプルデータセットをロードする方法については、 PyMongo を使い始めるを参照してください。

変更ストリームを開く

変更ストリームを開くには、 watch()メソッドを呼び出します。 watch()メソッドを呼び出すインスタンスによって、変更ストリームがリッスンするイベントの範囲が決まります。次のクラスでwatch()メソッドを呼び出すことができます。

MongoClient: MongoDB 配置のすべての変更を監視
Database: データベース内のすべてのコレクションの変更を監視するには
Collection: コレクションの変更をモニターするには

次の例では、 restaurantsコレクションの変更ストリームを開き、変更が発生に応じて出力します。

database = client["sample_restaurants"]
collection = database["restaurants"]
with collection.watch() as stream:
    for change in stream:
        print(change)

変更の監視を開始するには、アプリケーションを実行します。次に、別のアプリケーションまたは shell で、 restaurantsコレクションを変更します。次の例では、 nameフィールドの値がBlarney Castleであるドキュメントを更新します。

database = client["sample_restaurants"]
collection = database["restaurants"]
query_filter = { "name": "Blarney Castle" }
update_operation = { '$set' : 
    { "cuisine": "Irish" }
}
result = collection.update_one(query_filter, update_operation)

コレクションを更新すると、変更ストリームアプリケーションは変更が発生に応じて出力します。出力される変更イベントは、次のようになります。

{'_id': {'_data': '...'}, 'operationType': 'update', 'clusterTime': Timestamp(...), 'wallTime': datetime.datetime(...),
'ns': {'db': 'sample_restaurants', 'coll': 'restaurants'}, 'documentKey': {'_id': ObjectId('...')},
'updateDescription': {'updatedFields': {'cuisine': 'Irish'}, 'removedFields': [], 'truncatedArrays': []}}

変更ストリーム出力の変更

pipelineパラメータをwatch()メソッドに渡して、変更ストリーム出力を変更できます。このパラメーターを使用すると、指定された変更イベントのみを監視できます。パラメーターを、それぞれが集計ステージを表すオブジェクトのリストとして形式します。

pipelineパラメーターでは、次のステージを指定できます。

$addFields
$match
$project
$replaceRoot
$replaceWith
$redact
$set
$unset

次の例では、 pipelineパラメータを使用して、アップデート操作のみを記録する変更ストリームを開きます。

change_pipeline = { "$match": { "operationType": "update" }},
with collection.watch(pipeline=change_pipeline) as stream:
    for change in stream:
        print(change)

変更ストリーム出力の変更の詳細については、MongoDB Server マニュアルの「変更ストリーム出力の変更」セクションを参照してください。

`watch()`の動作を変更する

watch()メソッドは、操作を構成するために使用できるオプションを表す任意のパラメーターを受け入れます。オプションを指定しない場合、ドライバーは操作をカスタマイズしません。

次の表では、 watch()の動作をカスタマイズするために設定できるオプションについて説明します。

プロパティ	説明
`pipeline`	A list of aggregation pipeline stages that modify the output of the change stream.
`full_document`	Specifies whether to show the full document after the change, rather than showing only the changes made to the document. To learn more about this option, see Include Pre-Images and Post-Images.
`full_document_before_change`	Specifies whether to show the full document as it was before the change, rather than showing only the changes made to the document. To learn more about this option, see Include Pre-Images and Post-Images.
`resume_after`	Directs `watch()` to resume returning changes after the operation specified in the resume token. Each change stream event document includes a resume token as the `_id` field. Pass the entire `_id` field of the change event document that represents the operation you want to resume after. `resume_after` is mutually exclusive with `start_after` and `start_at_operation_time`.
`start_after`	Directs `watch()` to start a new change stream after the operation specified in the resume token. Allows notifications to resume after an invalidate event. Each change stream event document includes a resume token as the `_id` field. Pass the entire `_id` field of the change event document that represents the operation you want to resume after. `start_after` is mutually exclusive with `resume_after` and `start_at_operation_time`.
`start_at_operation_time`	Directs `watch()` to return only events that occur after the specified timestamp. `start_at_operation_time` is mutually exclusive with `resume_after` and `start_after`.
`max_await_time_ms`	The maximum amount of time, in milliseconds, the server waits for new data changes to report to the change stream cursor before returning an empty batch. Defaults to 1000 milliseconds.
`show_expanded_events`	Starting in MongoDB Server v6.0, change streams support change notifications for Data Definition Language (DDL) events, such as the `createIndexes` and `dropIndexes` events. To include expanded events in a change stream, create the change stream cursor and set this parameter to `True`.
`batch_size`	The maximum number of change events to return in each batch of the response from the MongoDB cluster.
`collation`	The collation to use for the change stream cursor.
`session`	An instance of `ClientSession`.
`comment`	A comment to attach to the operation.

変更前と変更後のイメージを含めます

重要

配置で MongoDB v 6.0以降が使用されている場合にのみ、コレクションで変更前と変更後のイメージを有効にできます。

デフォルトでは、コレクションに対して操作を実行すると、対応する変更イベントにはその操作によって変更されたフィールドのデルタのみが含まれます。 full_document_before_changefull_document変更前または変更後の完全なドキュメントを表示するには、watch() メソッドでパラメータまたはパラメータを指定します。

変更前のイメージは、変更前のドキュメントの完全なバージョンです。変更ストリームイベントに変更前のイメージを含めるには、 full_document_before_changeパラメータを次のいずれかの値に設定します。

whenAvailable: 変更イベントには、変更前のイメージが利用可能な場合にのみ、変更イベント用の変更されたドキュメントの変更前のイメージが含まれます。
required: 変更イベントには、変更イベント用に変更されたドキュメントの変更前のイメージが含まれます。変更前のイメージが利用できない場合、ドライバーはエラーを発生させます。

変更後のイメージとは、変更後のドキュメントの完全なバージョンです。変更ストリームイベントに変更後のイメージを含めるには、 full_documentパラメータを次のいずれかの値に設定します。

updateLookup: 変更イベントには、変更後一定時間の変更されたドキュメント全体のコピーが含まれます。
whenAvailable: 変更イベントには、変更後のイメージが利用可能な場合にのみ、変更イベント用の変更されたドキュメントの変更後のイメージが含まれます。
required: 変更イベントには、変更イベントの変更されたドキュメントの変更後のイメージが含まれます。変更後のイメージが利用できない場合、ドライバーはエラーを発生させます。

次の例では、コレクションでwatch()メソッドを呼び出し、 fullDocumentパラメータを指定して更新されたドキュメントの変更後のイメージを含めています。

database = client["sample_restaurants"]
collection = database["restaurants"]
with collection.watch(full_document='updateLookup') as stream:
    for change in stream:
        print(change)

変更ストリームアプリケーションが実行されている場合、前述の更新例を使用してrestaurantsコレクション内のドキュメントを更新すると、次のような変更イベントが出力されます。

{'_id': {'_data': '...'}, 'operationType': 'update', 'clusterTime': Timestamp(...), 'wallTime': datetime.datetime(...),
 'fullDocument': {'_id': ObjectId('...'), 'address': {...}, 'borough': 'Queens',
 'cuisine': 'Irish', 'grades': [...], 'name': 'Blarney Castle', 'restaurant_id': '40366356'},
 'ns': {'db': 'sample_restaurants', 'coll': 'restaurants'}, 'documentKey': {'_id': ObjectId('...')},
 'updateDescription': {'updatedFields': {'cuisine': 'Irish'}, 'removedFields': [], 'truncatedArrays': []}}

変更前と変更後のイメージの詳細については、Change Streams MongoDB Serverマニュアルの「とドキュメントの変更前イメージおよび変更後イメージ」を参照してください。

詳細情報

Change Streams変更ストリームの詳細については、MongoDB Server マニュアルの「ストリーム」を参照してください。

API ドキュメント

このガイドで説明したメソッドや型の詳細については、次の API ドキュメントを参照してください。

戻る

カーソルからのデータへのアクセス

データベースコマンドの実行