MongoDBModelCollectionInfo-getOptions.txt 818 Bytes
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36
============================================
MongoDB\\Model\\CollectionInfo::getOptions()
============================================

.. default-domain:: mongodb

.. contents:: On this page
   :local:
   :backlinks: none
   :depth: 1
   :class: singlecol

Definition
----------

.. phpmethod:: MongoDB\\Model\\CollectionInfo::getOptions()

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

   .. code-block:: php

      function getOptions(): array

Return Values
-------------

The collection options.

See Also
--------

- :phpmethod:`MongoDB\\Database::createCollection()`
- :manual:`listCollections </reference/command/listCollections>` command
  reference in the MongoDB manual