MongoDB\Database::selectGridFSBucket()

定义

MongoDB\Database::selectGridFSBucket()

选择数据库中的GridFS桶。

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

参数

$options : array

一个指定所需选项的数组。

名称	类型	描述
bucketName	string	桶名称，将用作文件和块集合的前缀。默认为 "fs"。
chunkSizeBytes	integer	以字节为单位的块大小。默认为 261120（即 255 KiB）。
codec	MongoDB\Codec\DocumentCodec	默认用于桶方法的默认 codec，用于返回文件文档（例如，MongoDB\GridFS\Bucket::find()）。 新版本1.17.
禁用MD5	布尔类型	是否在存储文件时禁用自动MD5生成。 默认值为 false。2.0版本中仅支持 true。 新版本1.4.
读取关注点	MongoDB\Driver\ReadConcern	用于桶操作的默认读取关注点。默认为数据库的读取关注点。
读取优先级	MongoDB\Driver\ReadPreference	用于桶操作的默认读取优先级。默认为数据库的读取关注点。
类型映射	数组	用于桶操作的默认类型映射。默认为数据库的类型映射。
写入关注点	MongoDB\Driver\WriteConcern	用于桶操作的默认写入关注点。默认为数据库的写入关注点。

返回值

一个 MongoDB\GridFS\Bucket 对象。

错误/异常

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

行为

选择的桶继承自 Database 对象的选项，如读取优先级和类型映射。可以通过 $options 参数覆盖这些选项。

示例

以下示例选择了测试数据库中的默认 fs.files 存储桶

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

以下示例选择了测试数据库中的自定义 images.files 存储桶，并具有自定义的读取偏好

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

另请参阅

• MongoDB\GridFS\Bucket::__construct()