Class: Mongo::Protocol::GetMore::Upconverter

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

Overview

Converts legacy getMore messages to the appropriare OP_COMMAND style message.

Since:

  • 2.1.0

Constant Summary collapse

GET_MORE =
Deprecated.

The get more constant.

Since:

  • 2.2.0

'getMore'.freeze

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(collection, cursor_id, number_to_return) ⇒ Upconverter

Instantiate the upconverter.

Examples:

Instantiate the upconverter.

Upconverter.new('users', 1, 1)

Parameters:

  • collection (String) —

    The name of the collection.

  • cursor_id (Integer) —

    The cursor id.

  • number_to_return (Integer) —

    The number of documents to return.

Since:

  • 2.1.0



139
140
141
142
143
 
# File 'lib/mongo/protocol/get_more.rb', line 139

def initialize(collection, cursor_id, number_to_return)
  @collection = collection
  @cursor_id = cursor_id
  @number_to_return = number_to_return
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



120
121
122
 
# File 'lib/mongo/protocol/get_more.rb', line 120

def collection
  @collection
end

#cursor_id ⇒ Integer (readonly)

Returns cursor_id The cursor id.

Returns:

  • (Integer) —

    cursor_id The cursor id.

Since:

  • 2.1.0



123
124
125
 
# File 'lib/mongo/protocol/get_more.rb', line 123

def cursor_id
  @cursor_id
end

#number_to_return ⇒ Integer (readonly)

Returns number_to_return The number of docs to return.

Returns:

  • (Integer) —

    number_to_return The number of docs to return.

Since:

  • 2.1.0



126
127
128
 
# File 'lib/mongo/protocol/get_more.rb', line 126

def number_to_return
  @number_to_return
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



153
154
155
156
157
158
159
 
# File 'lib/mongo/protocol/get_more.rb', line 153

def command
  document = BSON::Document.new
  document.store('getMore', BSON::Int64.new(cursor_id))
  document.store(Message::BATCH_SIZE, number_to_return)
  document.store(Message::COLLECTION, collection)
  document
end