module Mongo::Commands::Aggregate

Overview

Performs aggregation operation using the aggregation pipeline. The pipeline allows users to process data from a collection or other source with a sequence of stage-based manipulations.

NOTE for more details, please check the official MongoDB documentation.

Extended Modules

Defined in:

cryomongo/commands/aggregation/aggregate.cr

Class Method Summary

.name

Instance Method Summary

#command(database : String, collection : Collection::CollectionKey, pipeline : Array, options = nil)
Returns a pair of OP_MSG body and sequences associated with the command and arguments.
#may_use_secondary?(**args)
#result(bson : BSON)
Transforms the server result.
#retryable?(**args)
#write_command?(**args)

Class Method Detail

def self.name #

Instance Method Detail

def command(database : String, collection : Collection::CollectionKey, pipeline : Array, options = nil) #

Returns a pair of OP_MSG body and sequences associated with the command and arguments.

def may_use_secondary?(**args) #

def result(bson : BSON) #

Transforms the server result.

def retryable?(**args) #

def write_command?(**args) #