Change stream pipelines for filtering in MongoDB

Introduction

Change stream pipelines let you watch only the database changes you care about. This saves time and resources by filtering out unwanted updates.

You want to track only new orders in an online store.

You need to monitor changes to user profiles but ignore other data.

You want to react only when a document is deleted.

You want to log changes where a specific field value changes.

You want to update a cache only when certain data changes.

Syntax

MongoDB

db.collection.watch([pipeline], { options })

The pipeline is an array of aggregation stages that filter or transform change events.

You can use stages like $match to filter events by operation type or document fields.

Examples

Watch only new documents inserted into the orders collection.

MongoDB

db.orders.watch([
  { $match: { operationType: 'insert' } }
])

Watch changes where the user's status is 'active'.

MongoDB

db.users.watch([
  { $match: { 'fullDocument.status': 'active' } }
])

Watch only updates or replacements in the products collection.

MongoDB

db.products.watch([
  { $match: { operationType: { $in: ['update', 'replace'] } } }
])

Sample Program

This watches the orders collection and prints a message only when a new order is inserted.

MongoDB

const changeStream = db.orders.watch([
  { $match: { operationType: 'insert' } }
]);

changeStream.on('change', (change) => {
  print('New order inserted with id:', change.fullDocument._id);
});

Important Notes

Change streams require a replica set or a sharded cluster in MongoDB.

Filtering early in the pipeline reduces the amount of data sent to your application.

You can combine multiple stages to filter by operation type and document fields.

Summary

Change stream pipelines filter database change events.

Use $match to watch only specific operations or documents.

Filtering saves resources and focuses on relevant changes.

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