Class: Mongoid::Criteria::Queryable::Options

Inherits:
Smash
  • Object
show all
Defined in:
lib/mongoid/criteria/queryable/options.rb

Overview

The options is a hash representation of options passed to MongoDB queries, such as skip, limit, and sorting criteria.

Instance Attribute Summary

Attributes inherited from Smash

#aliased_associations, #aliased_associations The aliased_associations., #aliases, #aliases The aliases., #associations, #associations The associations., #serializers, #serializers The serializers.

Instance Method Summary collapse

Methods inherited from Smash

#[], #initialize

Constructor Details

This class inherits a constructor from Mongoid::Criteria::Queryable::Smash

Instance Method Details

#__deep_copy__ ⇒ Options

Perform a deep copy of the options.

Examples:

Perform a deep copy.

options.__deep_copy__

Returns:

  • (Options) —

    The copied options.



99
100
101
102
103
104
105
 
# File 'lib/mongoid/criteria/queryable/options.rb', line 99

def __deep_copy__
  self.class.new(aliases, serializers, associations, aliased_associations) do |copy|
    each_pair do |key, value|
      copy.merge!(key => value.__deep_copy__)
    end
  end
end

#fields ⇒ Hash

Convenience method for getting the field options.

Examples:

Get the fields options.

options.fields

Returns:

  • (Hash) —

    The fields options.



15
16
17
 
# File 'lib/mongoid/criteria/queryable/options.rb', line 15

def fields
  self[:fields]
end

#limit ⇒ Integer

Convenience method for getting the limit option.

Examples:

Get the limit option.

options.limit

Returns:

  • (Integer) —

    The limit option.



25
26
27
 
# File 'lib/mongoid/criteria/queryable/options.rb', line 25

def limit
  self[:limit]
end

#skip ⇒ Integer

Convenience method for getting the skip option.

Examples:

Get the skip option.

options.skip

Returns:

  • (Integer) —

    The skip option.



35
36
37
 
# File 'lib/mongoid/criteria/queryable/options.rb', line 35

def skip
  self[:skip]
end

#sort ⇒ Hash

Convenience method for getting the sort options.

Examples:

Get the sort options.

options.sort

Returns:

  • (Hash) —

    The sort options.



45
46
47
 
# File 'lib/mongoid/criteria/queryable/options.rb', line 45

def sort
  self[:sort]
end

#store(key, value, localize = true) ⇒ Object Also known as: []=

Store the value in the options for the provided key. The options will handle all necessary serialization and localization in this step.

Examples:

Store a value in the options.

options.store(:key, "testing")

Parameters:

  • key (String | Symbol) —

    The name of the attribute.

  • value (Object) —

    The value to add.

Returns:

  • (Object) —

    The stored object.



59
60
61
 
# File 'lib/mongoid/criteria/queryable/options.rb', line 59

def store(key, value, localize = true)
  super(key, evolve(value, localize))
end

#to_pipeline ⇒ Array<Hash>

Convert the options to aggregation pipeline friendly options.

Examples:

Convert the options to a pipeline.

options.to_pipeline

Returns:

  • (Array<Hash>) —

    The options in pipeline form.



70
71
72
73
74
75
76
 
# File 'lib/mongoid/criteria/queryable/options.rb', line 70

def to_pipeline
  pipeline = []
  pipeline.push({ '$skip' => skip }) if skip
  pipeline.push({ '$limit' => limit }) if limit
  pipeline.push({ '$sort' => sort }) if sort
  pipeline
end

#to_pipeline_for_lookup ⇒ Array<Hash>

Convert the options to aggregation pipeline friendly options. This version places sort last to comply with $lookup requirements.

Examples:

Convert the options to a pipeline.

options.to_pipeline_for_lookup

Returns:

  • (Array<Hash>) —

    The options in pipeline form.



85
86
87
88
89
90
91
 
# File 'lib/mongoid/criteria/queryable/options.rb', line 85

def to_pipeline_for_lookup
  pipeline = []
  pipeline.push({ '$sort' => sort }) if sort
  pipeline.push({ '$skip' => skip }) if skip
  pipeline.push({ '$limit' => limit }) if limit
  pipeline
end