Docs Menu

Docs HomePHP Library Manual

MongoDB\Database::selectGridFSBucket()

On this page

  • Definition
  • Parameters
  • Return Values
  • Errors/Exceptions
  • Behavior
  • Example
  • See Also
MongoDB\Database::selectGridFSBucket()

Selects a GridFS bucket within the database.

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

An array specifying the desired options.

Name
Type
Description
bucketName
string
The bucket name, which will be used as a prefix for the files and chunks collections. Defaults to "fs".
chunkSizeBytes
integer
The chunk size in bytes. Defaults to 261120 (i.e. 255 KiB).
codec
MongoDB\Codec\DocumentCodec

The default codec to use for bucket methods that return a file document (e.g. MongoDB\GridFS\Bucket::find()).

New in version 1.17.

disableMD5
boolean

Whether to disable automatic MD5 generation when storing files.

Defaults to false. Only true will be supported in 2.0.

New in version 1.4.

readConcern
MongoDB\Driver\ReadConcern
The default read concern to use for bucket operations. Defaults to the database's read concern.
readPreference
The default read preference to use for bucket operations. Defaults to the database's read concern.
typeMap
array
The default type map to use for bucket operations. Defaults to the database's type map.
writeConcern
The default write concern to use for bucket operations. Defaults to the database's write concern.

A MongoDB\GridFS\Bucket object.

MongoDB\Exception\InvalidArgumentException for errors related to the parsing of parameters or options.

The selected bucket inherits options such as read preference and type mapping from the Database object. Options may be overridden via the $options parameter.

The following example selects the default fs.files bucket in the test database:

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

The following example selects the custom images.files bucket in the test database with a custom read preference:

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