MongoDB\Model\CollectionInfo::isCapped()

Definição

MongoDB\Model\CollectionInfo::isCapped()

Retorna se a collection é umacapped collection .

function isCapped(): boolean

Return Values

Um booleano que indica se a collection é uma collection limitada.

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

Exemplos

<?php
$db = (new MongoDB\Client)->test;
// Creates a capped collection
$db->createCollection(
   'myCappedCollection',
   ['capped' => true, 'size' => 1048576]
);
// Retrieves whether the collection is capped
foreach ($db->listCollections(['filter' => ['name' => 'myCappedCollection']]) as $info) {
   var_dump($info->isCapped());
}

A saída seria então semelhante a:

bool(true)

Veja também

• MongoDB\Model\CollectionInfo::getCappedMax()

• MongoDB\Model\CollectionInfo::getCappedSize()

• Coleções limitadas no manual do MongoDB

• referência do comando listCollections no manual do MongoDB