MongoDBModelIndexInfo-isSparse.txt 881 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 37
=====================================
MongoDB\\Model\\IndexInfo::isSparse()
=====================================

.. default-domain:: mongodb

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

Definition
----------

.. phpmethod:: MongoDB\\Model\\IndexInfo::isSparse()

   Return whether the index is a :manual:`sparse index </core/index-sparse>`.
   This correlates with the ``sparse`` option for
   :phpmethod:`MongoDB\\Collection::createIndex()`.

   .. code-block:: php

      function isSparse(): boolean

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

A boolean indicating whether the index is a sparse index.

See Also
--------

- :phpmethod:`MongoDB\\Collection::createIndex()`
- :manual:`listIndexes </reference/command/listIndexes>` command reference in
  the MongoDB manual
- :manual:`Sparse Indexes </core/index-sparse>` in the MongoDB manual