Class: Mongo::Operation::Commands::ListIndexes

Inherits:
Command
  • Object
show all
Defined in:
lib/mongo/operation/commands/list_indexes.rb,
lib/mongo/operation/commands/list_indexes/result.rb

Overview

Note:

A command is actually a query on the virtual '$cmd' collection.

A MongoDB listIndexes command operation.

Initialization:

param [ Hash ] spec The specifications for the command.

option spec :coll_name [ Hash ] The name of the collection whose index
  info is requested.
option spec :db_name [ String ] The name of the database on which
  the command should be executed.
option spec :options [ Hash ] Options for the command.

Examples:

Create the listIndexes command operation.

Mongo::Operation::Read::ListIndexes.new({ db_name: 'test', coll_name: 'example' })

Since:

  • 2.0.0

Defined Under Namespace

Classes: Result

Constant Summary

Constants included from ReadPreference

ReadPreference::SLAVE_OK

Constants included from Specifiable

Specifiable::BYPASS_DOC_VALIDATION, Specifiable::COLLATION, 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::MAX_TIME_MS, 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 Limited

#options

Methods included from Specifiable

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