Módulo: Mongoid::Contextual::Aggregable::Mongo

Incluido en:
Mongo
Definido en:
lib/mongoid/contextual/aggregable/mongo.rb

Overview

Contiene el comportamiento para agregar valores en Mongo.

Resumen del método de instancia colapsar

Detalles del método de instancia

#agrega(campo) ⇒ Hash

Obten todos los valores agregados para el campo proporcionado.

Ejemplos:

Obtén todos los valores agregados.

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

Parámetros:

  • Campo (String | Símbolo) —

    El nombre del campo.

Devuelve:

  • (encriptada) —

    Un Hash que contiene los valores agregados. Si no se encuentran documentos, el Hash devuelto tendrá un recuento, la suma de 0 y el valor máximo, mínimo y promedio de nulo.



29
30
31
32
33
34
35
36
 
# Archivo 'lib/mongoid/contextual/aggregable/mongo.rb', línea 29

def agregados(Campo)
  Resultado = Colección.Agregar(pipeline(Campo), sesión: _sesión).to_a
  si Resultado.¿vacío?
    Agregable::EMPTY_RESULT.dup
  else
    Resultado.primero
  end
end

#avg(campo) ⇒ Float

Obtenga el valor promedio del campo proporcionado.

Ejemplos:

Obtiene el promedio de un solo campo.

aggregable.avg(:likes)

Parámetros:

  • Campo (Símbolo) —

    El campo a promediar.

Devuelve:

  • (Float) —

    El promedio.



46
47
48
 
# Archivo 'lib/mongoid/contextual/aggregable/mongo.rb', línea 46

def promedio(Campo)
  agregados(Campo)["promedio"]
end

#max(campo = nil) ⇒ Float | Documento

Obtén el valor máximo del campo proporcionado. Si se proporciona un bloque, devolverá el Documento con el mayor valor para el campo, de acuerdo con la API Enumerable de Ruby.

Ejemplos:

Obtener el valor máximo de un solo campo.

aggregable.max(:likes)

Obtener el documento con el valor máximo.

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

Parámetros:

  • Campo (Símbolo) (predeterminado: nulo) —

    El campo al máximo.

Devuelve:

  • (Float | Documento) —

    El valor máximo o el documento con el valor máximo.



66
67
68
 
# Archivo 'lib/mongoid/contextual/aggregable/mongo.rb', línea 66

def máximo(Campo = nulo)
  ¿block_given? ? super() : agregados(Campo)["máximo"]
end

#min(campo = nil) ⇒ Float | Document

Obtén el valor mínimo del campo proporcionado. Si se proporciona un bloque, devolverá el Documento con el valor más pequeño para el campo, de acuerdo con la API enumerable de Ruby.

Ejemplos:

Obtener el mínimo de un solo campo.

aggregable.min(:likes)

Obtener el documento con el valor min.

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

Parámetros:

  • Campo (Símbolo) (predeterminado: nulo) —

    El campo a min.

Devuelve:

  • (Float | Documento) —

    El valor mínimo o documento con el valor mínimo.



86
87
88
 
# Archivo 'lib/mongoid/contextual/aggregable/mongo.rb', línea 86

def min(Campo = nulo)
  ¿block_given? ? super() : agregados(Campo)["min"]
end

#suma(campo = nil) ⇒ Float

Obtenga el valor sumado del campo proporcionado. Si se proporciona un bloque, devolverá la suma conforme a la API de enumerables de Ruby.

Ejemplos:

Obtenga la suma de un solo campo.

aggregable.sum(:likes)

Obtener la suma del bloque proporcionado.

aggregable.sum(&:likes)

Parámetros:

  • Campo (Simbolo | Numérico) (predeterminado: nulo) —

    El campo a sumar, o el valor inicial de la suma cuando se otorga un bloque.

Devuelve:

  • (Float) —

    El valor de la suma.



103
104
105
106
107
 
# Archivo 'lib/mongoid/contextual/aggregable/mongo.rb', línea 103

def suma(Campo = nulo)
  return super(Campo || 0) si ¿block_given?

  agregados(Campo)["sum"] || 0
end