PHP Classes

File: vendor/mongodb/mongodb/docs/reference/method/MongoDBModelCollectionInfo-getCappedMax.txt

Recommend this page to a friend!
  Classes of walid laggoune   MongoDB Queue PHP Query Execute   vendor/mongodb/mongodb/docs/reference/method/MongoDBModelCollectionInfo-getCappedMax.txt   Download  
File: vendor/mongodb/mongodb/docs/reference/method/MongoDBModelCollectionInfo-getCappedMax.txt
Role: Documentation
Content type: text/plain
Description: Documentation
Class: MongoDB Queue PHP Query Execute
Query and execute multiple queries using MongoDB
Author: By
Last change:
Date: 4 years ago
Size: 1,404 bytes
 

Contents

Class file image Download
============================================== MongoDB\\Model\\CollectionInfo::getCappedMax() ============================================== .. default-domain:: mongodb .. contents:: On this page :local: :backlinks: none :depth: 1 :class: singlecol Definition ---------- .. phpmethod:: MongoDB\\Model\\CollectionInfo::getCappedMax() Return the document limit for the capped collection. This correlates with the ``max`` option for :phpmethod:`MongoDB\\Database::createCollection()`. .. code-block:: php function getCappedMax(): integer|null Return Values ------------- The document limit for the capped collection. If the collection is not capped, ``null`` will be returned. Examples -------- .. code-block:: php <?php $info = new CollectionInfo([ 'name' => 'foo', 'options' => [ 'capped' => true, 'size' => 1048576, 'max' => 100, ] ]); var_dump($info->getCappedMax()); The output would then resemble:: int(100) See Also -------- - :phpmethod:`MongoDB\\Model\\CollectionInfo::getCappedSize()` - :phpmethod:`MongoDB\\Model\\CollectionInfo::isCapped()` - :phpmethod:`MongoDB\\Database::createCollection()` - :manual:`Capped Collections </core/capped-collections>` in the MongoDB manual - :manual:`listCollections </reference/command/listCollections>` command reference in the MongoDB manual