文档菜单
文档首页
/ / /
PHP库手册
/ /

MongoDB\GridFS\Bucket::__construct()

本页内容

  • 定义
  • 参数
  • 错误/异常
  • 行为
  • 示例
  • 另请参阅
MongoDB\GridFS\Bucket::__construct()

构建一个新的Bucket 实例。

function __construct(
MongoDB\Driver\Manager $manager,
string $databaseName,
array $options = []
)
$manager : MongoDB\Driver\Manager
从扩展中获取 Manager 实例。Manager 维护驱动程序与 MongoDB 之间的连接。
$databaseName : string
数据库名称。
$options : 数组

指定所需选项的数组。

名称
类型
描述
bucketName
字符串
桶名称,将用作文件和块集合的前缀。默认为 "fs"
chunkSizeBytes
整数
以字节为单位的块大小。默认为 261120 (即 255 KiB)。
codec
MongoDB\Codec\DocumentCodec

用于返回文件文档的桶方法(例如,MongoDB\GridFS\Bucket::find())的默认 codec

新增版本1.17.

disableMD5
布尔型

是否在存储文件时禁用自动MD5生成。

默认为 false。2.0版本中仅支持 true

新增版本1.4.

readConcern
用于桶操作的默认读取关注点。默认为管理器的读取关注点。
readPreference
用于桶操作的默认读取偏好。默认为管理器的读取偏好。
typeMap
数组

默认 类型映射 应用到游标,它决定了BSON文档如何转换为PHP值。库默认使用以下类型映射

[
'array' => 'MongoDB\Model\BSONArray',
'document' => 'MongoDB\Model\BSONDocument',
'root' => 'MongoDB\Model\BSONDocument',
]
writeConcern
用于桶操作的默认写入关注点。默认为管理器的写入关注点。

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

如果你显式地构建一个Bucket,Bucket将继承自MongoDB\Driver\Manager对象中的任何选项。如果你从一个Database对象中选择Bucket,Bucket将继承该对象的选项。

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

输出结果将类似于

object(MongoDB\GridFS\Bucket)#3053 (2) {
["bucketName"]=>
string(4) "test"
["databaseName"]=>
string(11) "phplib_test"
}

返回

MongoDB\GridFS\Bucket