Class: Mongo::Cursor::Builder::KillCursorsCommand

Inherits:
Object
  • Object
show all
Extended by:
Forwardable
Defined in:
lib/mongo/cursor/builder/kill_cursors_command.rb

Overview

Generates a specification for a kill cursors command.

Since:

  • 2.2.0

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(cursor) ⇒ KillCursorsCommand

Create the new builder.

Examples:

Create the builder.

KillCursorsCommand.new(cursor)

Parameters:

  • cursor (Cursor) —

    The cursor.

Since:

  • 2.2.0



38
39
40
 
# File 'lib/mongo/cursor/builder/kill_cursors_command.rb', line 38

def initialize(cursor)
  @cursor = cursor
end

Instance Attribute Details

#cursor ⇒ Cursor (readonly)

Returns cursor The cursor.

Returns:

  • (Cursor) —

    cursor The cursor.

Since:

  • 2.2.0



26
27
28
 
# File 'lib/mongo/cursor/builder/kill_cursors_command.rb', line 26

def cursor
  @cursor
end

Instance Method Details

#specification ⇒ Hash

Get the specification.

Examples:

Get the specification.

kill_cursors_command.specification

Returns:

  • (Hash) —

    The spec.

Since:

  • 2.2.0



50
51
52
 
# File 'lib/mongo/cursor/builder/kill_cursors_command.rb', line 50

def specification
  { selector: kill_cursors_command, db_name: database.name }
end