Module: Mongoid::Contextual::Command

Extended by:
Gem::Deprecate
Included in:
GeoNear, MapReduce
Defined in:
lib/mongoid/contextual/command.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#collectionObject (readonly)

Returns the value of attribute collection.



9
10
11
# File 'lib/mongoid/contextual/command.rb', line 9

def collection
  @collection
end

#collection The collection to query against.(Thecollectiontoqueryagainst.) ⇒ Object (readonly)



9
# File 'lib/mongoid/contextual/command.rb', line 9

attr_reader :collection, :criteria

#criteriaObject (readonly)

Returns the value of attribute criteria.



9
10
11
# File 'lib/mongoid/contextual/command.rb', line 9

def criteria
  @criteria
end

#criteria The criteria for the context.(Thecriteria) ⇒ Object (readonly)



9
# File 'lib/mongoid/contextual/command.rb', line 9

attr_reader :collection, :criteria

Instance Method Details

#clientMongo::Client Also known as: session

Get the database client.

Examples:

Get the client.

command.client

Returns:

  • (Mongo::Client)

    The Mongo client.

Since:

  • 3.0.0



31
32
33
# File 'lib/mongoid/contextual/command.rb', line 31

def client
  collection.database.client
end

#commandHash

The database command that is being built to send to the db.

Examples:

Get the command.

command.command

Returns:

  • (Hash)

    The db command.

Since:

  • 3.0.0



19
20
21
# File 'lib/mongoid/contextual/command.rb', line 19

def command
  @command ||= {}
end