Docs Home

/ /

MongoDB\Base de datos

Docs Home

/ /

Biblioteca PHP

MongoDB\Base de datos

Docs Home

Librerías de clientes

PHP

Biblioteca PHP

MongoDB\Base de datos

MongoDB\Database::getCollection()

Definición

MongoDB\Database::getCollection()

Obtiene acceso a una colección dentro de la base de datos. Este método es un alias para MongoDB\Database::selectCollection() y lo reemplazará en una versión futura.

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

Parámetros

$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 de la base de datos.
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 de la base de datos.
typeMap	arreglo	El mapa de tipos predeterminado que se utiliza para las operaciones de recopilación. El valor predeterminado es el mapa de tipos de la base de datos.
writeConcern	MongoDB\Driver\WriteConcern	La configuración de nivel de confirmación de escritura (write concern) por defecto para usar en las operaciones de la colección. Por defecto, se aplica el nivel de confirmación de escritura (write concern) de la base de datos.

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 Database 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
$db = (new MongoDB\Client)->test;
$collection = $db->getCollection('users');

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

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

Ver también

Volver

dropCollection()

getDatabaseName()