MongoDB\Model\CollectionInfo::getCappedMax()

Definição

MongoDB\Model\CollectionInfo::getCappedMax()

Retornar o limite do documento para a collection limitada. Isso se correlaciona com a opção max para MongoDB\Database::createCollection().

function getCappedMax(): integer|null

Return Values

O limite de documento para a collection limitada. Se a collection não for limitada, null será retornado.

Este método é preterido em favor de usar MongoDB\Model\CollectionInfo::getOptions() e acessar a chave max .

Exemplos

<?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());
}

A saída seria então semelhante a:

int(100)

Veja também

• MongoDB\Model\CollectionInfo::getCappedSize()

• MongoDB\Model\CollectionInfo::isCapped()

• MongoDB\Database::createCollection()

• Coleções limitadas no manual do MongoDB

• referência do comando listCollections no manual do MongoDB