Docs 菜单
Docs 主页
/
语言
/
PHP
/
PHP 库手册
/
API 文档
/
结果类
/
CollectionInfo 类

MongoDB\Model\CollectionInfo::getOptions()

在此页面上

  • 定义
  • 返回值
  • 举例
  • 另请参阅

定义

MongoDB\Model\CollectionInfo::getOptions()

返回集合选项。这与 MongoDB\Database::createCollection()的选项相关，但可能包括服务器设置的其他字段。

function getOptions(): array

返回值

collection选项。这对应于listCollections命令回复中返回的options字段。

举例

<?php
$info = new CollectionInfo([
    'name' => 'foo',
    'options' => [
        'capped' => true,
        'size' => 1048576,
    ]
]);
var_dump($info->getOptions());

而输出将类似如下所示：

array(2) {
  ["capped"]=>
  bool(true)
  ["size"]=>
  int(1048576)
}

另请参阅

  • MongoDB\Database::createCollection()

  • MongoDB 手册中的listCollections命令参考

后退

getName()