0Pricing
MongoDB Academy · Leçon

$out et $merge : écrire les résultats de la chaîne de traitement

Les apprenants dirigeront la sortie d’une agrégation vers une collection nouvelle ou existante avec $out et $merge pour réaliser des opérations ETL et des vues matérialisées.

$out et $merge : écrire les résultats de la chaîne de traitement est une leçon MongoDB Academy gratuite sur CoddyKit. Ceci est la leçon 4 sur 4. Tu peux lire la leçon complète ci-dessous gratuitement — puis la pratiquer en direct dans le navigateur avec un éditeur de code intégré et un tuteur IA 24/7. Elle fait partie du parcours d'apprentissage MongoDB Academy, et ta progression se synchronise sur le web et l'application CoddyKit. Le cours MongoDB Academy comprend 4 leçons au total.

Certaines parties de cette leçon n'ont pas encore été traduites et s'affichent en anglais.

Writing Pipeline Results to Collections

By default, aggregation pipeline results are returned to the client as a cursor. Sometimes you want to persist the results into a MongoDB collection for later use as a materialised view, a reporting cache, or an ETL target. MongoDB provides two stages for this: $out, which replaces a target collection atomically, and $merge, which upserts or merges results into an existing collection.

The $out Stage

$out writes all pipeline output documents to a new or existing collection in an atomic operation. If the target collection exists, $out replaces it entirely with the new results—the old collection is dropped and the new one takes its place atomically. If it doesn't exist, MongoDB creates it. $out must be the last stage in the pipeline and returns nothing to the client.

// Materialise monthly sales summary into its own collection
db.orders.aggregate([
  { $match: { status: 'completed' } },
  { $group: {
    _id: {
      year: { $year: '$createdAt' },
      month: { $month: '$createdAt' }
    },
    totalRevenue: { $sum: '$amount' },
    orderCount: { $sum: 1 }
  }},
  { $sort: { '_id.year': 1, '_id.month': 1 } },
  { $out: 'monthly_sales_summary' }  // last stage, writes to collection
]);

$out Atomicity Guarantee

$out provides atomic replacement: it writes all results to a temporary collection first, then renames the temporary collection to the target name in a single atomic operation. This means readers of the target collection always see either the old complete data or the new complete data—never a partial result. This makes $out safe for production use as a daily refresh of a reporting collection.

// Readers of 'monthly_sales_summary' always see complete data
// Even while $out is running, they see the previous full snapshot
// Only after $out completes does the new snapshot become visible

// Scheduled nightly refresh pattern:
// 1. Run at midnight: aggregate([...stages..., { $out: 'sales_report' }])
// 2. During the day: app reads from 'sales_report' (fast, pre-computed)
// 3. Next midnight: repeat

db.orders.aggregate([
  ...stages,
  { $out: 'sales_report' }  // atomic swap
]);

$out to a Different Database

Since MongoDB 4.4, $out supports an object syntax that lets you write to a collection in a different database. Specify both db (database name) and coll (collection name) in the object form. This is useful for separating operational and reporting databases on the same cluster.

// Write to a collection in a different database
db.orders.aggregate([
  { $match: { status: 'completed' } },
  { $group: { _id: '$region', revenue: { $sum: '$amount' } } },
  {
    $out: {
      db: 'reporting',          // target database
      coll: 'regional_revenue'  // target collection
    }
  }
]);
// Result is in reporting.regional_revenue

The $merge Stage

Introduced in MongoDB 4.2, $merge is more flexible than $out: instead of replacing the target collection, it upserts each output document into the target. You define the merge key (which field(s) identify existing documents), and for each output document, MongoDB decides whether to insert it, update an existing document, replace it, fail, or keep the existing document.

// Upsert daily stats into a persistent stats collection
db.events.aggregate([
  { $group: {
    _id: {
      date: { $dateToString: { format: '%Y-%m-%d', date: '$timestamp' } },
      eventType: '$type'
    },
    count: { $sum: 1 }
  }},
  {
    $merge: {
      into: 'daily_event_stats',
      on: ['_id'],              // match key
      whenMatched: 'replace',   // update matching docs
      whenNotMatched: 'insert'  // insert new docs
    }
  }
]);

$merge whenMatched Options

The whenMatched option controls what happens when a pipeline output document matches an existing document in the target collection. Options are: 'replace' — overwrite the existing document; 'merge' — merge fields (existing fields not in the output are kept); 'keepExisting' — do nothing, preserve the existing document; 'fail' — throw an error; or a custom pipeline for complex update logic.

// whenMatched: 'merge' - only update changed fields, keep others
db.orders.aggregate([
  { $project: { userId: 1, orderCount: { $literal: 1 } } },
  { $merge: {
    into: 'user_order_counts',
    on: 'userId',
    whenMatched: [{ $set: { orderCount: { $add: ['$orderCount', '$$new.orderCount'] } } }],
    whenNotMatched: 'insert'
  }}
]);
// Custom pipeline in whenMatched adds to existing count instead of replacing

$merge whenNotMatched Options

The whenNotMatched option controls what happens when a pipeline output document has no match in the target collection. Options are: 'insert' — add the new document to the target; 'discard' — ignore it (don't insert); or 'fail' — throw an error. The most common combination is whenMatched: 'replace', whenNotMatched: 'insert', which implements a full upsert.

// Full upsert: replace existing, insert new
{ $merge: {
  into: 'product_stats',
  on: '_id',
  whenMatched: 'replace',
  whenNotMatched: 'insert'
}}

// Update only existing, silently skip new
{ $merge: {
  into: 'product_stats',
  on: '_id',
  whenMatched: 'replace',
  whenNotMatched: 'discard'  // only update existing products
}}

Incremental Materialised Views With $merge

One of the most powerful patterns enabled by $merge is incremental materialised views: instead of recomputing the entire summary every time, you run the pipeline only on new data (using a $match on a recent timestamp) and merge the incremental results into the summary collection. This makes refresh much faster for large datasets.

// Incremental update: only process last hour of orders
const oneHourAgo = new Date(Date.now() - 3600000);

db.orders.aggregate([
  { $match: { createdAt: { $gte: oneHourAgo } } },  // only NEW data
  { $group: {
    _id: '$productId',
    recentRevenue: { $sum: '$amount' },
    recentOrders: { $sum: 1 }
  }},
  { $merge: {
    into: 'product_revenue',
    on: '_id',
    whenMatched: [
      { $set: {
        totalRevenue: { $add: ['$totalRevenue', '$$new.recentRevenue'] },
        totalOrders: { $add: ['$totalOrders', '$$new.recentOrders'] }
      }}
    ],
    whenNotMatched: 'insert'
  }}
]);

$out vs $merge: When to Use Each

Use $out when you want a complete snapshot replacement: the target should always be the full, fresh result of the pipeline—no partial updates, no retained history. Good for nightly batch reports that replace yesterday's data. Use $merge when you want to incrementally update, append to, or upsert into an existing collection without losing data that was not re-computed in this run. Good for real-time or near-real-time aggregation that runs hourly.

// $out: nightly full replace
// Run at midnight: compute full summary, atomically replace target
{ $out: 'monthly_report' }

// $merge: hourly incremental update
// Run every hour: compute last hour's delta, merge into running total
{ $merge: {
  into: 'running_totals',
  on: '_id',
  whenMatched: 'merge',
  whenNotMatched: 'insert'
}}

Permissions and Indexes on $out/$merge Targets

When $out recreates a collection, it drops all indexes on the target (except the _id index). You must recreate any secondary indexes after an $out run. $merge preserves existing indexes on the target collection. This is another reason to prefer $merge for frequently refreshed collections—you don't lose your indexes on each run.

// After $out, recreate indexes on the refreshed collection
db.orders.aggregate([...stages, { $out: 'order_summary' }]);
// Now recreate needed indexes:
db.order_summary.createIndex({ userId: 1 });
db.order_summary.createIndex({ createdAt: -1 });

// $merge preserves existing indexes automatically
// No index recreation needed after $merge

ETL Pipelines With $merge

$merge enables MongoDB-native ETL (Extract-Transform-Load) pipelines: extract data from a source collection, transform it through aggregation stages, and load the results into a destination collection. This avoids the need for an external ETL tool for common data movement tasks within the same MongoDB cluster.

// ETL: clean and transform raw events into a processed_events collection
db.raw_events.aggregate([
  // Extract: filter valid events
  { $match: { eventType: { $in: ['click', 'view', 'purchase'] }, userId: { $exists: true } } },
  // Transform: reshape and enrich
  { $addFields: {
    processedAt: '$$NOW',
    eventDate: { $dateToString: { format: '%Y-%m-%d', date: '$timestamp' } }
  }},
  { $project: { _id: 0, eventType: 1, userId: 1, eventDate: 1, processedAt: 1 } },
  // Load: upsert into destination
  { $merge: {
    into: 'processed_events',
    on: ['userId', 'eventDate', 'eventType'],
    whenMatched: 'keepExisting',  // don't reprocess
    whenNotMatched: 'insert'
  }}
]);

Quick Check

Test your understanding of $out and $merge pipeline stages.

Lesson Recap

In this lesson you learned: $out atomically replaces a target collection but drops secondary indexes, $merge upserts documents with configurable whenMatched and whenNotMatched behavior, and incremental materialised views with $merge allow efficient partial refreshes. This completes the Advanced Aggregation Stages course—next up we explore aggregation accumulators in depth.

Questions Fréquemment Posées

La leçon « $out et $merge : écrire les résultats de la chaîne de traitement » est-elle gratuite ?

Oui — le texte complet de « $out et $merge : écrire les résultats de la chaîne de traitement » est gratuit à lire ici sur le web. Pour la pratiquer de manière interactive (un éditeur de code intégré et un tuteur IA 24/7) et déverrouiller le reste du cours MongoDB Academy, passe à CoddyKit PRO. Le cours MongoDB Academy comprend 4 leçons au total.

Qu'est-ce que j'apprendrai dans « $out et $merge : écrire les résultats de la chaîne de traitement » ?

Les apprenants dirigeront la sortie d’une agrégation vers une collection nouvelle ou existante avec $out et $merge pour réaliser des opérations ETL et des vues matérialisées. Tu pratiques MongoDB Academy avec du code pratique que tu exécutes directement dans le navigateur, et un tuteur IA 24/7 répond à tes questions au fur et à mesure que tu avances dans la leçon.

Dois-je avoir de l'expérience pour commencer MongoDB Academy ?

Aucune expérience préalable n'est requise. MongoDB Academy sur CoddyKit est structuré pour les débutants jusqu'aux apprenants avancés, donc tu peux commencer ici ou depuis le début et avancer à ton rythme. Ceci est la leçon 4 sur 4.

Combien de temps prend la leçon « $out et $merge : écrire les résultats de la chaîne de traitement » ?

La plupart des leçons CoddyKit prennent environ 5–10 minutes. Chacune est courte et interactive, tu progresses régulièrement et tu repiques exactement où tu t'es arrêté sur le web et l'app.

Peux-tu écrire et exécuter du code dans cette leçon MongoDB Academy ?

Oui. Chaque leçon MongoDB Academy inclut un éditeur de code intégré, tu écris et exécutes du vrai code directement dans ton navigateur et tu reçois des retours IA instantanés — aucune configuration locale requise.

Toutes les leçons de ce cours

  1. $lookup : joindre des collections dans la chaîne de traitement
  2. $unwind : décomposer les champs de tableau
  3. $addFields, $replaceRoot et $mergeObjects
  4. $out et $merge : écrire les résultats de la chaîne de traitement
← Retour à MongoDB Academy