$replaceRoot (estágio de agregação )

Definição

$replaceRoot

Substitui o documento de entrada pelo documento especificado. A operação substitui todos os campos existentes no documento de entrada, incluindo o campo _id. Você pode promover um documento incorporado existente para o nível superior ou criar um novo documento para promoção (veja o exemplo).

Observação

Você também pode utilizar o estágio $replaceWith . O estágio $replaceWith executa a mesma ação que o estágio $replaceRoot, mas os estágios têm formas diferentes.

O estágio $replaceRoot tem a seguinte forma:

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

O documento de substituição pode ser qualquer expressão válida que se resolva a um documento. O estágio apresenta erro e falha se <replacementDocument> não for um documento. Para mais informações sobre expressões, consulte Expressões.

Comportamento

Se o <replacementDocument> não for um documento, $replaceRoot apresenta erros e falha.

Se o <replacementDocument> resultar em um documento ausente (ou seja, o documento não existe), $replaceRoot apresentará erro e falhará. Por exemplo, crie uma coleção com os seguintes 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" },])

Então a seguinte operação $replaceRoot falha porque um dos documentos não tem o campo name:

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

Para evitar o erro, você pode usar $mergeObjects para mesclar o documento name em algum documento padrão. Por exemplo:

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: '' }]

Opcionalmente, você pode ignorar os documentos que não têm o campo name incluindo um estágio $match para verificar a existência do campo do documento antes de passar os documentos para o estágio $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' }]

Ou você pode usar a expressão $ifNull para especificar algum outro documento como root. Por exemplo:

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 }]

Exemplos

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;

Saiba mais

Para aprender mais sobre os estágios relacionados do pipeline, consulte o guia $replaceRoot.