Module: Mongoid::Criteria::Queryable::Optional

Extended by:
Macroable
Included in:
Mongoid::Criteria::Queryable
Defined in:
lib/mongoid/criteria/queryable/optional.rb

Overview

The optional module includes all behavior that has to do with extra options surrounding queries, like skip, limit, sorting, etc.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Macroable

key

Instance Attribute Details

#options ⇒ Object

Returns the value of attribute options.



12
13
14
 
# File 'lib/mongoid/criteria/queryable/optional.rb', line 12

def options
  @options
end

#options The query options.(Thequeryoptions.) ⇒ Object 



12
 
# File 'lib/mongoid/criteria/queryable/optional.rb', line 12

attr_accessor :options

Class Method Details

.forwardables ⇒ Array<Symbol>

Get the methods on the optional that can be forwarded to from a model.

Examples:

Get the forwardable methods.

Optional.forwardables

Returns:

  • (Array<Symbol>) —

    The names of the forwardable methods.



373
374
375
 
# File 'lib/mongoid/criteria/queryable/optional.rb', line 373

def forwardables
  public_instance_methods(false) - %i[options options=]
end

Instance Method Details

#ascending(*fields) ⇒ Optional Also known as: asc

Add ascending sorting options for all the provided fields.

Examples:

Add ascending sorting.

optional.ascending(:first_name, :last_name)

Parameters:

  • *fields (Symbol...) —

    The field(s) to sort.

Returns:



22
23
24
 
# File 'lib/mongoid/criteria/queryable/optional.rb', line 22

def ascending(*fields)
  sort_with_list(*fields, 1)
end

#batch_size(value = nil) ⇒ Optional

Adds the option for telling MongoDB how many documents to retrieve in it's batching.

Examples:

Apply the batch size options.

optional.batch_size(500)

Parameters:

  • value (Integer) (defaults to: nil) —

    The batch size.

Returns:



38
39
40
 
# File 'lib/mongoid/criteria/queryable/optional.rb', line 38

def batch_size(value = nil)
  option(value) { |options| options.store(:batch_size, value) }
end

#collation(collation_doc) ⇒ Optional

Set the collation.

Examples:

Set the collation.

optional.collation(locale: 'fr', strength: 2)

Parameters:

  • collation_doc (Hash) —

    The document describing the collation to use.

Returns:



305
306
307
 
# File 'lib/mongoid/criteria/queryable/optional.rb', line 305

def collation(collation_doc)
  clone.tap { |query| query.options.store(:collation, collation_doc) }
end

#comment(comment = nil) ⇒ Optional

Note:

Set profilingLevel to 2 and the comment will be logged in the profile collection along with the query.

Associate a comment with the query.

Examples:

Add a comment.

optional.comment('slow query')

Parameters:

  • comment (String) (defaults to: nil) —

    The comment to be associated with the query.

Returns:



276
277
278
279
280
 
# File 'lib/mongoid/criteria/queryable/optional.rb', line 276

def comment(comment = nil)
  clone.tap do |query|
    query.options.store(:comment, comment)
  end
end

#cursor_type(type) ⇒ Optional

Note:

The cursor can be type :tailable or :tailable_await.

Set the cursor type.

Examples:

Set the cursor type.

optional.cursor_type(:tailable)
optional.cursor_type(:tailable_await)

Parameters:

  • type (Symbol) —

    The type of cursor to create.

Returns:



293
294
295
 
# File 'lib/mongoid/criteria/queryable/optional.rb', line 293

def cursor_type(type)
  clone.tap { |query| query.options.store(:cursor_type, type) }
end

#descending(*fields) ⇒ Optional Also known as: desc

Add descending sorting options for all the provided fields.

Examples:

Add descending sorting.

optional.descending(:first_name, :last_name)

Parameters:

  • *fields (Symbol...) —

    The field(s) to sort.

Returns:



50
51
52
 
# File 'lib/mongoid/criteria/queryable/optional.rb', line 50

def descending(*fields)
  sort_with_list(*fields, -1)
end

#hint(value = nil) ⇒ Optional

Add an index hint to the query options.

Examples:

Add an index hint.

optional.hint("$natural" => 1)

Parameters:

  • value (Hash) (defaults to: nil) —

    The index hint.

Returns:



65
66
67
 
# File 'lib/mongoid/criteria/queryable/optional.rb', line 65

def hint(value = nil)
  option(value) { |options| options.store(:hint, value) }
end

#limit(value = nil) ⇒ Optional

Add the number of documents to limit in the returned results.

Examples:

Limit the number of returned documents.

optional.limit(20)

Parameters:

  • value (Integer) (defaults to: nil) —

    The number of documents to return.

Returns:



77
78
79
80
81
82
83
 
# File 'lib/mongoid/criteria/queryable/optional.rb', line 77

def limit(value = nil)
  option(value) do |options, query|
    val = value.to_i
    options.store(:limit, val)
    query.pipeline.push('$limit' => val) if aggregating?
  end
end

#max_scan(value = nil) ⇒ Optional

Deprecated.

The max_scan option is deprecated in MongoDB 4.0 and later. Use max_time_ms instead.

Adds the option to limit the number of documents scanned in the collection.

Examples:

Add the max scan limit.

optional.max_scan(1000)

Parameters:

  • value (Integer) (defaults to: nil) —

    The max number of documents to scan.

Returns:



97
98
99
 
# File 'lib/mongoid/criteria/queryable/optional.rb', line 97

def max_scan(value = nil)
  option(value) { |options| options.store(:max_scan, value) }
end

#max_time_ms(value = nil) ⇒ Optional

Adds a cumulative time limit in milliseconds for processing operations on a cursor.

Examples:

Add the max time ms option.

optional.max_time_ms(200)

Parameters:

  • value (Integer) (defaults to: nil) —

    The max time in milliseconds for processing operations on a cursor.

Returns:



110
111
112
 
# File 'lib/mongoid/criteria/queryable/optional.rb', line 110

def max_time_ms(value = nil)
  option(value) { |options| options.store(:max_time_ms, value) }
end

#no_timeout ⇒ Optional

Tell the query not to timeout.

Examples:

Tell the query not to timeout.

optional.no_timeout

Returns:



120
121
122
 
# File 'lib/mongoid/criteria/queryable/optional.rb', line 120

def no_timeout
  clone.tap { |query| query.options.store(:timeout, false) }
end

#only(*args) ⇒ Optional

Limits the results to only contain the fields provided.

Examples:

Limit the results to the provided fields.

optional.only(:name, :dob)

Parameters:

  • *args (Symbol...) —

    The field(s) to return.

Returns:



132
133
134
135
136
137
138
139
140
141
 
# File 'lib/mongoid/criteria/queryable/optional.rb', line 132

def only(*args)
  args = args.flatten
  option(*args) do |options|
    options.store(
      :fields,
      args.inject(options[:fields] || {}) { |sub, field| sub.tap { sub[field] = 1 } },
      false
    )
  end
end

#order_by(*spec) ⇒ Optional Also known as: order

Adds sorting criterion to the options.

Examples:

Add sorting options via a hash with integer directions.

optional.order_by(name: 1, dob: -1)

Add sorting options via a hash with symbol directions.

optional.order_by(name: :asc, dob: :desc)

Add sorting options via a hash with string directions.

optional.order_by(name: "asc", dob: "desc")

Add sorting options via an array with integer directions.

optional.order_by([[ name, 1 ], [ dob, -1 ]])

Add sorting options via an array with symbol directions.

optional.order_by([[ :name, :asc ], [ :dob, :desc ]])

Add sorting options via an array with string directions.

optional.order_by([[ "name", "asc" ], [ "dob", "desc" ]])

Add sorting options with keys.

optional.order_by(:name.asc, :dob.desc)

Add sorting options via a string.

optional.order_by("name ASC, dob DESC")

Parameters:

  • *spec ([ Array | Hash | String ]...) —

    The sorting specification.

Returns:



172
173
174
175
176
177
178
179
180
181
 
# File 'lib/mongoid/criteria/queryable/optional.rb', line 172

def order_by(*spec)
  option(spec) do |options, query|
    spec.compact.each do |criterion|
      criterion.__sort_option__.each_pair do |field, direction|
        add_sort_option(options, field, direction)
      end
      query.pipeline.push('$sort' => options[:sort]) if aggregating?
    end
  end
end

#reorder(*spec) ⇒ Optional

Instead of merging the order criteria, use this method to completely replace the existing ordering with the provided.

Examples:

Replace the ordering.

optional.reorder(name: :asc)

Parameters:

  • *spec ([ Array | Hash | String ]...) —

    The sorting specification.

Returns:



193
194
195
196
197
 
# File 'lib/mongoid/criteria/queryable/optional.rb', line 193

def reorder(*spec)
  clone.tap do |query|
    query.options.delete(:sort)
  end.order_by(*spec)
end

#skip(value = nil) ⇒ Optional Also known as: offset

Add the number of documents to skip.

Examples:

Add the number to skip.

optional.skip(100)

Parameters:

  • value (Integer) (defaults to: nil) —

    The number to skip.

Returns:



207
208
209
210
211
212
213
 
# File 'lib/mongoid/criteria/queryable/optional.rb', line 207

def skip(value = nil)
  option(value) do |options, query|
    val = value.to_i
    options.store(:skip, val)
    query.pipeline.push('$skip' => val) if aggregating?
  end
end

#slice(criterion = nil) ⇒ Optional

Limit the returned results via slicing embedded arrays.

Examples:

Slice the returned results.

optional.slice(aliases: [ 0, 5 ])

Parameters:

  • criterion (Hash) (defaults to: nil) —

    The slice options.

Returns:



224
225
226
227
228
229
230
231
232
 
# File 'lib/mongoid/criteria/queryable/optional.rb', line 224

def slice(criterion = nil)
  option(criterion) do |options|
    options.__union__(
      fields: criterion.inject({}) do |option, (field, val)|
        option.tap { |opt| opt.store(field, { '$slice' => val }) }
      end
    )
  end
end

#snapshot ⇒ Optional

Tell the query to operate in snapshot mode.

Examples:

Add the snapshot option.

optional.snapshot

Returns:



240
241
242
243
244
 
# File 'lib/mongoid/criteria/queryable/optional.rb', line 240

def snapshot
  clone.tap do |query|
    query.options.store(:snapshot, true)
  end
end

#without(*args) ⇒ Optional

Limits the results to only contain the fields not provided.

Examples:

Limit the results to the fields not provided.

optional.without(:name, :dob)

Parameters:

  • *args (Symbol...) —

    The field(s) to ignore.

Returns:



254
255
256
257
258
259
260
261
262
263
 
# File 'lib/mongoid/criteria/queryable/optional.rb', line 254

def without(*args)
  args = args.flatten
  option(*args) do |options|
    options.store(
      :fields,
      args.inject(options[:fields] || {}) { |sub, field| sub.tap { sub[field] = 0 } },
      false
    )
  end
end