Skip to content

Commit 014d90e

Browse files
author
Sam Kleinman
committed
DOCS-727: clarification about sparse indexes
1 parent e5b3541 commit 014d90e

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

source/core/indexes.txt

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -316,7 +316,7 @@ Sparse Index
316316
~~~~~~~~~~~~
317317

318318
Sparse indexes only contain entries for documents that have the
319-
indexed field. By contrast, non-sparse indexes contain all documents
319+
indexed field. [#null-values-are-indexed-in-sparse-indexes]_ By contrast, non-sparse indexes contain all documents
320320
in a collection, and store null values for documents that do not
321321
contain the indexed field. Create a sparse index on the ``xmpp_id``
322322
field, of the ``members`` collection, using the following operation in
@@ -334,7 +334,7 @@ the :program:`mongo` shell:
334334

335335
.. note::
336336

337-
Sparse indexes in MongoDB are not to be confused with `block-level`_
337+
Do not confuse sparse indexes in MongoDB with `block-level`_
338338
indexes in other databases. Think of them as dense indexes with a
339339
specific filter.
340340

@@ -345,6 +345,10 @@ the :program:`mongo` shell:
345345

346346
.. _`block-level`: http://en.wikipedia.org/wiki/Index_%28database%29#Sparse_index>
347347

348+
.. [#null-values-are-indexed-in-sparse-indexes] All documents that
349+
have the indexed field *are* indexed in a sparse index, even if
350+
that field stores a null value in some documents.
351+
348352
.. _index-creation-operations:
349353
.. _index-operations:
350354

@@ -394,7 +398,7 @@ construction:
394398

395399
.. versionchanged:: 2.2
396400
Before 2.2, a single :program:`mongod` instance could only build
397-
one index at a time.
401+
one index at a time.
398402

399403
- The indexing operation runs in the background so that other database
400404
operations can run while creating the index. However, the

0 commit comments

Comments
 (0)