• Reference >
• Enumeration Classes >
• MongoDB\Model\CollectionInfo::getOptions()

MongoDB\Model\CollectionInfo::getOptions()

Definition

MongoDB\Model\CollectionInfo::getOptions

Return the collection options. This correlates with the options for MongoDB\Database::createCollection(), but may include additional fields set by the server.

copy

function getOptions(): array

Return Values

The collection options. This corresponds to the options field returned in the listCollections command reply.

Examples

copy

<?php

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

var_dump($info->getOptions());

The output would then resemble:

array(2) {
  ["capped"]=>
  bool(true)
  ["size"]=>
  int(1048576)
}

See Also

• MongoDB\Database::createCollection()
• listCollections command reference in the MongoDB manual

←   MongoDB\Model\CollectionInfo::getName() MongoDB\Model\CollectionInfo::getType()  →

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