1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
==============================================
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.
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