Class: Mongo::Operation::Commands::CollectionsInfo

Inherits:
Object
  • Object
show all
Includes:
Executable, ReadPreference, Specifiable
Defined in:
lib/mongo/operation/commands/collections_info.rb,
lib/mongo/operation/commands/collections_info/result.rb

Overview

A MongoDB operation to get a list of collection names in a database.

Initialization:

param [ Hash ] spec The specifications for the collection names operation.

option spec :db_name [ String ] The name of the database whose collection
  names is requested.
option spec :options [ Hash ] Options for the operation.

Examples:

Create the collection names operation.

Read::CollectionNames.new(:db_name => 'test-db')

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

Instance Method Summary collapse

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

Instance Method Details

#execute(server) ⇒ Result

Execute the operation.

Examples:

Execute the operation.

operation.execute(server)

Parameters:

  • server (Mongo::Server)

    The server to send this operation to.

Returns:

  • (Result)

    The operation response, if there is one.

Since:

  • 2.0.0



49
50
51
52
53
54
55
56
57
# File 'lib/mongo/operation/commands/collections_info.rb', line 49

def execute(server)
  if server.features.list_collections_enabled?
    ListCollections.new(spec).execute(server)
  else
    server.with_connection do |connection|
      Result.new(connection.dispatch([ message(server) ])).validate!
    end
  end
end