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::selectCollection()

Definición

MongoDB\Database::selectCollection()

Selecciona una colección dentro de la base de datos. Este método está siendo derivado por MongoDB\Database::getCollection() y será reemplazado por éste en una versión futura.

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

Parámetros

$collectionName : string

El nombre de la colección a seleccionar.

$options : arreglo

Una matriz 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 en la versión 1.17.
readConcern	MongoDB\Driver\ReadConcern	El nivel de consistencia de lectura por defecto para usar en operaciones de colección. Se establece por defecto el nivel de consistencia de lectura de la base de datos.
readPreference	MongoDB\Driver\ReadPreference	La preferencia de lectura por defecto que se usa para las operaciones de colección. Por defecto, se aplica la preferencia de lectura de la base de datos.
typeMap	arreglo	El mapa de tipos por defecto que se debe usar para las operaciones de colección. Se establece por defecto en el mapa de tipos de su 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 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 la asignación de tipos del Database objeto. Las opciones se pueden anular mediante el $options parámetro.

Ejemplo

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

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

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

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

Ver también

Volver

renombrarColección()

selectGridFSBucket()