MongoDB\Model\CollectionInfo::getCappedMax()

定義

MongoDB\Model\CollectionInfo::getCappedMax()

Capped コレクションのドキュメント制限を返します。 これは、 MongoDB\Database::createCollection()のmaxオプションと相関します。

function getCappedMax(): integer|null

Return Values

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()

• MongoDB マニュアルの「 Capped コレクション」

• MongoDB マニュアルのlistCollectionsコマンド参照