Skip to content

Commit 9bb7dde

Browse files
authored
(DOCSP-8369) Explain what indexes are on the Manage Indexes page (#212)
* WIP * (DOCSP-8369) Overview of indexes * Formatting and word choice * Changes based on review * Further changes * Changes based on another round of review * Finalizing changes * Limitations to bottom of page
1 parent e35332b commit 9bb7dde

File tree

1 file changed

+34
-8
lines changed

1 file changed

+34
-8
lines changed

source/indexes.txt

Lines changed: 34 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,32 @@ Manage Indexes
1212
:depth: 1
1313
:class: singlecol
1414

15+
Indexes are special data structures that improve query performance.
16+
Indexes store a portion of a collection's data in an easy-to-traverse
17+
form. The index stores the value of a specific field or set of fields,
18+
ordered by the value of the field.
19+
20+
To improve query performance, build indexes on fields that appear often
21+
in queries and for all operations that
22+
:ref:`sort by a field <query-bar-sort>`.
23+
24+
- Queries on an indexed field can use the index to limit the number of
25+
documents that must be scanned to find matching documents.
26+
27+
- Sort operations on an indexed field can return documents pre-sorted
28+
by the index.
29+
30+
To learn more about indexes, see :manual:`Indexes </indexes>`.
31+
32+
.. admonition:: Considerations
33+
:class: note
34+
35+
Indexes have some negative performance impact on write operations.
36+
For collections with high write-to-read ratio, indexes are expensive
37+
since each insert must also update any indexes. For a detailed list
38+
of considerations for indexes, see
39+
:manual:`Operational Considerations for Indexes <core/data-model-operations/#data-model-indexes>`.
40+
1541
.. _indexes-tab:
1642

1743
Indexes Tab
@@ -47,14 +73,6 @@ For each index, Compass displays the following information:
4773
- Any special properties (such as uniqueness, partial) of the
4874
index.
4975

50-
Limitations
51-
-----------
52-
53-
- .. include:: /includes/extracts/readonly-not-permitted-indexes.rst
54-
55-
- The :guilabel:`Indexes` tab is not available if you are connected
56-
to a :atlas:`Data Lake </data-lake>`.
57-
5876
.. _create-index:
5977

6078
Create an Index
@@ -71,3 +89,11 @@ Drop an Index
7189
---------------
7290

7391
.. include:: /includes/steps/drop-index.rst
92+
93+
Limitations
94+
-----------
95+
96+
- .. include:: /includes/extracts/readonly-not-permitted-indexes.rst
97+
98+
- The :guilabel:`Indexes` tab is not available if you are connected
99+
to a :atlas:`Data Lake </data-lake>`.

0 commit comments

Comments
 (0)