Class: Mongo::Protocol::Query::Upconverter

Inherits:
Object
  • Object
show all
Defined in:
lib/mongo/protocol/query.rb

Overview

Converts legacy query messages to the appropriate OP_COMMAND style message.

Since:

  • 2.1.0

Constant Summary collapse

OPTION_MAPPINGS =

Mappings of the options to the find command options.

Since:

  • 2.1.0

{
  project: 'projection',
  skip: 'skip',
  limit: 'limit',
  batch_size: 'batchSize'
}.freeze
SPECIAL_FIELD_MAPPINGS =

Since:

  • 2.1.0

{
  :$readPreference => '$readPreference',
  :$orderby => 'sort',
  :$hint => 'hint',
  :$comment => 'comment',
  :$returnKey => 'returnKey',
  :$snapshot => 'snapshot',
  :$maxScan => 'maxScan',
  :$max => 'max',
  :$min => 'min',
  :$maxTimeMS => 'maxTimeMS',
  :$showDiskLoc => 'showRecordId',
  :$explain => 'explain'
}.freeze
FLAG_MAPPINGS =

Mapping of flags to find command options.

Since:

  • 2.1.0

{
  tailable_cursor: 'tailable',
  oplog_replay: 'oplogReplay',
  no_cursor_timeout: 'noCursorTimeout',
  await_data: 'awaitData',
  partial: 'allowPartialResults'
}.freeze

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(collection, filter, options, flags) ⇒ Upconverter

Instantiate the upconverter.

Examples:

Instantiate the upconverter.

Upconverter.new('users', { name: 'test' }, { skip: 10 })

Parameters:

  • collection (String) —

    The name of the collection.

  • filter (BSON::Document, Hash) —

    The filter or command.

  • options (BSON::Document, Hash) —

    The options.

  • flags (Array<Symbol>) —

    The flags.

Raises:

  • (ArgumentError)

Since:

  • 2.1.0



279
280
281
282
283
284
285
286
287
288
289
290
 
# File 'lib/mongo/protocol/query.rb', line 279

def initialize(collection, filter, options, flags)
  # Although the docstring claims both hashes and BSON::Documents
  # are acceptable, this class expects the filter and options to
  # contain symbol keys which isn't what the operation layer produces.
  raise ArgumentError, 'Filter must provide indifferent access' unless filter.is_a?(BSON::Document)
  raise ArgumentError, 'Options must provide indifferent access' unless options.is_a?(BSON::Document)

  @collection = collection
  @filter = filter
  @options = options
  @flags = flags
end

Instance Attribute Details

#collection ⇒ String (readonly)

Returns collection The name of the collection.

Returns:

  • (String) —

    collection The name of the collection.

Since:

  • 2.1.0



257
258
259
 
# File 'lib/mongo/protocol/query.rb', line 257

def collection
  @collection
end

#filter ⇒ BSON::Document, Hash (readonly)

Returns filter The query filter or command.

Returns:

  • (BSON::Document, Hash) —

    filter The query filter or command.

Since:

  • 2.1.0



260
261
262
 
# File 'lib/mongo/protocol/query.rb', line 260

def filter
  @filter
end

#flags ⇒ Array<Symbol> (readonly)

Returns flags The flags.

Returns:

  • (Array<Symbol>) —

    flags The flags.

Since:

  • 2.1.0



266
267
268
 
# File 'lib/mongo/protocol/query.rb', line 266

def flags
  @flags
end

#options ⇒ BSON::Document, Hash (readonly)

Returns options The options.

Returns:

  • (BSON::Document, Hash) —

    options The options.

Since:

  • 2.1.0



263
264
265
 
# File 'lib/mongo/protocol/query.rb', line 263

def options
  @options
end

Instance Method Details

#command ⇒ BSON::Document

Get the upconverted command.

Examples:

Get the command.

upconverter.command

Returns:

  • (BSON::Document) —

    The upconverted command.

Since:

  • 2.1.0



300
301
302
 
# File 'lib/mongo/protocol/query.rb', line 300

def command
  command? ? op_command : find_command
end

#command_name ⇒ String

Get the name of the command. If the collection is $cmd then it’s the first key in the filter, otherwise it’s a find.

Examples:

Get the command name.

upconverter.command_name

Returns:

  • (String) —

    The command name.

Since:

  • 2.1.0



313
314
315
 
# File 'lib/mongo/protocol/query.rb', line 313

def command_name
  ((filter[:$query] || !command?) ? :find : filter.keys.first).to_s
end