MongoDB\GridFS\Bucket::__construct()
Definition
MongoDB\GridFS\Bucket::__construct()
Constructs a new
Bucket
instance.function __construct( MongoDB\Driver\Manager $manager, string $databaseName, array $options = [] )
Parameters
$manager
: MongoDB\Driver\Manager- The Manager instance from the extension. The manager maintains connections between the driver and MongoDB.
$databaseName
: string- The name of the database.
$options
: arrayAn array specifying the desired options.
NameTypeDescriptionbucketNamestringThe bucket name, which will be used as a prefix for the files and chunks collections. Defaults to"fs"
.chunkSizeBytesintegerThe chunk size in bytes. Defaults to261120
(i.e. 255 KiB).codecMongoDB\Codec\DocumentCodecThe default codec to use for bucket methods that return a file document (e.g.
MongoDB\GridFS\Bucket::find()
).New in version 1.17.
readConcernThe default read concern to use for bucket operations. Defaults to the manager's read concern.readPreferenceThe default read preference to use for bucket operations. Defaults to the manager's read preference.typeMaparrayDefault type map to apply to cursors, which determines how BSON documents are converted to PHP values. The library uses the following type map by default:
[ 'array' => 'MongoDB\Model\BSONArray', 'document' => 'MongoDB\Model\BSONDocument', 'root' => 'MongoDB\Model\BSONDocument', ] writeConcernThe default write concern to use for bucket operations. Defaults to the manager's write concern.
Errors/Exceptions
MongoDB\Exception\InvalidArgumentException
for errors related to
the parsing of parameters or options.
Behavior
If you construct a Bucket explicitly, the Bucket inherits any options
from the MongoDB\Driver\Manager object.
If you select the Bucket from a Database
object,
the Bucket inherits its options from that object.
Examples
$bucket = (new MongoDB\Client)->test->selectGridFSBucket(); var_dump($bucket);
The output would then resemble:
object(MongoDB\GridFS\Bucket)#3053 (2) { ["bucketName"]=> string(4) "test" ["databaseName"]=> string(11) "phplib_test" }