MongoDB\Database::selectGridFSBucket()

定义

MongoDB\Database::selectGridFSBucket()

选择数据库中的 GridFS 存储桶。

function selectGridFSBucket(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 concern）。
typeMap	阵列	用于存储桶操作的默认类型映射。 默认为数据库的类型映射。
writeConcern	MongoDB\Driver\WriteConcern	用于存储桶操作的默认写关注。 默认为数据库的写关注。

Return Values

一个MongoDB\GridFS\Bucket对象。

错误/异常

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

行为

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

例子

以下示例选择test数据库中的默认fs.files存储桶：

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

以下示例在数据库test中选择具有读取偏好（read preference）的自定义images.files存储桶：

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

另请参阅

• MongoDB\GridFS\Bucket::__construct()