MongoDB\Database::getGridFSBucket()

Definição

MongoDB\Database::getGridFSBucket()

Obtém acesso a um bucket 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 : array

Uma array especificando as opções desejadas.

Nome	Tipo	Descrição
bucketName	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 do chunk em bytes. O padrão é `261120` (255 KB).
Codec	MongoDB\Codec\DocumentCodec	Os dados de codificação padrão com codecs de tipo a serem usados em métodos de bucket que retornam um documento de arquivo , como `MongoDB\GridFS\Bucket::find()`. Novidades na versão 1.17.
readConcern	MongoDB\Driver\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	MongoDB\Driver\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	MongoDB\Driver\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 objetoMongoDB\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 objetoDatabase. Você pode substituir opções usando o parâmetro$options.

Exemplo

O exemplo a seguir obtém acesso ao bucket fs.files padrão no banco de dadostest :

<?php
$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:

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

Veja também

Visão geral