MongoDBClient__get.txt 1.4 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
========================
MongoDB\\Client::__get()
========================

.. default-domain:: mongodb


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

Definition
----------

.. phpmethod:: MongoDB\\Client::__get($databaseName)

   Select a MongoDB database.

   .. code-block:: php

      function __get($databaseName): MongoDB\Database

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

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

Behavior
--------

The selected database inherits options such as read preference and
type mapping from the :phpclass:`Client <MongoDB\\Client>` object.
If you wish to override any options, use the 
:phpmethod:`MongoDB\\Client::selectDatabase` method.

.. note::
   
   To select databases whose names contain special characters, such as
   ``-``, use complex syntax, as in ``$client->{'that-database'}``.
   
   Alternatively, :phpmethod:`MongoDB\\Client::selectDatabase` supports
   selecting databases whose names contain special characters.

Examples
--------

The following example selects the ``demo`` and ``another-app``
databases:

.. code-block:: php

   <?php

   $client = new MongoDB\Client;

   $demo = $client->demo;
   $anotherApp = $client->{'another-app'};

.. seealso::

   - :phpmethod:`MongoDB\\Client::selectDatabase`
   - :php:`Property Overloading <oop5.overloading>` in the PHP Manual.