Class: Mongo::Operation::Write::Bulk::Delete

Inherits:
Object
  • Object
show all
Includes:
Specifiable, Bulkable
Defined in:
lib/mongo/operation/write/bulk/delete.rb,
lib/mongo/operation/write/bulk/delete/result.rb

Overview

Note:

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

A MongoDB bulk delete operation.

Initialization:

param [ Hash ] spec The specifications for the delete.

option spec :deletes [ Array ] The delete documents.
option spec :db_name [ String ] The name of the database on which
  the delete should be executed.
option spec :coll_name [ String ] The name of the collection on which
  the delete should be executed.
option spec :write_concern [ Mongo::WriteConcern ] The write concern
  for this operation.
option spec :ordered [ true, false ] Whether the operations should be
  executed in order.
option spec :options [Hash] Options for the command, if it ends up being a
  write command.

Examples:

Create the delete operation.

Write::Bulk::Delete.new({
  :deletes => [{ :q => { :foo => 1 }, :limit => 1 }],
  :db_name => 'test',
  :coll_name => 'test_coll',
  :write_concern => write_concern
})

Since:

  • 2.0.0

Defined Under Namespace

Modules: Aggregatable Classes: LegacyResult, Result

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 Bulkable

#execute