MongoDB\Database::selectGridFSBucket()

Definição

MongoDB\Database::selectGridFSBucket()

Seleciona um bucket GridFS dentro do reconhecimento de data center.

function selectGridFSBucket(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 da parte em bytes. O padrão é 261120 (ou seja, 255 KB).
Codec	MongoDB\Codec\DocumentCodec	Ocodec padrão a ser usado para métodos de bucket que retornam um documento de arquivo (por exemplo, MongoDB\GridFS\Bucket::find()). Novidade na versão 1.17.
disableMD5	booleano	Se a geração automática de md5 deve ser desabilitada ao armazenar arquivos. Padrão é false. Somente true será suportado em 2.0. Novidade na versão 1.4.
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 contêiner. O padrão é a preocupação 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.
Escreva preocupação	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.

Valores de retorno

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 . As opções podem ser substituídas através do parâmetro $options .

Exemplo

O exemplo a seguir seleciona o bucket fs.files padrão no reconhecimento de data center test :

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

O exemplo a seguir seleciona o bucket images.files personalizado no reconhecimento de data center test com uma preferência de leitura personalizada:

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

Veja também

• MongoDB\GridFS\Bucket::__construct()