Class: Mongo::Operation::Write::CreateIndex

Inherits:
Object
  • Object
show all
Includes:
Specifiable, GLE, WriteCommandEnabled
Defined in:
lib/mongo/operation/write/create_index.rb

Overview

Note:

If a server with version >= 2.5.5 is being used, a write command operation will be created and sent instead.

A MongoDB create index operation.

Initialization:

param [ Hash ] spec The specifications for the insert.

option spec :index [ Hash ] The index spec to create.
option spec :db_name [ String ] The name of the database.
option spec :coll_name [ String ] The name of the collection.
option spec :index_name [ String ] The name of the index.
option spec :options [ Hash ] Options for the command, if it ends up being a
  write command.

Examples:

Create the create index operation.

Write::CreateIndex.new({
  :index => { :name => 1, :age => -1 },
  :db_name => 'test',
  :coll_name => 'test_coll',
  :index_name => 'name_1_age_-1'
})

Since:

  • 2.0.0

Constant Summary

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 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, #selector, #to_return, #update, #updates, #user, #user_name, #write_concern

Methods included from WriteCommandEnabled

#execute