MongoDB\Driver\WriteConcern: : _ _construct
(mongodb >=1.0.0)
MongoDB\Driver\WriteConcern::__construct — Create a new WriteConcern
Description
$w
[, int $wtimeout
[, bool $journal
]] )Constructs a new MongoDB\Driver\WriteConcern, which is an immutable value object.
Parameters
-
w -
Write concern Value Description 1 Requests acknowledgement that the write operation has propagated to the standalone mongod or the primary in a replica set. This is the default write concern for MongoDB. 0 Requests no acknowledgment of the write operation. However, this may return information about socket exceptions and networking errors to the application. <integer greater than 1> Numbers greater than 1 are valid only for replica sets to request acknowledgement from specified number of members, including the primary. MongoDB\Driver\WriteConcern::MAJORITYRequests acknowledgment that write operations have propagated to the majority of voting nodes, including the primary, and have been written to the on-disk journal for these nodes.
Prior to MongoDB 3.0, this refers to the majority of replica set members (not just voting nodes).
string A string value is interpereted as a tag set. Requests acknowledgement that the write operations have propagated to a replica set member with the specified tag. -
wtimeout -
How long to wait (in milliseconds) for secondaries before failing.
wtimeout causes write operations to return with an error (WriteConcernError) after the specified limit, even if the required write concern will eventually succeed. When these write operations return, MongoDB does not undo successful data modifications performed before the write concern exceeded the wtimeout time limit.
If specified, wtimeout must be a signed 32-bit integer greater than or equal to zero.
Write concern timeout Value Description 0 Block indefinitely. This is the default. <integer greater than 0> Milliseconds to wait until returning. -
journal -
Wait until mongod has applied the write to the journal.
Errors/Exceptions
- Throws MongoDB\Driver\Exception\InvalidArgumentException on argument parsing errors.
- Throws MongoDB\Driver\Exception\InvalidArgumentException if
wis invalid orwtimeoutis either negative or greater than the bounds of a signed 32-bit integer.
Examples
Example #1 MongoDB\Driver\WriteConcern::__construct() example
<?php
/* Request write acknowledgement from the majority of the replica set nodes */
$wc = new MongoDB\Driver\WriteConcern(MongoDB\Driver\WriteConcern::MAJORITY, 500);
/* Request write acknowledgement from a node configured with the "MultipleDC" tag */
$wc = new MongoDB\Driver\WriteConcern("MultipleDC", 500);
?>
English translation
You have asked to visit this site in English. For now, only the interface is translated, but not all the content yet.If you want to help me in translations, your contribution is welcome. All you need to do is register on the site, and send me a message asking me to add you to the group of translators, which will give you the opportunity to translate the pages you want. A link at the bottom of each translated page indicates that you are the translator, and has a link to your profile.
Thank you in advance.
Document created the 30/01/2003, last modified the 26/10/2018
Source of the printed document:https://www.gaudry.be/en/php-rf-mongodb-driver-writeconcern.construct.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.
