MongoDBGridFSBucket-getReadConcern.txt 1.33 KB
Newer Older
1 2 3
=========================================
MongoDB\\GridFS\\Bucket::getReadConcern()
=========================================
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::getReadConcern()
19

20
   Returns the read concern for this GridFS bucket.
21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37

   .. code-block:: php

      function getReadConcern(): MongoDB\Driver\ReadConcern

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

A :php:`MongoDB\\Driver\\ReadConcern <class.mongodb-driver-readconcern>` object.

Example
-------

.. code-block:: php

   <?php

38 39 40 41 42 43 44 45
   $database = (new MongoDB\Client)->selectDatabase('test');
   $bucket = $database->selectGridFSBucket([
      'readConcern' => new MongoDB\Driver\ReadConcern(MongoDB\Driver\ReadConcern::MAJORITY),
   ]);

   var_dump($bucket->getReadConcern());

The output would then resemble::
46

47 48 49 50
   object(MongoDB\Driver\ReadConcern)#3 (1) {
     ["level"]=>
     string(8) "majority"
   }
51 52 53 54

See Also
--------

55 56
- :manual:`Read Concern </reference/read-concern>` in the MongoDB manual
- :php:`MongoDB\\Driver\\ReadConcern::isDefault() <mongodb-driver-readconcern.isdefault>`
57 58 59
- :phpmethod:`MongoDB\\Client::getReadConcern()`
- :phpmethod:`MongoDB\\Collection::getReadConcern()`
- :phpmethod:`MongoDB\\Database::getReadConcern()`