MongoDBClient-getWriteConcern.txt 1.19 KB
Newer Older
1
==================================
2
MongoDB\\Client::getWriteConcern()
3
==================================
4

5 6
.. versionadded:: 1.2

7 8 9 10 11 12 13 14 15 16 17 18 19
.. default-domain:: mongodb

.. contents:: On this page
   :local:
   :backlinks: none
   :depth: 1
   :class: singlecol

Definition
----------

.. phpmethod:: MongoDB\\Client::getWriteConcern()

20
   Returns the write concern for this client.
21 22 23 24 25 26 27 28

   .. code-block:: php

      function getWriteConcern(): MongoDB\Driver\WriteConcern

Return Values
-------------

29 30
A :php:`MongoDB\\Driver\\WriteConcern <class.mongodb-driver-writeconcern>`
object.
31 32 33 34 35 36 37 38

Example
-------

.. code-block:: php

   <?php

39 40 41 42 43 44 45 46 47 48 49 50
   $client = new MongoDB\Client('mongodb://127.0.0.1/', [
       'journal' => true,
   ]);

   var_dump($client->getWriteConcern());

The output would then resemble::

   object(MongoDB\Driver\WriteConcern)#4 (1) {
     ["j"]=>
     bool(true)
   }
51 52 53 54

See Also
--------

55 56
- :manual:`Write Concern </reference/read-concern>` in the MongoDB manual
- :php:`MongoDB\\Driver\\WriteConcern::isDefault() <mongodb-driver-writeconcern.isdefault>`
57 58
- :phpmethod:`MongoDB\\Collection::getWriteConcern()`
- :phpmethod:`MongoDB\\Database::getWriteConcern()`
59
- :phpmethod:`MongoDB\\GridFS\\Bucket::getWriteConcern()`