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

MongoDB\Model\CollectionInfo::getCappedMax()

本页内容

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

已弃用自版本1.9.

MongoDB\Model\CollectionInfo::getCappedMax()

返回 capped 集合的文档限制。这与 MongoDB\Database::createCollection() 的 max 选项相关。MongoDB\Database::createCollection().

function getCappedMax(): integer|null

capped 集合的文档限制。如果集合不是 capped,则返回 null

此方法已被弃用,建议使用 MongoDB\Model\CollectionInfo::getOptions() 并访问 max 键。

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

输出将类似于

int(100)
  • MongoDB\Model\CollectionInfo::getCappedSize()

  • MongoDB\Model\CollectionInfo::isCapped()

  • MongoDB\Database::createCollection()

  • Capped Collections 在 MongoDB 手册中

  • listCollections 命令参考在 MongoDB 手册中

返回

CollectionInfo 类