MongoDB\Model\CollectionInfo::getOptions()

定義

MongoDB\Model\CollectionInfo::getOptions()

コレクションオプションを返します。これは、 MongoDB\Database::createCollection()のオプションと相関しますが、サーバーによって設定された追加のフィールドが含まれる場合があります。

function getOptions(): array

Return Values

コレクションオプションこれは、 listCollectionsコマンドの応答で返されるoptionsフィールドに対応します。

例

<?php
// Creates a capped collection
$db->createCollection(
   'myCappedCollection',
   ['capped' => true, 'size' => 1048576]
);
// Retrieves the options for the collection
foreach ($db->listCollections(['filter' => ['name' => 'myCappedCollection']]) as $info) {
   var_dump($info->getOptions());
}

出力は次のようになります。

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

その他の参照

MongoDB\Database::createCollection()
MongoDB マニュアルのlistCollectionsコマンド参照

戻る

getName()

getType()