- API Documentation >
- Enumeration Classes >
- MongoDB\Model\CollectionInfo::getCappedSize()
MongoDB\Model\CollectionInfo::getCappedSize()
Deprecated since version 1.9.
On this page
Definition
-
MongoDB\Model\CollectionInfo::getCappedSize
Return the size limit for the capped collection in bytes. This correlates with the
size
option forMongoDB\Database::createCollection()
.
Return Values
The size limit for the capped collection in bytes. If the collection is not
capped, null
will be returned.
This method is deprecated in favor of using
MongoDB\Model\CollectionInfo::getOptions()
and accessing the
size
key.
Examples
The output would then resemble:
See Also
MongoDB\Model\CollectionInfo::getCappedMax()
MongoDB\Model\CollectionInfo::isCapped()
MongoDB\Database::createCollection()
- Capped Collections in the MongoDB manual
- listCollections command reference in the MongoDB manual