Class: Mongo::Operation::Read::Query

Inherits:
Object
  • Object
show all
Includes:
Executable, Mongo::Operation::ReadPreference, Specifiable
Defined in:
lib/mongo/operation/read/query.rb,
lib/mongo/operation/read/query/result.rb

Overview

A MongoDB query operation.

Initialization:

param [ Hash ] spec The specifications for the query.

option spec :selector [ Hash ] The query selector.
option spec :db_name [ String ] The name of the database on which
  the query should be run.
option spec :coll_name [ String ] The name of the collection on which
  the query should be run.
option spec :options [ Hash ] Options for the query.

Examples:

Create the query operation.

Read::Query.new({
  :selector => { :foo => 1 },
  :db_name => 'test-db',
  :coll_name => 'test-coll',
  :options => { :limit => 2 }
})

Since:

  • 2.0.0

Defined Under Namespace

Classes: Result

Constant Summary

Constants included from Mongo::Operation::ReadPreference

Mongo::Operation::ReadPreference::SLAVE_OK

Constants included from Specifiable

Specifiable::BYPASS_DOC_VALIDATION, Specifiable::COLL_NAME, Specifiable::CURSOR_COUNT, Specifiable::CURSOR_ID, Specifiable::CURSOR_IDS, Specifiable::DB_NAME, Specifiable::DELETE, Specifiable::DELETES, Specifiable::DOCUMENTS, Specifiable::INDEX, Specifiable::INDEXES, Specifiable::INDEX_NAME, Specifiable::OPERATION_ID, Specifiable::OPTIONS, Specifiable::READ, Specifiable::READ_CONCERN, Specifiable::SELECTOR, Specifiable::TO_RETURN, Specifiable::UPDATE, Specifiable::UPDATES, Specifiable::USER, Specifiable::USER_NAME, Specifiable::WRITE_CONCERN

Instance Attribute Summary

Attributes included from Specifiable

#spec

Method Summary

Methods included from Executable

#execute

Methods included from Specifiable

#==, #bypass_document_validation, #coll_name, #cursor_count, #cursor_id, #cursor_ids, #db_name, #delete, #deletes, #documents, #index, #index_name, #indexes, #initialize, #namespace, #operation_id, #options, #ordered?, #read, #read_concern, #selector, #to_return, #update, #updates, #user, #user_name, #write_concern