Module: Mongoid::Contextual::Aggregable::Mongo

Included in:
Mongo
Defined in:
lib/mongoid/contextual/aggregable/mongo.rb

Overview

Contains behavior for aggregating values in Mongo.

Instance Method Summary collapse

Instance Method Details

#aggregates(field) ⇒ Hash

Get all the aggregate values for the provided field.

Examples:

Get all the aggregate values.

aggregable.aggregates(:likes)
# => {
#   "count" => 2.0,
#   "max" => 1000.0,
#   "min" => 500.0,
#   "sum" => 1500.0,
#   "avg" => 750.0
# }

Parameters:

  • field (String | Symbol) —

    The field name.

Returns:

  • (Hash) —

    A Hash containing the aggregate values. If no documents are found, then returned Hash will have count, sum of 0 and max, min, avg of nil.



28
29
30
31
32
33
34
35
36
37
38
39
 
# File 'lib/mongoid/contextual/aggregable/mongo.rb', line 28

def aggregates(field)
  result = collection.aggregate(pipeline(field), session: _session).to_a
  if result.empty?
    if Mongoid.broken_aggregables
      { "count" => 0, "sum" => nil, "avg" => nil, "min" => nil, "max" => nil }
    else
      Aggregable::EMPTY_RESULT.dup
    end
  else
    result.first
  end
end

#avg(field) ⇒ Float

Get the average value of the provided field.

Examples:

Get the average of a single field.

aggregable.avg(:likes)

Parameters:

  • field (Symbol) —

    The field to average.

Returns:

  • (Float) —

    The average.



49
50
51
 
# File 'lib/mongoid/contextual/aggregable/mongo.rb', line 49

def avg(field)
  aggregates(field)["avg"]
end

#max(field = nil) ⇒ Float | Document

Get the max value of the provided field. If provided a block, will return the Document with the greatest value for the field, in accordance with Ruby’s enumerable API.

Examples:

Get the max of a single field.

aggregable.max(:likes)

Get the document with the max value.

aggregable.max do |a, b|
  a.likes <=> b.likes
end

Parameters:

  • field (Symbol) (defaults to: nil) —

    The field to max.

Returns:

  • (Float | Document) —

    The max value or document with the max value.



69
70
71
 
# File 'lib/mongoid/contextual/aggregable/mongo.rb', line 69

def max(field = nil)
  block_given? ? super() : aggregates(field)["max"]
end

#min(field = nil) ⇒ Float | Document

Get the min value of the provided field. If provided a block, will return the Document with the smallest value for the field, in accordance with Ruby’s enumerable API.

Examples:

Get the min of a single field.

aggregable.min(:likes)

Get the document with the min value.

aggregable.min do |a, b|
  a.likes <=> b.likes
end

Parameters:

  • field (Symbol) (defaults to: nil) —

    The field to min.

Returns:

  • (Float | Document) —

    The min value or document with the min value.



89
90
91
 
# File 'lib/mongoid/contextual/aggregable/mongo.rb', line 89

def min(field = nil)
  block_given? ? super() : aggregates(field)["min"]
end

#sum(field = nil) ⇒ Float

Get the sum value of the provided field. If provided a block, will return the sum in accordance with Ruby’s enumerable API.

Examples:

Get the sum of a single field.

aggregable.sum(:likes)

Get the sum for the provided block.

aggregable.sum(&:likes)

Parameters:

  • field (Symbol) (defaults to: nil) —

    The field to sum.

Returns:

  • (Float) —

    The sum value.



105
106
107
 
# File 'lib/mongoid/contextual/aggregable/mongo.rb', line 105

def sum(field = nil)
  block_given? ? super() : aggregates(field)["sum"] || 0
end