MongoDB\Database::getGridFSBucket()

定义

MongoDB\Database::getGridFSBucket()

获取对数据库中GridFS存储桶的访问权限。此方法是 MongoDB\Database::selectGridFSBucket() 的别名，将在未来发布中取代它。

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

参数

$options : array

指定所需选项的数组。

名称	类型	说明
bucketName	字符串	存储桶名称，将用作文件和数据块collection的前缀。默认为"fs" 。
chunkSizeBytes	整型	数据块大小（以字节为单位）。默认为 261120 (255 KiB)。
编解码器	MongoDB\Codec\DocumentCodec	默认使用类型编解码器对数据进行编码，用于返回文件文档的存储桶方法，例如 MongoDB\GridFS\Bucket::find()。 1.17版本新增。
事务外的	MongoDB\Driver\ReadConcern	用于存储桶操作的默认读关注（read concern）。默认为数据库的读关注。
readPreference	MongoDB\Driver\ReadPreference	用于存储桶操作的默认读取偏好（read preference）。默认为数据库的读取偏好（read preference）。
typeMap	阵列	用于存储桶操作的默认类型映射。 默认为数据库的类型映射。
writeConcern	MongoDB\Driver\WriteConcern	用于存储桶操作的默认写关注。 默认为数据库的写关注。

Return Values

getGridFSBucket() 方法返回一个 MongoDB\GridFS\Bucket对象。

错误/异常

MongoDB\Exception\InvalidArgumentException 用于与参数或选项解析相关的错误。

行为

所选存储桶会从 Database对象继承读取偏好（read preference）和类型映射等选项。您可以使用 $options 参数覆盖选项。

例子

以下示例获取对 test数据库中默认fs.files 存储桶的访问权限：

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

以下示例使用自定义读取偏好（read preference）访问权限test数据库中的自定义 images.files 存储桶：

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

另请参阅

• MongoDB\Database::selectGridFSBucket()

• MongoDB\GridFS\Bucket::__construct()