MongoDB\Client::__construct()

Definition

MongoDB\Client::__construct()

Constructs a new Client instance.

function __construct(
    ?string $uri = null,
    array $uriOptions = [],
    array $driverOptions = []
)

Parameters

$uri : string

The MongoDB connection string. Refer to Connection Strings in the MongoDB manual for more information.

Defaults to "mongodb://127.0.0.1:27017" if unspecified.

Any special characters in the URI components need to be encoded according to RFC 3986. This is particularly relevant to the username and password, which can often include special characters such as @, :, or %. When connecting via a Unix domain socket, the socket path may contain special characters such as slashes and must be encoded. The rawurlencode() function may be used to encode constituent parts of the URI.

$uriOptions : array

Specifies additional URI options, such as authentication credentials or query string parameters. The options specified in $uriOptions take precedence over any analogous options present in the $uri string and do not need to be encoded according to RFC 3986.

Refer to the MongoDB\Driver\Manager::__construct() extension documentation for a list of supported options.

$driverOptions : array

Specifies options specific to the PHP driver. In addition to driver options supported by the extension, the library additionally supports specifying a default type map to apply to the cursors it creates.

Name	Type	Description
autoEncryption	array	Options to configure client-side field-level encryption in the driver. Refer to the extension documentation for a list of supported encryption options. If a MongoDB\Client is provided for the keyVaultClient option, it will be unwrapped into a MongoDB\Driver\Manager for the extension. New in version 1.6.
driver	array	Additional driver metadata to be passed on to the server handshake. This is an array containing name, version, and platform string fields. For example: [ 'name' => 'my-driver', 'version' => '1.2.3-dev', 'platform' => 'some-platform', ] This feature is primarily designed for custom drivers and ODMs, which may want to identify themselves to the server for diagnostic purposes. Applications wishing to identify themselves should use the appName URI option instead of this option. New in version 1.7.
serverApi	MongoDB\Driver\ServerApi	Used to declare an API version on the client. Refer to the Stable API page in the Server manual for additional information. New in version 1.9.
typeMap	array	Default type map to apply to cursors, which determines how BSON documents are converted to PHP values. The library uses the following type map by default: [ 'array' => 'MongoDB\Model\BSONArray', 'document' => 'MongoDB\Model\BSONDocument', 'root' => 'MongoDB\Model\BSONDocument', ]
allow_invalid_hostname	boolean	Disables hostname validation if true. Defaults to false. Allowing invalid hostnames may expose the driver to a man-in-the-middle attack. Deprecated since version 1.6: This option has been deprecated. Use the tlsAllowInvalidHostnames URI option instead.
ca_dir	string	Path to a correctly hashed certificate directory. The system certificate store will be used by default. Falls back to the deprecated capath SSL context option if not specified.
ca_file	string	Path to a certificate authority file. The system certificate store will be used by default. Falls back to the deprecated cafile SSL context option if not specified. Deprecated since version 1.6: This option has been deprecated. Use the tlsCAFile URI option instead.
crl_file	string	Path to a certificate revocation list file.
pem_file	string	Path to a PEM encoded certificate to use for client authentication. Falls back to the deprecated local_cert SSL context option if not specified. Deprecated since version 1.6: This option has been deprecated. Use the tlsCertificateKeyFile URI option instead.
pem_pwd	string	Passphrase for the PEM encoded certificate (if applicable). Falls back to the deprecated passphrase SSL context option if not specified. Deprecated since version 1.6: This option has been deprecated. Use the tlsCertificateKeyFilePassword URI option instead.
weak_cert_validation	boolean	Disables certificate validation true. Defaults to false. Falls back to the deprecated allow_self_signed SSL context option if not specified. Deprecated since version 1.6: This option has been deprecated. Use the tlsAllowInvalidCertificates URI option instead.
context	resource	SSL context options to be used as fallbacks for other driver options (as specified). Note that the driver does not consult the default stream context. This option is supported for backwards compatibility, but should be considered deprecated.

Errors/Exceptions

MongoDB\Exception\InvalidArgumentException for errors related to the parsing of parameters or options.

MongoDB\Driver\Exception\InvalidArgumentException for errors related to the parsing of parameters or options at the extension level.

MongoDB\Driver\Exception\RuntimeException for other errors at the extension level (e.g. connection errors).

Behavior

A MongoDB\Driver\Manager is constructed internally. Per the Server Discovery and Monitoring specification, MongoDB\Driver\Manager::__construct() performs no I/O. Connections will be initialized on demand, when the first operation is executed.

Examples

<?php
$client = new MongoDB\Client('mongodb://mongodb-deployment:27017');

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

<?php
$client = new MongoDB\Client(
    'mongodb://myUsername:myPassword@rs1.example.com,rs2.example.com/?ssl=true&replicaSet=myReplicaSet&authSource=admin'
);

<?php
$client = new MongoDB\Client(
    'mongodb://rs1.example.com,rs2.example.com/'
    [
        'username' => 'myUsername',
        'password' => 'myPassword',
        'ssl' => true,
        'replicaSet' => 'myReplicaSet',
        'authSource' => 'admin',
    ],
);

<?php
$client = new MongoDB\Client(
    null,
    [],
    [
        'typeMap' => [
            'root' => 'array',
            'document' => 'array',
            'array' => 'array',
        ],
    ]
);

See Also

• MongoDB\Driver\Manager::__construct()

• Connection String URI Format in the MongoDB manual

• Server Discovery and Monitoring specification