MongoDB\Model\CollectionInfo::getCappedMax()

Definición

MongoDB\Model\CollectionInfo::getCappedMax()

Devuelve el límite de documentos para la colección limitada. Esto se correlaciona con la opción max para MongoDB\Database::createCollection().

function getCappedMax(): integer|null

Return Values

El límite de documentos para la colección limitada. Si la colección no tiene límite, se devolverá null.

Este método está en desuso a favor de usar MongoDB\Model\CollectionInfo::getOptions() y acceder a la clave max.

Ejemplos

<?php
$db = (new MongoDB\Client)->test;
// Creates a capped collection with a document limit of 100
$db->createCollection(
   'myCappedCollection',
   ['capped' => true, 'size' => 1048576, 'max' => 100]
);
// Retrieves the document limit for the capped collection
foreach ($db->listCollections(['filter' => ['name' => 'myCappedCollection']]) as $info) {
   var_dump($info->getCappedMax());
}

La vista de salida se ilustraría como sigue:

int(100)

Ver también

• MongoDB\Model\CollectionInfo::getCappedSize()

• MongoDB\Model\CollectionInfo::isCapped()

• MongoDB\Database::createCollection()

• colección con tamaño fijo en el manual de MongoDB

• Referencia del comando listCollections en el manual de MongoDB