1. class
  2. MongoDB
  3. \
  4. Driver
  5. \
  6. WriteConcern

WriteConcern

final class WriteConcern implements Serializable (View source)

WriteConcern controls the acknowledgment of a write operation, specifies the level of write guarantee for Replica Sets.

Constants

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.

Methods

__construct(string|int $w, int|null $wtimeout = null, bool|null $journal = null)

Construct immutable WriteConcern

static 
__set_state(array $properties)

No description

bool|null
getJournal()

Returns the WriteConcern's "journal" option

string|int|null
getW()

Returns the WriteConcern's "w" option

int
getWtimeout()

Returns the WriteConcern's "wtimeout" option

PackedArray
bsonSerialize()

Returns an object for BSON serialization

bool
isDefault()

No description

Details

at line 27
final __construct(string|int $w, int|null $wtimeout = null, bool|null $journal = null)

Construct immutable WriteConcern

Parameters

string|int $w
int|null $wtimeout

How long to wait (in milliseconds) for secondaries before failing.
bool|null $journal

Wait until mongod has applied the write to the journal.

Exceptions

InvalidArgumentException

at line 29
static __set_state(array $properties)

No description

Parameters

array $properties

at line 35
final bool|null getJournal()

Returns the WriteConcern's "journal" option

Return Value

bool|null

at line 41
final string|int|null getW()

Returns the WriteConcern's "w" option

Return Value

string|int|null

at line 47
final int getWtimeout()

Returns the WriteConcern's "wtimeout" option

Return Value

int

at line 56
final PackedArray bsonSerialize()

Since: 1.2.0

Returns an object for BSON serialization

Return Value

PackedArray

Exceptions

InvalidArgumentException

at line 58
final bool isDefault()

No description

Return Value

bool