$replaceRoot (etapa de agregación)

Definición

$replaceRoot

Reemplaza el documento de entrada con el documento especificado. La operación reemplaza todos los campos existentes en el documento de entrada, incluido el campo _id. Puede promover un documento incrustado existente al nivel superior o crear un nuevo documento para su promoción (ver ejemplo).

Nota

También puedes usar la etapa $replaceWith. La etapa $replaceWith realiza la misma acción que la etapa $replaceRoot, pero las etapas tienen formas diferentes.

La etapa $replaceRoot tiene la siguiente forma:

{ $replaceRoot: { newRoot: <replacementDocument> } }

El documento de reemplazo puede ser cualquier expresión válida que se resuelva en un documento. La etapa presenta errores y falla si <replacementDocument> no es un documento. Para obtener más información sobre expresiones, consulta Expresiones.

Comportamiento

Si <replacementDocument> no es un documento, $replaceRoot genera un error y falla.

Si <replacementDocument> se resuelve en un documento inexistente (es decir, el documento no existe), $replaceRoot genera un error y falla. Por ejemplo, cree una colección con los siguientes documentos:

db.collection.insertMany([
   { "_id": 1, "name" : { "first" : "John", "last" : "Backus" } },
   { "_id": 2, "name" : { "first" : "John", "last" : "McCarthy" } },
   { "_id": 3, "name": { "first" : "Grace", "last" : "Hopper" } },
   { "_id": 4, "firstname": "Ole-Johan", "lastname" : "Dahl" },
])

Entonces, la siguiente operación $replaceRoot falla porque uno de los documentos no tiene el campo name:

db.collection.aggregate([
   { $replaceRoot: { newRoot: "$name" } }
])

Para evitar el error, puedes usar $mergeObjects para fusionar el documento name en algún documento por defecto; por ejemplo:

db.collection.aggregate([
   { $replaceRoot: { newRoot: { $mergeObjects: [ { _id: "$_id", first: "", last: "" }, "$name" ] } } }
])

[
  { _id: 1, first: 'John', last: 'Backus' },
  { _id: 2, first: 'John', last: 'McCarthy' },
  { _id: 3, first: 'Grace', last: 'Hopper' },
  { _id: 4, first: '', last: '' }
]

Como alternativa, puede omitir los documentos a los que les falta el campo name incluyendo una etapa $match para comprobar la existencia del campo del documento antes de pasar los documentos a la etapa $replaceRoot:

db.collection.aggregate([
   { $match: { name : { $exists: true, $not: { $type: "array" }, $type: "object" } } },
   { $replaceRoot: { newRoot: "$name" } }
])

[
  { first: 'John', last: 'Backus' },
  { first: 'John', last: 'McCarthy' },
  { first: 'Grace', last: 'Hopper' }
]

O bien, puede usar la expresión $ifNull para especificar algún otro documento como raíz; por ejemplo:

db.collection.aggregate([
   { $replaceRoot: { newRoot: { $ifNull: [ "$name", { _id: "$_id", missingName: true} ] } } }
])

[
  { first: 'John', last: 'Backus' },
  { first: 'John', last: 'McCarthy' },
  { first: 'Grace', last: 'Hopper' },
  { _id: 4, missingName: true }
]

Ejemplos

db.people.insertMany([
   { "_id" : 1, "name" : "Arlene", "age" : 34, "pets" : { "dogs" : 2, "cats" : 1 } },
   { "_id" : 2, "name" : "Sam", "age" : 41, "pets" : { "cats" : 1, "fish" : 3 } },
   { "_id" : 3, "name" : "Maria", "age" : 25 }
])

db.people.aggregate( [
   { $replaceRoot: { newRoot: { $mergeObjects:  [ { dogs: 0, cats: 0, birds: 0, fish: 0 }, "$pets" ] } } }
] )

[
  { dogs: 2, cats: 1, birds: 0, fish: 0 },
  { dogs: 0, cats: 1, birds: 0, fish: 3 },
  { dogs: 0, cats: 0, birds: 0, fish: 0 }
]

db.students.insertMany([
   {
      "_id" : 1,
      "grades" : [
         { "test": 1, "grade" : 80, "mean" : 75, "std" : 6 },
         { "test": 2, "grade" : 85, "mean" : 90, "std" : 4 },
         { "test": 3, "grade" : 95, "mean" : 85, "std" : 6 }
      ]
   },
   {
      "_id" : 2,
      "grades" : [
         { "test": 1, "grade" : 90, "mean" : 75, "std" : 6 },
         { "test": 2, "grade" : 87, "mean" : 90, "std" : 3 },
         { "test": 3, "grade" : 91, "mean" : 85, "std" : 4 }
      ]
   }
])

db.students.aggregate( [
   { $unwind: "$grades" },
   { $match: { "grades.grade" : { $gte: 90 } } },
   { $replaceRoot: { newRoot: "$grades" } }
] )

[
  { test: 3, grade: 95, mean: 85, std: 6 },
  { test: 1, grade: 90, mean: 75, std: 6 },
  { test: 3, grade: 91, mean: 85, std: 4 }
]

db.contacts.insertMany([
   { "_id" : 1, "first_name" : "Gary", "last_name" : "Sheffield", "city" : "New York" },
   { "_id" : 2, "first_name" : "Nancy", "last_name" : "Walker", "city" : "Anaheim" },
   { "_id" : 3, "first_name" : "Peter", "last_name" : "Sumner", "city" : "Toledo" }
])

db.contacts.aggregate( [
   {
      $replaceRoot: {
         newRoot: {
            full_name: {
               $concat : [ "$first_name", " ", "$last_name" ]
            }
         }
      }
   }
] )

[
  { full_name: 'Gary Sheffield' },
  { full_name: 'Nancy Walker' },
  { full_name: 'Peter Sumner' }
]

db.contacts.insertMany( [
   { "_id" : 1, name: "Fred", email: "fred@example.net" },
   { "_id" : 2, name: "Frank N. Stine", cell: "012-345-9999" },
   { "_id" : 3, name: "Gren Dell", home: "987-654-3210", email: "beo@example.net" }
] )

db.contacts.aggregate( [
   { $replaceRoot:
      { newRoot:
         { $mergeObjects:
             [
                { _id: "", name: "", email: "", cell: "", home: "" },
                "$$ROOT"
             ]
          }
      }
   }
] )

[
  { _id: 1, name: 'Fred', email: 'fred@example.net', cell: '', home: '' },
  {
    _id: 2,
    name: 'Frank N. Stine',
    email: '',
    cell: '012-345-9999',
    home: ''
  },
  {
    _id: 3,
    name: 'Gren Dell',
    email: 'beo@example.net',
    cell: '',
    home: '987-654-3210'
  }
]

[BsonIgnoreExtraElements]
public class Movie
{
    [BsonId]
    public ObjectId Id { get; set; }
    [BsonElement("title")]
    public string Title { get; set; } = null!;
    [BsonElement("year")]
    public int? Year { get; set; }
    [BsonElement("runtime")]
    public int? Runtime { get; set; }
    [BsonElement("rated")]
    public string? Rated { get; set; }
    [BsonElement("metacritic")]
    public int Metacritic { get; set; }
    [BsonElement("plot")]
    public string? Plot { get; set; }
    [BsonElement("type")]
    public string? Type { get; set; }
    [BsonElement("cast")]
    public string[]? Cast { get; set; }
    [BsonElement("directors")]
    public string[]? Directors { get; set; }
    [BsonElement("writers")]
    public string[]? Writers { get; set; }
    [BsonElement("imdb")]
    public ImdbData? Imdb { get; set; }
}

[BsonIgnoreExtraElements]
public class ImdbData
{
    [BsonElement("id")]
    public int? ImdbId { get; set; }
    [BsonElement("rating")]
    public double? Rating { get; set; }
    [BsonElement("votes")]
    public int? Votes { get; set; }
}

var pipeline = new EmptyPipelineDefinition<Movie>()
    .Match(Builders<Movie>.Filter.Exists(m => m.Imdb))
    .Sort(Builders<Movie>.Sort.Ascending(m => m.Title))
    .Limit(5)
    .ReplaceRoot(m => m.Imdb);

{ "rating" : "...", "votes" : 142 }
{ "rating" : "...", "votes" : 77 }
{ "rating" : "...", "votes" : 1608 }
{ "rating" : "...", "votes" : 2532 }
{ "rating" : "...", "votes" : 24645 }

const pipeline = [{ $replaceRoot: { newRoot: "$imdb" } }];
const cursor = collection.aggregate(pipeline);
return cursor;

Obtén más información

Para obtener más información sobre las etapas relacionadas del proceso, consulte la guía $replaceRoot.