MongoDB\Database::selectGridFSBucket()

Definición

MongoDB\Database::selectGridFSBucket()

Selecciona un bucket GridFS dentro de la base de datos.

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

Parámetros

$options : arreglo

Un arreglo que especifica las opciones deseadas.

Nombre	Tipo	Descripción
bucketName	string	El nombre del bucket, que se utilizará como prefijo para los archivos y colecciones de fragmentos. El valor por defecto es "fs".
tamaño del fragmento en bytes	entero	El tamaño del fragmento en bytes. El valor por defecto es 261120 (es decir, 255 KiB).
códec	MongoDB\Codec\DocumentCodec	Por defecto Codifica datos con codecs de tipo para usar en métodos de Bucket que devuelvan un documento de archivo (por ejemplo, MongoDB\GridFS\Bucket::find()). Novedad en la versión 1.17.
disableMD5	booleano	Indica si se debe deshabilitar la generación automática de MD5 al almacenar archivos. Por defecto es false. Solo true será soportado en 2.0. Nuevo en la versión 1.4.
readConcern	MongoDB\Driver\ReadConcern	El nivel de consistencia de lectura por defecto que se debe usar para las operaciones de bucket. Por defecto, se utiliza el nivel de consistencia de lectura de la base de datos.
readPreference	MongoDB\Driver\ReadPreference	La preferencia de lectura por defecto para usar en las operaciones de cubos. Por defecto, se utiliza el nivel de consistencia de lectura de la base de datos.
typeMap	arreglo	El mapa de tipos por defecto para usar en operaciones de bucket. Por defecto, utiliza el mapa de tipos de la base de datos.
writeConcern	MongoDB\Driver\WriteConcern	El nivel de confirmación de escritura (write concern) por defecto que se utiliza para las operaciones del bucket. Por defecto, se configura el nivel de confirmación de escritura (write concern) de la base de datos.

Return Values

Un objeto MongoDB\GridFS\Bucket.

Errores/Excepciones

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

Comportamiento

El bucket seleccionado hereda opciones como la preferencia de lectura y el mapeo de tipos del objeto Database. Las opciones se pueden anular mediante el parámetro $options.

Ejemplo

El siguiente ejemplo selecciona el bucket fs.files por defecto en la base de datos test:

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

El siguiente ejemplo selecciona el contenedor 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()