MongoDB\Database::selectGridFSBucket()

Definición

MongoDB\Database::selectGridFSBucket()

Selecciona un depósito GridFS dentro de la base de datos.

function selectGridFSBucket(array $options = []): MongoDB\GridFS\Bucket

Parámetros

$options : matriz

Una matriz que especifica las opciones deseadas.

Nombre	Tipo	Descripción
bucketName	string	El nombre del depósito, que se usará como prefijo para las colecciones de archivos y fragmentos. El valor predeterminado es "fs".
bytes de tamaño de fragmento	entero	Tamaño del fragmento en bytes. El valor predeterminado es 261120 (es decir, 255 KiB).
codec	MongoDB\Códec\DocumentCodec	El valor predeterminado Codifique los datos con códecs de tipo para utilizarlos en métodos de depósito que devuelven un documento de archivo (porMongoDB\GridFS\Bucket::find() ejemplo,). Nuevo en la versión 1.17.
readConcern	MongoDB\Driver\ReadConcern	Preocupación de lectura predeterminada para operaciones de depósito. 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 depósito. El valor predeterminado es la preocupación de lectura de la base de datos.
typeMap	arreglo	El mapa de tipos predeterminado para las operaciones de depósito. El valor predeterminado es el mapa de tipos de la base de datos.
writeConcern	MongoDB\Driver\WriteConcern	Preocupación de escritura predeterminada para operaciones de depósito. El valor predeterminado es la preocupación de escritura de la base de datos.

Return Values

Un MongoDB\GridFS\Bucket objeto.

Errores/Excepciones

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

Comportamiento

El contenedor seleccionado 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 el depósito predeterminado fs.files en la base de datos test:

<?php
$db = (new MongoDB\Client)->test;
$bucket = $db->selectGridFSBucket();

El siguiente ejemplo selecciona el depósito personalizado images.files en la base de datos test con una preferencia de lectura personalizada:

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

Ver también

• MongoDB\GridFS\Bucket::__construct()