Definição
MongoDB\Database::getGridFSBucket()Obtém acesso a um bucket do GridFS dentro do banco de dados. Este método é um alias para
MongoDB\Database::selectGridFSBucket()e o substituirá em uma versão futura.function getGridFSBucket(array $options = []): MongoDB\GridFS\Bucket
Parâmetros
$options: arrayUma array especificando as opções desejadas.
NomeTipoDescriçãobucketName
string
O nome do bucket, que será usado como prefixo para os arquivos e as collections de chunks. Padrão é
"fs".chunkSizeBytes
inteiro
O tamanho da parte em bytes. O padrão é
261120(255 KiB).Codec
MongoDB\Codec\DocumentCodec
O Encode Data with Type Codecs padrão a ser usado para métodos de bucket que retornam um documento de arquivo, como
MongoDB\GridFS\Bucket::find().Novidades na versão 1.17.
readConcern
A referência de leitura padrão a ser usada para operações de bucket. O padrão é a preocupação de leitura do banco de dados.
readPreference
A preferência de leitura padrão a ser usada para operações de bucket. O padrão é a preferência de leitura do banco de dados.
typeMap
array
O mapa de tipos padrão a ser usado para operações de bucket. O padrão é o mapa de tipos do banco de dados.
writeConcern
A referência de escrita padrão a ser usada para operações de bucket. O padrão é a preocupação de gravação do banco de dados.
Return Values
O método getGridFSBucket() retorna um objeto MongoDB\GridFS\Bucket.
Erros/exceções
MongoDB\Exception\InvalidArgumentException para erros relacionados à análise de parâmetros ou opções.
Comportamento
O bucket selecionado herda opções como preferência de leitura e mapeamento de tipo do objeto Database. Você pode substituir as opções usando o parâmetro $options.
Exemplo
O exemplo a seguir obtém acesso ao bucket fs.files padrão no banco de dados test:
$db = (new MongoDB\Client)->test;
$bucket = $db->getGridFSBucket();O exemplo a seguir obtém acesso ao bucket images.files personalizado no banco de dados test com uma preferência de leitura personalizada:
$db = (new MongoDB\Client)->test;
$imagesBucket = $db->getGridFSBucket([ 'bucketName' => 'images', 'readPreference' => new MongoDB\Driver\ReadPreference('primaryPreferred'),]);