MongoDB\Database::getGridFSBucket()

Definición

MongoDB\Database::getGridFSBucket()

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

function getGridFSBucket(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. Por defecto es `261120` (255 KiB).
códec	MongoDB\Codec\DocumentCodec	El tipo de códecs de codificación de datos predeterminado que se utilizará para los métodos de bucket que devuelven un documento de archivo, como `MongoDB\GridFS\Bucket::find()`. Nuevo en la versión 1.17.
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	Preferencia de lectura predeterminada para operaciones de bucket. Por defecto, se utiliza la preferencia 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

El método getGridFSBucket() devuelve un objetoMongoDB\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 la asignación de tipos del objeto Database. Puede anular las opciones utilizando el parámetro $options.

Ejemplo

El siguiente ejemplo obtiene acceso al bucket fs.files predeterminado en la base de datos test:

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

El siguiente ejemplo obtiene acceso al bucket personalizado images.files en la base de datos test con una preferencia de lectura personalizada:

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

Ver también

Overview