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

Definição

$out

Pega os documentos retornados pelo pipeline de agregação e os grava na coleção especificada. Você pode especificar o banco de dados de saída.

O estágio $out deve ser o último estágio do pipeline. O operador $out permite que o framework de aggregation retorne conjuntos de resultados de qualquer tamanho.

Aviso

Se a coleção especificada pela operação $out já existir, então a etapa $out substituirá atomicamente a coleção existente pela nova coleção de resultados após a conclusão da agregação. Consulte Substituir coleção existente para mais informações.

Sintaxe

O estágio $out tem a seguinte sintaxe:

• $out pode usar uma string para especificar somente a collection de saída (ou seja, saída para uma collection no mesmo banco de dados):

  { $out: "<output-collection>" } // Output collection is in the same database

• $out pode usar um documento para especificar o banco de dados de saída, bem como a coleção de saída:

  { $out: { db: "<output-db>", coll: "<output-collection>" } }

• A partir do MongoDB 7.0.3 e 7.1, $out pode levar um documento para a saída para uma coleção de séries temporais:

  { $out:
    { db: "<output-db>", coll: "<output-collection>",
      timeseries: {
        timeField: "<field-name>",
        metaField: "<field-name>",
        granularity:  "seconds" || "minutes" || "hours" ,
      }
    }
  }

  Importante

  Alterando a granularidade de série temporal

  Depois de criar uma coleção de séries temporais, você poderá modificar sua granularidade usando o método collMod. No entanto, você só pode aumentar o intervalo de tempo coberto por cada bucket. Você não pode diminuí-lo.

  Campo	Descrição
  db	O nome do banco de dados de saída. Para um conjunto de réplicas ou um standalone, se o banco de dados de saída não existir, $out também criará o banco de dados. Para um cluster fragmentado, o banco de dados de saída especificado já deve existir.
  coll	O nome da collection de saída.
  timeseries	Um documento que especifica a configuração a ser usada ao gravar em uma coleção de séries temporais. O timeField é obrigatório. Todos os outros campos são opcionais.
  timeField	Obrigatório ao gravar em uma coleção de séries temporais. O nome do campo que contém a data em cada documento da série temporal. Os documentos em uma coleção de séries temporais devem ter uma data BSON válida como o valor do timeField.
  metaField	Opcional. O nome do campo que contém metadados em cada documento de série temporal. Os metadados no campo especificado devem ser dados utilizados para rotular uma série exclusiva de documentos. Os metadados raramente devem mudar. O nome do campo especificado não pode ser _id ou o mesmo que o timeseries.timeField. O campo pode ser de qualquer tipo de dados. Embora o campo metaField seja opcional, o uso de metadados pode melhorar a otimização da query. Por exemplo, o MongoDB cria automaticamente um índice composto nos campos metaField e timeField para novas collections. Se você não fornecer um valor para este campo, os dados serão agrupados exclusivamente com base no tempo.
  granularity	Opcional. Não use se estiver configurando bucketRoundingSeconds e bucketMaxSpanSeconds. Os valores possíveis são seconds (padrão), minutes e hours. Defina granularity como o valor que mais se aproxima do tempo entre carimbos de data/hora consecutivos de entrada. Isso melhora o desempenho otimizando a forma como o MongoDB armazena dados na collection. Para obter mais informações sobre granularidade e intervalos de bucket, consulte Definir granularidade para dados de séries temporais.
  bucketMaxSpanSeconds	Opcional. Use com bucketRoundingSeconds como alternativa a granularity. Define o tempo máximo entre os carimbos de data/hora no mesmo bloco. Os valores possíveis são 1-31536000. Novidades na versão 6.3.
  bucketRoundingSeconds	Opcional. Use com bucketMaxSpanSeconds como alternativa a granularity. Deve ser igual a bucketMaxSpanSeconds. Quando um documento requer um novo bucket, o MongoDB arredonda para baixo o valor de carimbo de data/hora do documento por esse intervalo para definir o tempo mínimo para o bucket. Novidades na versão 6.3.

Comportamentos

Exemplos

db.getSiblingDB("test").books.insertMany([
   { "_id" : 8751, "title" : "The Banquet", "author" : "Dante", "copies" : 2 },
   { "_id" : 8752, "title" : "Divine Comedy", "author" : "Dante", "copies" : 1 },
   { "_id" : 8645, "title" : "Eclogues", "author" : "Dante", "copies" : 2 },
   { "_id" : 7000, "title" : "The Odyssey", "author" : "Homer", "copies" : 10 },
   { "_id" : 7020, "title" : "Iliad", "author" : "Homer", "copies" : 10 }
])

db.getSiblingDB("test").books.aggregate( [
    { $group : { _id : "$author", books: { $push: "$title" } } },
    { $out : "authors" }
] )

db.getSiblingDB("test").authors.find()

{ "_id" : "Homer", "books" : [ "The Odyssey", "Iliad" ] }
{ "_id" : "Dante", "books" : [ "The Banquet", "Divine Comedy", "Eclogues" ] }

db.getSiblingDB("test").books.aggregate( [
    { $group : { _id : "$author", books: { $push: "$title" } } },
    { $out : { db: "reporting", coll: "authors" } }
] )

db.getSiblingDB("reporting").authors.find()

{ "_id" : "Homer", "books" : [ "The Odyssey", "Iliad" ] }
{ "_id" : "Dante", "books" : [ "The Banquet", "Divine Comedy", "Eclogues" ] }

public class Movie
{
    public ObjectId Id { get; set; }
    public int Runtime { get; set; }
    
    public string Title { get; set; }
    public string Rated { get; set; }
    public List<string> Genres { get; set; }
    public string Plot { get; set; }
    
    public ImdbData Imdb { get; set; }
    public int Year { get; set; }
    public int Index { get; set; }
    
    public string[] Comments { get; set; }
   
    [BsonElement("lastupdated")]
    public DateTime LastUpdated { get; set; }
}

var camelCaseConvention = new ConventionPack { new CamelCaseElementNameConvention() };
ConventionRegistry.Register("CamelCase", camelCaseConvention, type => true);

var movieCollection = client
    .GetDatabase("sample_mflix")
    .GetCollection<Movie>("movies");
var pipeline = new EmptyPipelineDefinition<Movie>()
    .Out(movieCollection);

const pipeline = [{ $out: { db: "sample_mflix", coll: "movies" } }];
const cursor = collection.aggregate(pipeline);
return cursor;