MongoDB\Driver
PHP Manual

The MongoDB\Driver\WriteConcern class

Introduction

MongoDB\Driver\WriteConcern describes the level of acknowledgement requested from MongoDB for write operations to a standalone mongod or to replica sets or to sharded clusters. In sharded clusters, mongos instances will pass the write concern on to the shards.

Class synopsis

MongoDB\Driver\WriteConcern
final class MongoDB\Driver\WriteConcern implements MongoDB\BSON\Serializable, Serializable {
/* Constants */
const string MongoDB\Driver\WriteConcern::MAJORITY = "majority";
/* Properties */
public readonly stringintnull $w;
public readonly boolnull $j;
public readonly int $wtimeout;
/* Methods */
final public stdClass bsonSerialize()
final public __construct(stringint $w, intnull $wtimeout = null, boolnull $journal = null)
final public boolnull getJournal()
final public stringintnull getW()
final public int getWtimeout()
final public bool isDefault()
}

Properties

w
The write concern value (integer number of nodes, the string "majority", or a custom write concern tag name), or null if not set.
j
Whether write operations must be committed to the journal before acknowledged, or null if not specified.
wtimeout
The timeout in milliseconds to wait for write concern acknowledgement. A value of 0 means to wait indefinitely.

Predefined Constants

MongoDB\Driver\WriteConcern::MAJORITY
Majority of all the members in the set; arbiters, non-voting members, passive members, hidden members and delayed members are all included in the definition of majority write concern.

Changelog

Version Description
PECL mongodb 2.3.0 Added public readonly properties.
PECL mongodb 1.7.0 Implements Serializable.
PECL mongodb 1.2.0 Implements MongoDB\BSON\Serializable.
Table of Contents