MongoDB\Model\IndexInfo::isTtl()

Definition

MongoDB\Model\IndexInfo::isTtl()

Return whether the index is a TTL index. This correlates with the expireAfterSeconds option for MongoDB\Collection::createIndex().

function isTtl(): boolean

Return Values

A boolean indicating whether the index is a TTL index.

Examples

<?php
$info = new IndexInfo([
    'expireAfterSeconds' => 100,
]);
var_dump($info->isTtl());

The output would then resemble:

bool(true)

See Also

• MongoDB\Collection::createIndex()

• listIndexes command reference in the MongoDB manual

• TTL Indexes in the MongoDB manual