MongoDB\Client::selectDatabase()

Definición

MongoDB\Client::selectDatabase()

Selecciona una base de datos en el servidor. Este método tiene un alias denominado MongoDB\Client::getDatabase() y será reemplazado por este en una versión futura.

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

Parámetros

$databaseName : string

El nombre de la base de datos a seleccionar.

$options : arreglo

Un arreglo que especifica las opciones deseadas.

Nombre	Tipo	Descripción
readConcern	MongoDB\Driver\ReadConcern	El nivel de consistencia de lectura por defecto a usar para las operaciones de la base de datos. Por defecto, utiliza el nivel de consistencia de lectura del cliente.
readPreference	MongoDB\Driver\ReadPreference	La preferencia de lectura por defecto para usar en operaciones de base de datos. Por defecto, se utiliza la preferencia de lectura del cliente.
typeMap	arreglo	El mapa de tipos por defecto que se utilizará para las operaciones de base de datos. Por defecto, se establece en el mapa de tipos del cliente.
writeConcern	MongoDB\Driver\WriteConcern	El nivel de confirmación de escritura (write concern) por defecto para utilizar en las operaciones de la base de datos. Predeterminado al nivel de confirmación de escritura (write concern) del cliente.

Return Values

Un objeto MongoDB\Database.

Errores/Excepciones

MongoDB\Exception\InvalidArgumentException por errores relacionados con el análisis de parámetros u opciones.

Comportamiento

La base de datos seleccionada hereda opciones como la preferencia de lectura y el mapeo de tipos del objeto Client. Las opciones pueden ser reemplazadas utilizando el parámetro $options.

Ejemplo

El siguiente ejemplo selecciona la base de datos test:

<?php
$client = new MongoDB\Client;
$db = $client->selectDatabase('test');

En los siguientes ejemplos se selecciona la base de datos test con una preferencia de lectura personalizada:

<?php
$client = new MongoDB\Client;
$db = $client->selectDatabase(
    'test',
    [
        'readPreference' => new MongoDB\Driver\ReadPreference('primaryPreferred'),
    ]
);