Home/ Manual/ driver / writeconcern/ MongoDB\Driver\WriteConcern::isDefault

MongoDB\Driver\WriteConcern::isDefault

PHP function Edit on GitHub ✎

(mongodb >=1.3.0)

Checks if this is the default write concern

Description

MongoDB\Driver\WriteConcern::isDefault(): bool

Returns whether this is the default write concern (i.e. no options are specified). This method is primarily intended to be used in conjunction with MongoDB\Driver\Manager::getWriteConcern to determine whether the Manager has been constructed without any write concern options.

The driver will not include a default write concern in its write operations (e.g. MongoDB\Driver\Manager::executeBulkWrite) in order to allow the server to apply its own default, which may have been modified. Libraries that access the Manager's write concern to include it in their own write commands should use this method to ensure that default write concerns are left unset.

Parameters Parameters

Return Values

Returns true if this is the default write concern and false otherwise.

Errors/Exceptions

Examples

MongoDB\Driver\WriteConcern::isDefault() example

php

<?php

$wc = new MongoDB\Driver\WriteConcern(1);
var_dump($wc->isDefault());

$manager = new MongoDB\Driver\Manager('mongodb://127.0.0.1/?w=majority');
$wc = $manager->getWriteConcern();
var_dump($wc->isDefault());

$manager = new MongoDB\Driver\Manager('mongodb://127.0.0.1/');
$wc = $manager->getWriteConcern();
var_dump($wc->isDefault());

?>

The above example will output:

output

bool(false)
bool(false)
bool(true)