MongoDBClient-selectDatabase.txt 1.52 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71
=================================
MongoDB\\Client::selectDatabase()
=================================

.. default-domain:: mongodb

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

Definition
----------

.. phpmethod:: MongoDB\\Client::selectDatabase($databaseName, $options)

   Selects a database on the :program:`mongod` instance to which your
   application is connected.
   
   .. code-block:: php

      function selectDatabase($databaseName array $options = []): MongoDB\Database

   :phpmethod:`MongoDB\\Client::selectDatabase` has the following parameters:

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

   The following table describes the options that
   :phpmethod:`MongoDB\\Client::selectDatabase` can accept.

   .. include:: /includes/apiargs/MongoDBClient-method-selectDatabase-option.rst

Output
------

Returns a :phpclass:`MongoDB\\Database` object.

Example
-------

The following example selects the ``demo`` database:

.. code-block:: php

   <?php

   $client = new MongoDB\Client;

   $db = $client->selectDatabase('demo');

The following examples selects the ``demo`` database with a custom read
preference:

.. code-block:: php

   <?php

   $client = new MongoDB\Client;

   $db = $client->selectDatabase(
       'demo',
       [
           'readPreference' => new MongoDB\Driver\ReadPreference(MongoDB\Driver\ReadPreference::RP_SECONDARY),
       ]
   );

.. seealso::

   - :phpmethod:`Collection::__construct`
   - :phpmethod:`MongoDB\\Client::__get`