Modificar resultados de queries

Datos de muestra

Los ejemplos de esta guía utilizan el Band modelo, que representa una banda o grupo musical. La definición del modelo Band podría ser diferente para cada sección para demostrar diferentes funcionalidades de queries. Algunas secciones también utilizan el modelo Manager, que representa a una persona que gestionado una banda en particular, o el modelo Tour, que representa las presentaciones en vivo de la banda.

Incluir campos

El método only recupera solo los campos especificados de la base de datos.

El siguiente código devuelve solo el campo name de los documentos en los que el valor del campo members es 4:

Band.where(members: 4).only(:name)

Si intentas hacer referencia a atributos que no se han cargado, Mongoid genera un error Mongoid::Errors::AttributeNotLoaded.

También puedes usar el método only para incluir campos de documentos incrustados.

Tenga en cuenta que el modelo Band incorpora varios objetos Tour. Puede proyectar campos del modelo Tour, como year, como se muestra en el siguiente código:

bands = Band.only(:name, 'tours.year')

Después, puedes acceder a los campos incrustados de los documentos devueltos:

# Returns the first Tour object from
# the first Band in the results
bands.first.tours.first

Se pueden pasar campos de asociaciones referenciadas al método only, pero la proyección se ignora al cargar los objetos incrustados. Mongoid carga todos los campos de las asociaciones referenciadas. Por ejemplo, al acceder al objeto incrustado Tour, como se muestra en el código anterior, Mongoid devuelve el objeto completo, no solo el campo year.

Si un documento contiene asociaciones has_one o has_and_belongs_to_many y desea que Mongoid cargue esas asociaciones cuando llame al método only, debe incluir los campos con claves externas en la lista de atributos.

En el siguiente ejemplo, los modelos Band y Manager tienen una asociación has_and_belongs_to_many:

class Band
  include Mongoid::Document
  field :name, type: String
  has_and_belongs_to_many :managers
end
class Manager
  include Mongoid::Document
  has_and_belongs_to_many :bands
end

El siguiente código demuestra cómo Mongoid puede cargar los objetos Manager asociados si incluye el campo manager_ids:

# Returns null
Band.where(name: 'Astral Projection').only(:name).first.managers
# Returns the first Manager object
Band.where(name: 'Astral Projection').only(:name, :manager_ids).first.managers

Excluir campos

Puedes excluir explícitamente campos de los resultados utilizando el método without.

El siguiente código excluye el campo year de los objetos Band devueltos:

Band.where(members: 4).without(:year)

Limitar el número de resultados

Puede utilizar el método limit para limitar el número de resultados que Mongoid devuelve.

El siguiente código recupera un máximo de 5 documentos:

Band.limit(5)

Band.take(5)

Omitir resultados

Puedes omitir una cantidad específica de resultados utilizando el método skip, o su alias offset.

Si encadena una llamada limit a skip, el límite se aplica después de omitir los documentos, como se muestra en el siguiente ejemplo:

Band.skip(2).limit(5)
# Skips the first two results and returns
# the following five results

El siguiente código omite los primeros 3 documentos al devolver los resultados:

Band.skip(3)
# Equivalent
Band.offset(3)

Generar lotes de resultados

Cuando se ejecutan grandes queries y se itera sobre los resultados de una query usando un método enumerador como Criteria#each, Mongoid utiliza automáticamente el comando MongoDB getMore para cargar los resultados en lotes. El tamaño de agrupar predeterminado es 1000, pero puedes establecer un valor diferente usando el método batch_size.

El siguiente código establece el tamaño del lote en 500:

Band.batch_size(500)

incluye Método

El método includes carga las asociaciones mediante consultas separadas para cada una. El siguiente código carga las bandas y sus álbumes y sellos asociados mediante consultas separadas:

Band.where(name: 'The Beatles').includes({ albums: :songs }, :labels).first

Cuando se utiliza el método includes, Mongoid ejecuta una consulta en la clase base para obtener todos los documentos base y, a continuación, una consulta separada para cada asociación que carga de forma anticipada.

El ejemplo anterior ejecuta las siguientes consultas:

• Una consulta para encontrar los documentos Band

• Una consulta para cargar los documentos Album asociados

• Una consulta para cargar los documentos Label asociados

• Una consulta para cargar los documentos Song asociados

Método eager_load

El método eager_load utiliza la canalización de agregación de MongoDB con operadores $lookup para cargar todas las asociaciones en una sola consulta. El siguiente código utiliza una única consulta de canalización de agregación para cargar bandas y sus álbumes y sellos asociados, con etapas $lookup para cada asociación:

Band.where(name: 'The Beatles').eager_load({ albums: :songs }, :labels).first

Consideraciones sobre el rendimiento

Los métodos includes y eager_load realizan una carga anticipada, pero de maneras diferentes. El método includes ejecuta una consulta para los documentos base y luego consultas separadas para cada asociación. El método eager_load utiliza una única canalización de agregación con $lookup etapas para cargar las asociaciones.

El método eager_load ejecuta menos consultas y utiliza menos memoria que el método includes. Sin embargo, la eficiencia del método difiere según el tipo de asociaciones en sus documentos:

• eager_load es más rápido para has_many, has_and_belongs_to_many y para cargar múltiples asociaciones en la mayoría de los conjuntos de datos.

• includes es más rápido para belongs_to, has_one y asociaciones anidadas en la mayoría de los conjuntos de datos

Elija el método que mejor se adapte a su caso de uso y tipos de asociación.