MongoWriteBatch::__construct

(PECL mongo >= 1.5.0)
Creates a new batch of write operations
protected MongoWriteBatch::__construct ( MongoCollection $collection [, string $batch_type [, array $write_options ]] )

Constructs a new MongoWriteBatch.

Note:

This is a protected constructor. Please use one of the classes inheriting MongoWriteBatch.

Parameters:
collection

The MongoCollection to execute the batch on. Its write concern will be copied and used as the default write concern if none is given as $write_options or during MongoWriteBatch::execute().

batch_type

One of:

  • 0 - make an MongoWriteBatch::COMMAND_INSERT batch
  • 1 - make an MongoWriteBatch::COMMAND_UPDATE batch
  • 2 - make a MongoWriteBatch::COMMAND_DELETE batch
write_options

An array of Write Options.

key value meaning
w (int|string) Write concern value
wtimeout (int) Maximum time to wait for replication
ordered Determins if MongoDB must apply this batch in order (sequentally, one item at a time) or can rearrange it. Defaults to TRUE
j (bool) Wait for journaling on the primary. This value is discouraged, use WriteConcern instead
fsync (bool) Wait for fsync on the primary. This value is discouraged, use WriteConcern instead
Returns:

A new MongoWriteBatch of type batch_type.

See also:

MongoInsertBatch -

MongoUpdateBatch -

MongoDeleteBatch -

doc_php
2016-02-24 16:20:55
Comments
Leave a Comment

Please login to continue.