데이터 변경 사항 모니터링
개요
이 가이드에서는 변경 스트림 을 사용하여 데이터베이스의 실시간 변경 사항을 모니터링하는 방법을 배울 수 있습니다. 변경 스트림은 애플리케이션이 컬렉션, 데이터베이스 또는 배포의 데이터 변경 사항을 구독할 수 있도록 하는 MongoDB Server 기능입니다.
샘플 데이터
이 가이드 의 예제에서는 Atlas 샘플 데이터 세트 의 sample_restaurants.restaurants
컬렉션 을 사용합니다. 무료 MongoDB Atlas cluster 를 생성하고 샘플 데이터 세트를 로드하는 방법을 학습 보려면 PyMongo 시작하기를 참조하세요.
변경 스트림 열기
변경 스트림을 열려면 watch()
메서드를 호출합니다. watch()
메서드를 호출하는 인스턴스에 따라 변경 스트림이 수신 대기하는 이벤트 범위가 결정됩니다. 다음 클래스에서 watch()
메서드를 호출할 수 있습니다.
MongoClient
: MongoDB deployment의 모든 변경 사항을 모니터링합니다.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 v6.0 이상을 사용하는 경우에만 컬렉션에서 사전 이미지 및 사후 이미지를 활성화할 수 있습니다.
기본적으로 컬렉션에서 작업을 수행할 때 해당 변경 이벤트에는 해당 작업에 의해 수정된 필드의 델타만 포함됩니다. 변경 전후의 전체 문서를 보려면 watch()
메서드에서 full_document_before_change
또는 full_document
매개변수를 지정합니다.
사전 이미지 는 변경 전의 문서 전체 버전입니다. 변경 스트림 이벤트에 사전 이미지를 포함하려면 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 설명서를 참조하세요.