MongoDB\Client::selectCollection()

Definición

MongoDB\Client::selectCollection()

Elige una colección en el servidor. Este método tiene un alias denominado MongoDB\Client::getCollection() y será reemplazado por este en una versión futura.

function selectCollection(
    string $databaseName,
    string $collectionName,
    array $options = []
): MongoDB\Collection

Parámetros

$databaseName : string

El nombre de la base de datos que contiene la colección que se va a seleccionar.

$collectionName : string

El nombre de la colección a seleccionar.

$options : arreglo

Un arreglo que especifica las opciones deseadas.

Nombre	Tipo	Descripción
códec	MongoDB\Codec\DocumentCodec	El Codificación de datos con códecs de tipo por defecto a usar para operaciones de colección. Novedad 1.17 en la versión.:
readConcern	MongoDB\Driver\ReadConcern	El nivel de consistencia de lectura por defecto a utilizar para las operaciones de colección. Por defecto, asume el nivel de consistencia de lectura del cliente.
readPreference	MongoDB\Driver\ReadPreference	La preferencia de lectura por defecto que se usa para las operaciones de colección. Por defecto, se utiliza la preferencia de lectura del cliente.
typeMap	arreglo	El mapa de tipos por defecto para usar en las operaciones de la colección. Por defecto, se utiliza el mapa de tipos del cliente.
writeConcern	MongoDB\Driver\WriteConcern	El nivel de confirmación de escritura (write concern) por defecto que se usará para las operaciones de colección. Se establece por defecto según el nivel de confirmación de escritura (write concern) del cliente.

Return Values

Un objeto MongoDB\Collection.

Errores/Excepciones

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

Comportamiento

La colección seleccionada hereda opciones como la preferencia de lectura y el mapeo de tipo del objeto Client. Las opciones pueden ser anuladas utilizando el parámetro $options.

Ejemplo

El siguiente ejemplo selecciona la colección users en la base de datos test:

<?php
$client = new MongoDB\Client;
$collection = $client->selectCollection('test', 'users');

El siguiente ejemplo selecciona la colección users en la base de datos test con una preferencia de lectura personalizada:

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