• API Documentation >
• Enumeration Classes >
• MongoDB\Model\CollectionInfo::getCappedSize()

MongoDB\Model\CollectionInfo::getCappedSize()

Deprecated since version 1.9.

Definition

MongoDB\Model\CollectionInfo::getCappedSize

Return the size limit for the capped collection in bytes. This correlates with the size option for MongoDB\Database::createCollection().

copy

function getCappedSize(): integer|null

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

copy

<?php

$info = new CollectionInfo([
    'name' => 'foo',
    'options' => [
        'capped' => true,
        'size' => 1048576,
    ]
]);

var_dump($info->getCappedSize());

The output would then resemble:

copy

int(1048576)

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

←   MongoDB\Model\CollectionInfo::getCappedMax() MongoDB\Model\CollectionInfo::getIdIndex()  →

© MongoDB, Inc 2008-present. MongoDB, Mongo, and the leaf logo are registered trademarks of MongoDB, Inc.