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

Incluir campos específicos em documentos de saída

O seguinte estágio do inclui somente $project os _id title rated campos, e:

db.movies.aggregate( [
   { $match: { title: "The Great Train Robbery" } },
   { $project: { title: 1, rated: 1 } },
   { $limit: 1 }
] )

[
  {
    _id: ObjectId('573a1390f29313caabcd42e8'),
    title: 'The Great Train Robbery',
    rated: 'TV-G'
  }
]

Supressão do campo _id nos documentos de saída

O MongoDB inclui o _id campo por padrão. Para excluir o _id campo do estágio, defina $project o _id campo como 0 no documento de projeção .

O $project estágio seguinte exclui o _id campo, mas inclui os title rated campos e:

db.movies.aggregate( [
   { $match: { title: "The Great Train Robbery" } },
   { $project : { _id: 0, title : 1, rated : 1 } },
   { $limit: 1 }
] )

[ { title: 'The Great Train Robbery', rated: 'TV-G' } ]

Excluir campos de documentos de saída

O estágio $project a seguir exclui o campo rated da saída:

db.movies.aggregate( [
   { $match: { title: "The Great Train Robbery" } },
   { $project : { "rated": 0 } },
   { $limit: 1 }
] )

Alternativamente, utilize o estágio para excluir $unset campos.

Excluir campos de documentos incorporados

O estágio $project a seguir exclui os campos imdb.id e type da saída:

db.movies.aggregate( [
   { $match: { title: "The Great Train Robbery" } },
   { $project: { "imdb.id": 0, "type": 0 } },
   { $limit: 1 }
] )

[
  {
    _id: ObjectId('573a1390f29313caabcd42e8'),
    plot: 'A group of bandits stage a brazen train hold-up, only to find a determined posse hot on their heels.',
    genres: [ 'Short', 'Western' ],
    runtime: 11,
    cast: [
      'A.C. Abadie',
      "Gilbert M. 'Broncho Billy' Anderson",
      'George Barnes',
      'Justus D. Barnes'
    ],
    poster: 'https://m.media-amazon.com/images/M/MV5BMTU3NjE5NzYtYTYyNS00MDVmLWIwYjgtMmYwYWIxZDYyNzU2XkEyXkFqcGdeQXVyNzQzNzQxNzI@._V1_SY1000_SX677_AL_.jpg',
    title: 'The Great Train Robbery',
    fullplot: "Among the earliest existing films in American cinema - notable as the first film that presented a narrative story to tell - it depicts a group of cowboy outlaws who hold up a train and rob the passengers. They are then pursued by a Sheriff's posse. Several scenes have color included - all hand tinted.",
    languages: [ 'English' ],
    released: ISODate('1903-12-01T00:00:00.000Z'),
    directors: [ 'Edwin S. Porter' ],
    rated: 'TV-G',
    awards: { wins: 1, nominations: 0, text: '1 win.' },
    lastupdated: '2015-08-13 00:27:59.177000000',
    year: 1903,
    imdb: { rating: 7.4, votes: 9847 },
    countries: [ 'USA' ],
    tomatoes: {
      viewer: { rating: 3.7, numReviews: 2559, meter: 75 },
      fresh: 6,
      critic: { rating: 7.6, numReviews: 6, meter: 100 },
      rotten: 0,
      lastUpdated: ISODate('2015-08-08T19:16:10.000Z')
    },
    num_mflix_comments: 0
  }
]

Como alternativa, você pode aninhar a especificação de exclusão em um documento:

db.movies.aggregate( [
   { $match: { title: "The Great Train Robbery" } },
   { $project: { "imdb": { "id": 0 }, "type" : 0 } },
   { $limit: 1 }
] )

[
  {
    _id: ObjectId('573a1390f29313caabcd42e8'),
    plot: 'A group of bandits stage a brazen train hold-up, only to find a determined posse hot on their heels.',
    genres: [ 'Short', 'Western' ],
    runtime: 11,
    cast: [
      'A.C. Abadie',
      "Gilbert M. 'Broncho Billy' Anderson",
      'George Barnes',
      'Justus D. Barnes'
    ],
    poster: 'https://m.media-amazon.com/images/M/MV5BMTU3NjE5NzYtYTYyNS00MDVmLWIwYjgtMmYwYWIxZDYyNzU2XkEyXkFqcGdeQXVyNzQzNzQxNzI@._V1_SY1000_SX677_AL_.jpg',
    title: 'The Great Train Robbery',
    fullplot: "Among the earliest existing films in American cinema - notable as the first film that presented a narrative story to tell - it depicts a group of cowboy outlaws who hold up a train and rob the passengers. They are then pursued by a Sheriff's posse. Several scenes have color included - all hand tinted.",
    languages: [ 'English' ],
    released: ISODate('1903-12-01T00:00:00.000Z'),
    directors: [ 'Edwin S. Porter' ],
    rated: 'TV-G',
    awards: { wins: 1, nominations: 0, text: '1 win.' },
    lastupdated: '2015-08-13 00:27:59.177000000',
    year: 1903,
    imdb: { rating: 7.4, votes: 9847 },
    countries: [ 'USA' ],
    tomatoes: {
      viewer: { rating: 3.7, numReviews: 2559, meter: 75 },
      fresh: 6,
      critic: { rating: 7.6, numReviews: 6, meter: 100 },
      rotten: 0,
      lastUpdated: ISODate('2015-08-08T19:16:10.000Z')
    },
    num_mflix_comments: 0
  }
]

Alternativamente, utilize o estágio para excluir $unset campos.

Excluir campos condicionalmente

Você pode usar a variável REMOVE em expressões de aggregation para suprimir condicionalmente um campo.

O estágio a seguir $project usa a variável para excluir REMOVE o imdb.votes campo se ele for igual a null ou for uma string vazia:

db.movies.aggregate( [
   { $match: { title: "This Is Spinal Tap" } },
   {
      $project: {
         title: 1,
         "imdb.rating": 1,
         "imdb.id": 1,
         "imdb.votes": {
            $cond: {
               if: { $in: [ "$imdb.votes", [ null, "" ] ] },
               then: "$$REMOVE",
               else: "$imdb.votes"
            }
         }
      }
   },
   { $limit: 1 }
] )

[
  {
    _id: ObjectId('573a1398f29313caabce94a3'),
    title: 'This Is Spinal Tap',
    imdb: { rating: 8, id: 88258 }
  }
]

Como imdb.votes é uma string vazia para este documento, o MongoDB exclui o campo da saída.

Incluir campos específicos de documentos incorporados

Os documentos na movies coleção contêm um imdb documento incorporado com os rating votes id campos, e. Para incluir somente o rating campo do imdb documento, use notação de ponto:

db.movies.aggregate( [
   { $match: { title: "The Great Train Robbery" } },
   { $project: { "imdb.rating": 1 } },
   { $limit: 1 }
] )

[
  {
    _id: ObjectId('573a1390f29313caabcd42e8'),
    imdb: { rating: 7.4 }
  }
]

Ou aninhe a especificação de inclusão em um documento:

db.movies.aggregate( [
   { $match: { title: "The Great Train Robbery" } },
   { $project: { imdb: { rating: 1 } } },
   { $limit: 1 }
] )

[
  {
    _id: ObjectId('573a1390f29313caabcd42e8'),
    imdb: { rating: 7.4 }
  }
]

Incluir campos calculados

O estágio a seguir $project adiciona os leadActor releaseYear campos e:

db.movies.aggregate( [
   { $match: { title: "The Great Train Robbery" } },
   {
      $project: {
         title: 1,
         leadActor: { $arrayElemAt: [ "$cast", 0 ] },
         releaseYear: "$year"
      }
   },
   { $limit: 1 }
] )

[
  {
    _id: ObjectId('573a1390f29313caabcd42e8'),
    title: 'The Great Train Robbery',
    leadActor: 'A.C. Abadie',
    releaseYear: 1903
  }
]

Projetar novos campos de array

A seguinte operação projeta os campos year e runtime como elementos em um novo campo myArray :

db.movies.aggregate( [
   { $match: { title: "The Great Train Robbery" } },
   { $project: { myArray: [ "$year", "$runtime" ] } },
   { $limit: 1 }
] )

[
  {
    _id: ObjectId('573a1390f29313caabcd42e8'),
    myArray: [ 1903, 11 ]
  }
]

Se a especificação da array incluir campos que não existem em um documento, a operação substituirá null como o valor desse campo.

Por exemplo, considerando o mesmo documento acima, a operação a seguir projeta os campos year, runtime e um campo $someField inexistente como elementos em um novo campo myArray:

db.movies.aggregate( [
   { $match: { title: "The Great Train Robbery" } },
   { $project: { myArray: [ "$year", "$runtime", "$someField" ] } },
   { $limit: 1 }
] )

[
  {
    _id: ObjectId('573a1390f29313caabcd42e8'),
    myArray: [ 1903, 11, null ]
  }
]

Incluir campos específicos em documentos de saída

Para incluir campos específicos ao usar o driver .NET/C#, chame o método Include() no construtor de projeção. É possível encadear chamadas Include() para incluir múltiplos campos.

O exemplo de código a seguir produz um documento que inclui apenas os campos _id, plot e title:

var pipeline = new EmptyPipelineDefinition<Movie> ()
    .Project(
        Builders<Movie>.Projection
            .Include(m => m.Title)
            .Include(m => m.Plot)
    );
var result = movieCollection.Aggregate(pipeline).FirstOrDefault();

O pipeline retorna o seguinte documento:

{
  "_id" : { "$oid" : "573a1390f29313caabcd42e8" },
  "plot" : "A group of bandits stage a brazen train hold-up, only to find a
            determined posse hot on their heels.",
  "title" : "The Great Train Robbery"
}

Excluir campos de documentos de saída

Para excluir um campo dos documentos de resultado ao usar o driver .NET/C#, chame o método Exclude() no construtor de projeção. É possível encadear chamadas Exclude() para excluir vários campos.

O exemplo de código a seguir produz um documento que exclui o campo Type:

var pipeline = new EmptyPipelineDefinition<Movie>()
    .Project(
        Builders<Movie>.Projection
            .Exclude(m => m.Type)
    );
var result = movieCollection.Aggregate(pipeline).FirstOrDefault();

Por padrão, os documentos de resultado sempre incluem o campo _id. O exemplo de código a seguir produz um documento que exclui o campo _id, mas inclui os campos plot e title:

var pipeline = new EmptyPipelineDefinition<Movie> ()
    .Project(
        Builders<Movie>.Projection
            .Exclude(m => m.Id)
            .Include(m => m.Title)
            .Include(m => m.Plot)
    );
var result = movieCollection.Aggregate(pipeline).FirstOrDefault();

O pipeline resulta no seguinte documento:

{
  "plot" : "A group of bandits stage a brazen train hold-up, only to find a
            determined posse hot on their heels.",
  "title" : "The Great Train Robbery"
}

Excluir campos de documentos incorporados

Para excluir um campo em um documento incorporado ao usar o driver .NET/C#, chame o método Exclude() no construtor de projeção e forneça o caminho para a propriedade de classe correspondente. Você pode encadear chamadas Exclude() para excluir vários campos.

O exemplo de código a seguir produz um documento que exclui os campos imdb.id e type:

var pipeline = new EmptyPipelineDefinition<Movie> ()
    .Project(
        Builders<Movie>.Projection
            .Exclude("Imdb.id")
            .Exclude(m => m.Type)
    );
var result = movieCollection.Aggregate(pipeline).FirstOrDefault();

O pipeline resulta na seguinte saída:

{
  "plot" : "A group of bandits stage a brazen train hold-up, only to find a
            determined posse hot on their heels.",
  "title" : "The Great Train Robbery",
  ...
  "imdb" : { "rating" : 7.4000000000000004, "votes" : 9847 }
}

Excluir campos condicionalmente

Você pode usar a variável REMOVE em expressões de agregação para suprimir condicionalmente um campo:

var stage = new BsonDocument
{
    { "title", 1 },
    { "imdb.id", 1 },
    { "imdb.rating", 1 },
    {
        "imdb.votes", new BsonDocument("$cond", new BsonDocument
        {
            { "if", new BsonDocument("$eq", new BsonArray { "", "$imdb.votes" }) },
            { "then", "$$REMOVE" },
            { "else", "$imdb.votes" }
        })
    }
};
var pipeline = new EmptyPipelineDefinition<Movie>()
    .Project(stage)
    .Sample(1);
var result = movieCollection.Aggregate(pipeline).FirstOrDefault();

Se o documento amostrado contiver o campo imdb.votes, o pipeline retornará um documento semelhante ao seguinte:

{
  "_id" : { "$oid" : "573a1390f29313caabcd42e8" },
  "title" : "The Great Train Robbery",
  "imdb" : { "rating" : 7.4000000000000004, "id" : 439, "votes" : 9847 }
}

Se o documento não contiver o campo imdb.votes, o pipeline retornará um documento semelhante ao seguinte:

{
  "_id" : { "$oid" : "573a1398f29313caabce94a3" },
  "title" : "This Is Spinal Tap",
 "imdb" : { "rating" : 8.0, "id" : 88258 }
}

Incluir campos calculados

Para incluir campos calculados nos documentos de resultado ao usar o driver .NET/C#, chame o método Expression() no construtor de projeção e passe uma expressão que inclua os campos calculados. Para maior segurança de tipo, você pode definir uma classe de modelo para os documentos de resultado, como a classe ProjectedMovie a seguir:

public class ProjectedMovie
{
    public ObjectId Id { get; set; }
    public string Title { get; set; }
    
    public string LeadActor { get; set; }
    
    public List<string> Crew { get; set; }
}

O exemplo de código a seguir produz um documento que inclui vários campos computados:

var pipeline = new EmptyPipelineDefinition<Movie>()
    .Project(
        Builders<Movie>
            .Projection
            .Expression(m => new ProjectedMovie
            {
                Id = m.Id,
                Title = m.Title,
                LeadActor = m.Cast[0],
            })
    );
var result = movieCollection.Aggregate(pipeline).FirstOrDefault();

O pipeline resulta no seguinte documento:

{
  "_id" : { "$oid" : "573a1390f29313caabcd42e8" },
  "title" : "The Great Train Robbery",
  "leadActor" : "A.C. Abadie",
  ...
}

Projetar novos campos de array

Para projetar novos campos de array nos documentos de resultado ao usar o driver .NET/C#, chame o método Expression() no construtor de projeção e passe uma expressão que inclua os novos campos de array. Para maior segurança de tipo, você pode definir uma classe de modelo para os documentos de resultado, como a seguinte classe ProjectedMovie:

public class ProjectedMovie
{
    public ObjectId Id { get; set; }
    public string Title { get; set; }
    
    public string LeadActor { get; set; }
    
    public List<string> Crew { get; set; }
}

O exemplo de código a seguir gera documentos que incluem um novo campo de array, crew, que contém valores dos campos directors e writers:

var pipeline = new EmptyPipelineDefinition<Movie> ()
    .Project(
        Builders<Movie>
            .Projection
            .Expression(m => new ProjectedMovie
                {
                    Id = m.Id,
                    Title = m.Title,
                    LeadActor = m.Cast[0],
                    Crew = m.Directors.Concat(m.Writers).ToList()
                }
            )
    )
    .Sample(1);
var result = movieCollection.Aggregate(pipeline).FirstOrDefault();

O pipeline retorna um documento semelhante ao seguinte:

{
  "_id" : { "$oid" : "573a1395f29313caabce2297" },
  "title" : "The Chalk Garden",
  "leadActor" : "Deborah Kerr",
  "crew" : ["Ronald Neame", "John Michael Hayes (screenplay)", "Enid Bagnold (from the play by)"]
}

Se a especificação da array incluir campos que não existem em um documento, o pipeline substituirá null como o valor desse campo. Por exemplo, o exemplo de código a seguir projeta os campos directors, writers e um campo inexistente, makeupArtists, como elementos em um novo campo chamado crew:

var stage = new BsonDocument
{
    { "crew", new BsonArray { "$directors", "$writers", "$makeupArtists" } }
};
var pipeline = new EmptyPipelineDefinition<Movie>()
    .Project(stage)
    .Sample(1);
var result = movieCollection.Aggregate(pipeline).FirstOrDefault();

O pipeline retorna um documento semelhante ao seguinte:

{
  "_id" : { "$oid" : "573a1399f29313caabced0d9" },
  "crew" : [["Bill Kroyer"], ["Jim Cox (screenplay)", "Diana Young (original stories)"], null]
}

Incluir campos específicos em documentos de saída

Para incluir campos específicos, defina o valor do campo como 1 na etapa $project.

O exemplo a seguir retorna documentos que incluem apenas os campos _id, plot e title:

const pipeline = [
  {
    $project: {
      title: 1, 
      plot: 1
    }
  }
];
const cursor = collection.aggregate(pipeline);
return cursor;

Os documentos de saída se assemelham ao seguinte exemplo:

{
  _id: new ObjectId('573a1390f29313caabcd42e8'),
  plot: 'A group of bandits stage a brazen train hold-up, only to find a
            determined posse hot on their heels.',
  title: 'The Great Train Robbery'
}

Excluir campos de documentos de saída

Para excluir campos específicos, defina o valor do campo como 0 na etapa $project.

O exemplo a seguir retorna documentos que excluem o campo type:

const pipeline = [
  {
    $project: {
      type: 0
    }
  }
];
const cursor = collection.aggregate(pipeline);
return cursor;

Por padrão, os documentos de resultado sempre incluem o campo _id. O exemplo a seguir retorna documentos que excluem o campo _id, mas incluem os campos plot e title:

const pipeline = [
  {
    $project: {
      _id: 0, 
      title: 1,
      plot: 1 
    }
  }
];
const cursor = collection.aggregate(pipeline);
return cursor;

Os documentos de saída se assemelham ao seguinte exemplo:

{
  plot: 'A group of bandits stage a brazen train hold-up, only to find a
            determined posse hot on their heels.',
  title: 'The Great Train Robbery'
}

Excluir campos de documentos incorporados

Para excluir um campo em um documento incorporado, defina o valor do caminho do campo como 0 na etapa $project.

O exemplo a seguir retorna documentos que excluem os campos imdb.id e type:

const pipeline = [
  {
    $project: {
      "imdb.id": 0, 
      type: 0
    }
  }
];
const cursor = collection.aggregate(pipeline);
return cursor;

Os documentos de saída se assemelham ao seguinte exemplo:

{
  plot: 'A group of bandits stage a brazen train hold-up, only to find a
            determined posse hot on their heels.',
  title: 'The Great Train Robbery',
  imdb: { rating: 7.4000000000000004, votes: 9847 }
}

Excluir campos condicionalmente

Para excluir um campo de forma condicional, atribua uma lógica condicional que inclua a variável REMOVE ao nome do campo.

const pipeline = [
  {
    $project: {
      title: 1,
      "imdb.id": 1, 
      "imdb.rating": 1,
      "imdb.votes": {
        $cond: {
          if: { $eq: ["$imdb.votes", ""] },
          then: "$REMOVE",
          else: "$imdb.votes"
        }
      }
    }
  }
];
const cursor = collection.aggregate(pipeline);
return cursor;

Se um documento contiver o campo imdb.votes, o pipeline retornará documentos que se assemelham ao seguinte exemplo de saída:

{
  _id: new ObjectId('573a1390f29313caabcd42e8'),
  title: 'The Great Train Robbery',
  imdb: { rating : 7.4000000000000004, id: 439, votes: 9847 }
}

Se um documento não contiver o campo imdb.votes, o pipeline retorna documentos que se assemelham à seguinte saída de exemplo:

{
  _id: new ObjectId('573a1390f29313caabcd42e8'),
  title: 'This Is Spinal Tap',
  imdb: { rating: 8.0, id: 88258 }
}

Incluir campos calculados

Para incluir campos calculados nos documentos de resultado, atribua uma expressão ao campo que armazena os resultados.

O projeto a seguir projeta os campos _id e title em novos campos com o mesmo nome e calcula o novo campo leadActor. O exemplo então retorna documentos que incluem estes campos:

const pipeline = [
  {
    $project: {
      _id: "$_id",
      title: "$title",
      leadActor: { $arrayElemAt: ["$cast", 0] }
    }
  }
];
const cursor = collection.aggregate(pipeline);
return cursor;

Os documentos de saída se assemelham ao seguinte exemplo:

{
  _id: new ObjectId('573a1390f29313caabcd42e8'),
  title: 'The Great Train Robbery',
  leadActor: 'A.C. Abadie'
}

Projetar novos campos de array

Para projetar novos campos de array nos documentos de resultado, atribua ao campo que armazena o array uma expressão que calcule o novo campo de array.

O exemplo a seguir retorna documentos que incluem um novo campo de array, crew, que combina valores dos campos directors e writers:

const pipeline = [
  {
    $project: {
      _id: "$_id",
      title: "$title",
      leadActor: { $arrayElemAt: ["$cast", 0] },
      crew: { $concatArrays: ["$directors", "$writers"] }
    }
  }
];
const cursor = collection.aggregate(pipeline);
return cursor;

Os documentos de saída se assemelham ao seguinte exemplo:

{
  _id: new ObjectId('573a1395f29313caabce2297'),
  title: 'The Chalk Garden',
  leadActor: 'Deborah Kerr',
  crew: ['Ronald Neame', 'John Michael Hayes (screenplay)', 'Enid Bagnold (from the play by)']
}

Se a especificação do array incluir campos que não estão presentes em um documento, o pipeline substituirá null pelo valor desse campo. Por exemplo, o seguinte exemplo projeta os campos directors, writers e um campo inexistente, makeupArtists, como elementos em um novo campo chamado crew:

const pipeline = [
  {
    $project: {
      crew: ["$directors", "$writers", "$makeupArtists"]
    }
  }
];
const cursor = collection.aggregate(pipeline);
return cursor;

Os documentos de saída se assemelham ao seguinte exemplo:

{
  _id: new ObjectId('573a1399f29313caabced0d9'),
  crew: [['Bill Kroyer'], ['Jim Cox (screenplay)', 'Diana Young (original stories)'], null]
}