MongoDBGridFSBucket-getWriteConcern.txt 1.33 KB
Newer Older
1
=========================================
2
MongoDB\\GridFS\Bucket::getWriteConcern()
3
=========================================
4

5 6
.. versionadded:: 1.2

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

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

Definition
----------

18
.. phpmethod:: MongoDB\\GridFS\\Bucket::getWriteConcern()
19

20
   Returns the write concern for this GridFS bucket.
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
   $database = (new MongoDB\Client)->selectDatabase('test');
   $bucket = $database->selectGridFSBucket([
      'writeConcern' => new MongoDB\Driver\WriteConcern(1, 0, true),
   ]);

   var_dump($bucket->getWriteConcern());

The output would then resemble::
47

48 49 50 51 52 53
   object(MongoDB\Driver\WriteConcern)#3 (2) {
     ["w"]=>
     int(1)
     ["j"]=>
     bool(true)
   }
54 55 56 57

See Also
--------

58 59
- :manual:`Write Concern </reference/read-concern>` in the MongoDB manual
- :php:`MongoDB\\Driver\\WriteConcern::isDefault() <mongodb-driver-writeconcern.isdefault>`
60 61 62
- :phpmethod:`MongoDB\\Client::getWriteConcern()`
- :phpmethod:`MongoDB\\Collection::getWriteConcern()`
- :phpmethod:`MongoDB\\Database::getWriteConcern()`