MongoDBClient__construct.txt 1.89 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
==============================
MongoDB\\Client::__construct()
==============================

.. default-domain:: mongodb

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

Definition
----------

16
.. phpmethod:: MongoDB\\Client::__construct()
17 18 19 20 21

   Constructs a new :phpclass:`Client <MongoDB\\Client>` instance.

   .. code-block:: php

22
      function __construct($uri = 'mongodb://127.0.0.1/', array $uriOptions = [], array $driverOptions = [])
23

24
   This constructor has the following parameters:
25 26 27

   .. include:: /includes/apiargs/MongoDBClient-method-construct-param.rst

28 29 30 31
   The ``$driverOptions`` parameter supports the following options:

   .. include:: /includes/apiargs/MongoDBClient-method-construct-driverOptions.rst

32 33 34
Examples
--------

35 36 37
If you do not specify a ``$uri`` value, the driver connects to a standalone
:program:`mongod` on ``127.0.0.1`` via port ``27017``. The following example
demonstrates how to connect to a replica set with a custom read preference:
38 39 40 41 42 43 44 45

.. code-block:: php

   <?php

   $client = new MongoDB\Client(
       'mongodb://rs1.example.com,rs2.example.com/?replicaSet=myReplicaSet',
       [
46
           'readPreference' => 'secondaryPreferred',
47 48 49 50
       ]
   );

By default, the |php-library| deserializes BSON documents and arrays
51 52 53 54
as :phpclass:`MongoDB\\Model\\BSONDocument` and
:phpclass:`MongoDB\\Model\\BSONArray` objects, respectively. The following
example demonstrates how to have the library unserialize everything as a PHP
array, as was done in the legacy :php:`mongo extension <mongo>`.
55 56 57 58 59 60 61 62

.. code-block:: php

   <?php

   $client = new MongoDB\Client(
       null,
       [],
63 64 65 66 67 68
       [
           'typeMap' => [
               'root' => 'array',
               'document' => 'array',
               'array' => 'array',
           ],
69 70
       ]
   );
71 72 73 74 75

.. seealso::

   - :php:`MongoDB\\Driver\\Manager::__construct()
     <mongodb-driver-manager.construct>`