/ /

/ /

Librerías de clientes

PHP

Biblioteca PHP

MongoDB\Cliente

MongoDB\cliente::getCollection()

Definición

MongoDB\Client::getCollection()

Obtiene acceso a una colección en el servidor. Este método es un alias para MongoDB\Client::selectCollection() y lo reemplazará en una versión futura.

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

Parámetros

$databaseName : cadena

El nombre de la base de datos que contiene la colección a la que se accederá.

$collectionName : cadena

El nombre de la colección a la que acceder.

$options : matriz

Una matriz que especifica las opciones deseadas.

Nombre	Tipo	Descripción
codec	MongoDB\Códec\DocumentCodec	Los datos codificados predeterminados con tipo códecs que se utilizarán para las operaciones de recopilación. Nuevo en la versión 1.17.
readConcern	MongoDB\Driver\ReadConcern	La preocupación de lectura predeterminada para las operaciones de recopilación. El valor predeterminado es la preocupación de lectura del cliente.
readPreference	MongoDB\Controlador\Preferencia de lectura	La preferencia de lectura predeterminada para las operaciones de recopilación. El valor predeterminado es la preferencia de lectura del cliente.
typeMap	arreglo	El mapa de tipos predeterminado que se utiliza para las operaciones de recopilación. El valor predeterminado es el mapa de tipos del cliente.
writeConcern	MongoDB\Driver\WriteConcern	Preocupación de escritura predeterminada para operaciones de recopilación. El valor predeterminado es la preocupación de escritura del cliente.

Return Values

Un MongoDB\Collection objeto.

Errores/Excepciones

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

Comportamiento

La colección seleccionada hereda opciones como la preferencia de lectura y la asignación de tipos del Client objeto. Las opciones se pueden anular mediante el $options parámetro.

Ejemplo

El siguiente ejemplo obtiene acceso a la colección users en la base de datos test:

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

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

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

Ver también

Volver

dropDatabase()

getDatabase()