Change stream pipelines for filtering in MongoDB - Mini Project: Build & Apply

Change Stream Pipelines for Filtering in MongoDB

📖 Scenario: You are managing a MongoDB database for a small online bookstore. You want to monitor changes to the orders collection, but only for orders where the status is "shipped". This helps you react quickly to shipped orders without processing all changes.

🎯 Goal: Build a MongoDB change stream pipeline that filters change events to only include those where the status field in the fullDocument is "shipped".

📋 What You'll Learn

Create a change stream pipeline array called pipeline with a match stage filtering fullDocument.status equal to "shipped".

Create a variable called changeStream that watches the orders collection using the pipeline.

Use the watch method with the pipeline to filter change events.

Add a final option to the watch method to include the full document in the change event.

💡 Why This Matters

🌍 Real World

Filtering change streams is useful in real-time applications like order tracking, notifications, and syncing data where only specific changes matter.

💼 Career

Understanding change stream pipelines is important for backend developers and database administrators working with MongoDB to build efficient, reactive systems.

1

Create the change stream pipeline array

Create a variable called pipeline and set it to an array containing one object. This object should be a $match stage that filters documents where fullDocument.status is exactly "shipped".

MongoDB

# Your code here

Hint

Use $match inside the array to filter change events by the status field inside fullDocument.

2

Create the change stream watcher

Create a variable called changeStream and assign it the result of calling db.orders.watch(pipeline).

MongoDB

pipeline = [
    { "$match": { "fullDocument.status": "shipped" } }
]
# Your code here

Hint

Use the watch method on db.orders with the pipeline variable.

3

Add option to include full document in change events

Modify the changeStream assignment to call db.orders.watch(pipeline, { fullDocument: "updateLookup" }) so that the full updated document is included in change events.

MongoDB

pipeline = [
    { "$match": { "fullDocument.status": "shipped" } }
]
# Your code here

Hint

Pass the option { fullDocument: "updateLookup" } as the second argument to watch.

4

Complete the change stream setup

Ensure the pipeline and changeStream variables are defined exactly as before, with the watch method using the pipeline and the option { fullDocument: "updateLookup" }.

MongoDB

pipeline = [
    { "$match": { "fullDocument.status": "shipped" } }
]
changeStream = db.orders.watch(pipeline, { fullDocument: "updateLookup" })
# Your code here

Hint

Double-check that the pipeline and changeStream variables are exactly as required.

Practice

1. What is the main purpose of using a $match stage in a MongoDB change stream pipeline?

easy

A. To insert new documents into the collection

B. To create indexes on the collection

C. To delete documents from the collection

D. To filter change events and receive only relevant updates

Solution

1. Step 1: Understand change streams

   Change streams allow applications to listen to changes in MongoDB collections or databases.

2. Step 2: Role of $match in pipelines

   The $match stage filters these change events so only specific changes are passed through.

3. Final Answer:

   To filter change events and receive only relevant updates -> Option D

4. Quick Check:

   $match filters events [OK]

Hint: Remember: $match filters events to reduce noise [OK]

Common Mistakes:

• Thinking $match modifies data instead of filtering
• Confusing $match with data insertion or deletion
• Assuming $match creates indexes

2. Which of the following is the correct syntax to filter change stream events for only insert operations using $match?

easy

A. { $match: { operationType: 'insert' } }

B. { $match: { operationType: 'replace' } }

C. { $match: { operationType: 'delete' } }

D. { $match: { operationType: 'update' } }

Solution

1. Step 1: Identify operationType for inserts

   MongoDB change streams use operationType to specify the type of change, and 'insert' is the value for insert operations.

2. Step 2: Match only insert events

   The correct filter uses { $match: { operationType: 'insert' } } to watch only insert changes.

3. Final Answer:

   { $match: { operationType: 'insert' } } -> Option A

4. Quick Check:

   Filter inserts with operationType 'insert' [OK]

Hint: Match operationType: 'insert' to filter inserts [OK]

Common Mistakes:

• Using wrong operationType values like 'update' or 'delete'
• Missing quotes around 'insert'
• Using $match incorrectly outside pipeline

3. Given the following change stream pipeline, what events will be received?

[ { $match: { 'fullDocument.status': 'active' } } ]

medium

A. All change events regardless of document status

B. Only delete events

C. Only change events where the updated document has status 'active'

D. Only insert events with status 'inactive'

Solution

1. Step 1: Understand the filter condition

   The pipeline filters events where the fullDocument.status field equals 'active'.

2. Step 2: Effect on change events

   This means only events where the changed document's status is 'active' will pass through.

3. Final Answer:

   Only change events where the updated document has status 'active' -> Option C

4. Quick Check:

   Filter by fullDocument.status = 'active' [OK]

Hint: Filter on fullDocument fields to get specific document changes [OK]

Common Mistakes:

• Assuming all events pass through without filtering
• Confusing delete events which don't have fullDocument
• Thinking it filters by operationType

4. You wrote this change stream pipeline to watch only delete events:

[ { $match: { operationType: 'delete' } } ]

But you still receive update events. What is the likely mistake?

medium

A. The field name should be operation_type instead of operationType

B. The pipeline is not applied correctly or the driver ignores the filter

C. The $match stage is missing in the pipeline

D. Delete events do not have an operationType field

Solution

1. Step 1: Verify field name and filter correctness

   The field operationType is correct and the filter matches delete events properly.

2. Step 2: Consider pipeline application

   If update events still appear, the pipeline might not be applied correctly or the driver ignores the filter.

3. Final Answer:

   The pipeline is not applied correctly or the driver ignores the filter -> Option B

4. Quick Check:

   Incorrect pipeline application causes wrong events [OK]

Hint: Check if pipeline is properly passed to watch() method [OK]

Common Mistakes:

• Using wrong field name like operation_type
• Assuming delete events lack operationType
• Not passing pipeline to watch() function

5. You want to watch changes only for documents where category is 'books' and the operation is either 'insert' or 'update'. Which pipeline correctly filters these events?

hard

A. [ { $match: { $and: [ { 'fullDocument.category': 'books' }, { operationType: { $in: ['insert', 'update'] } } ] } } ]

B. [ { $match: { 'fullDocument.category': 'books', operationType: 'insert' } }, { $match: { operationType: 'update' } } ]

C. [ { $match: { operationType: 'insert' } }, { $match: { 'fullDocument.category': 'books' } } ]

D. [ { $match: { $or: [ { 'fullDocument.category': 'books' }, { operationType: 'insert' }, { operationType: 'update' } ] } } ]

Solution

1. Step 1: Combine conditions with $and

   We want documents where category is 'books' AND operationType is 'insert' or 'update'.

2. Step 2: Use $in for multiple operationTypes

   The correct way is to use $in inside $and to filter operationType for both 'insert' and 'update'.

3. Final Answer:

   [ { $match: { $and: [ { 'fullDocument.category': 'books' }, { operationType: { $in: ['insert', 'update'] } } ] } } ] -> Option A

4. Quick Check:

   Use $and with $in to combine filters [OK]

Hint: Use $and with $in to filter multiple conditions together [OK]

Common Mistakes:

• Using multiple $match stages that override each other
• Using $or instead of $and for combined conditions
• Not using $in for multiple operationTypes