Skip to content

Commit b514dff

Browse files
authored
DOCSP-26661 EOL cleanup for Index pages. (#2189) (#2200)
* DOCSP-26661 Fixes references to EOL releases for index pages in source/code * Fixes EOL version on Query Optimization page * EOL cleanup on multikey, sparse, and multikey bounds pages * EOL fixes to index pages * Removes version reference from include * Removes text index table * Removes text index table
1 parent c196ddd commit b514dff

File tree

6 files changed

+29
-94
lines changed

6 files changed

+29
-94
lines changed

source/core/index-multikey.txt

Lines changed: 4 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -39,12 +39,11 @@ To create a multikey index, use the
3939
MongoDB automatically creates a multikey index if any indexed field is
4040
an array; you do not need to explicitly specify the multikey type.
4141

42-
.. versionchanged:: 3.4
42+
.. note::
4343

4444
*For the WiredTiger and In-Memory storage engines only*,
4545

46-
Starting in MongoDB 3.4, for multikey indexes created using MongoDB
47-
3.4 or later, MongoDB keeps track of which indexed field or fields
46+
For multikey indexes, MongoDB keeps track of which indexed field or fields
4847
cause an index to be a multikey index. Tracking this information
4948
allows the MongoDB query engine to use tighter index bounds.
5049

@@ -158,13 +157,8 @@ Covered Queries
158157

159158
.. include:: /includes/fact-multikey-index-covered-query.rst
160159

161-
However, starting in 3.6, multikey indexes can cover queries over the
162-
non-array fields if the index tracks which field or fields cause the
163-
index to be multikey. Multikey indexes created in MongoDB 3.4 or later
164-
on storage engines other than MMAPv1 [#]_ track this data.
165-
166-
.. [#]
167-
Starting in version 4.2, MongoDB removes the deprecated MMAPv1 storage engine.
160+
Multikey indexes can cover queries over non-array fields if the index tracks
161+
which field or fields cause the index to be multikey.
168162

169163
Query on the Array Field as a Whole
170164
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -211,20 +205,6 @@ $expr
211205

212206
:query:`$expr` does not support multikey indexes.
213207

214-
Indexes Built on MongoDB 3.2 or Earlier
215-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
216-
217-
Indexes built on MongoDB 3.2 or earlier do not contain the necessary
218-
flags to support optimized multikey index use. To benefit from the
219-
performance enhancements of multikey indexes, you must either:
220-
221-
- Rebuild the older-format indexes on MongoDB 3.4 or later. See
222-
:method:`db.collection.reIndex()`.
223-
224-
- On a replica set, :doc:`resync the replica set members
225-
</tutorial/resync-replica-set-member/>` containing older-format
226-
indexes.
227-
228208
Examples
229209
--------
230210

source/core/index-sparse.txt

Lines changed: 4 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -23,13 +23,10 @@ field.
2323

2424
.. important::
2525

26-
.. versionchanged:: 3.2
27-
28-
Starting in MongoDB 3.2, MongoDB provides the option to create
29-
:ref:`partial indexes <index-type-partial>`. Partial indexes
30-
offer a superset of the functionality of sparse indexes. If you
31-
are using MongoDB 3.2 or later, :ref:`partial indexes
32-
<index-type-partial>` should be preferred over sparse indexes.
26+
MongoDB provides the option to create
27+
:ref:`partial indexes <index-type-partial>`. Partial indexes
28+
offer a superset of the functionality of sparse indexes.
29+
Partial Indexes should be preferred over sparse indexes.
3330

3431
Create a Sparse Index
3532
---------------------
@@ -70,8 +67,6 @@ sparse index on the ``x`` field unless explicitly hinted. See
7067
:ref:`sparse-index-incomplete-results` for an example that details the
7168
behavior.
7269

73-
.. versionchanged:: 3.4
74-
7570
.. include:: /includes/fact-sparse-index-hint-count.rst
7671

7772
Indexes that are ``sparse`` by Default

source/core/index-text.txt

Lines changed: 4 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -22,33 +22,11 @@ Overview
2222
Versions
2323
--------
2424

25-
.. list-table::
26-
:header-rows: 1
27-
:widths: 30 70
25+
The text index is available in three versions. By default, MongoDB uses
26+
version 3 with new text indexes.
2827

29-
* - ``text`` Index Version
30-
- Description
31-
32-
* - Version 3
33-
34-
- MongoDB introduces a version 3 of the ``text`` index. Version 3
35-
is the default version of ``text`` indexes created in
36-
MongoDB 3.2 and later.
37-
38-
* - Version 2
39-
40-
- MongoDB 2.6 introduces a version 2 of the ``text`` index.
41-
Version 2 is the default version of ``text`` indexes created
42-
in MongoDB 2.6 and 3.0 series.
43-
44-
* - Version 1
45-
46-
- MongoDB 2.4 introduces a version 1 of the ``text`` index.
47-
MongoDB 2.4 can only support version ``1``.
48-
49-
To override the default version and specify a different version,
50-
include the option ``{ "textIndexVersion": <version> }`` when
51-
creating the index.
28+
To override the default and use an older version, use the ``textIndexVersion``
29+
option when you create the index.
5230

5331
.. _create-text-index:
5432

@@ -154,8 +132,6 @@ indexes, see :ref:`Compound Text Indexes <text-index-compound>`.
154132
Case Insensitivity
155133
------------------
156134

157-
.. versionchanged:: 3.2
158-
159135
The version 3 ``text`` index supports the common ``C``, simple ``S``,
160136
and for Turkish languages, the special ``T`` case foldings as specified
161137
in `Unicode 8.0 Character Database Case Folding
@@ -180,8 +156,6 @@ text index treat them as distinct.
180156
Diacritic Insensitivity
181157
-----------------------
182158

183-
.. versionchanged:: 3.2
184-
185159
With version 3, ``text`` index is diacritic insensitive. That is, the
186160
index does not distinguish between characters that contain diacritical
187161
marks and their non-marked counterpart, such as ``é``, ``ê``, and
@@ -202,8 +176,6 @@ diacritics as distinct.
202176
Tokenization Delimiters
203177
-----------------------
204178

205-
.. versionchanged:: 3.2
206-
207179
For tokenization, version 3 ``text`` index uses the delimiters
208180
categorized under ``Dash``, ``Hyphen``, ``Pattern_Syntax``,
209181
``Quotation_Mark``, ``Terminal_Punctuation``, and ``White_Space`` in

source/core/multikey-index-bounds.txt

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -152,14 +152,11 @@ MongoDB can compound the two bounds to use the combined bounds of:
152152
Range Queries on a Scalar Indexed Field (WiredTiger)
153153
````````````````````````````````````````````````````
154154

155-
.. versionchanged:: 3.4
155+
*For the WiredTiger and In-Memory storage engines only*,
156156

157-
*For the WiredTiger and In-Memory storage engines only*,
158-
159-
Starting in MongoDB 3.4, for multikey indexes created using MongoDB
160-
3.4 or later, MongoDB keeps track of which indexed field or fields cause an
161-
index to be a multikey index. Tracking this information allows the
162-
MongoDB query engine to use tighter index bounds.
157+
In multikey index, MongoDB keeps track of which indexed field or fields
158+
cause an index to be a multikey index. Tracking this information allows the
159+
MongoDB query engine to use tighter index bounds.
163160

164161
The aforementioned :ref:`compound index <index-type-compound>` is on
165162
the scalar field [#scalar]_ ``item`` and the array field ``ratings``:
@@ -170,8 +167,7 @@ the scalar field [#scalar]_ ``item`` and the array field ``ratings``:
170167

171168
For the WiredTiger and the In-Memory storage engines, if a query
172169
operation specifies multiple predicates on the indexed scalar field(s)
173-
of a compound multikey index created in MongoDB 3.4 or later, MongoDB
174-
will intersect the bounds for the field.
170+
of a compound multikey index, MongoDB will intersect the bounds for the field.
175171

176172
For example, the following operation specifies a range query on the
177173
scalar field as well as a range query on the array field:

source/core/query-optimization.txt

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Query Optimization
99
.. contents:: On this page
1010
:local:
1111
:backlinks: none
12-
:depth: 1
12+
:depth: 2
1313
:class: singlecol
1414

1515
Indexes improve the efficiency of read operations by reducing the
@@ -126,9 +126,10 @@ For the specified index to cover the query, the projection document
126126
must explicitly specify ``_id: 0`` to exclude the ``_id`` field from
127127
the result since the index does not include the ``_id`` field.
128128

129-
.. versionchanged:: 3.6
130-
An index can cover a query on fields within embedded documents.
131-
[#index-embedded-document-fields]_
129+
Embedded Documents
130+
~~~~~~~~~~~~~~~~~~
131+
132+
An index can cover a query on fields within embedded documents.
132133

133134
For example, consider a collection ``userdata`` with documents of the
134135
following form:
@@ -149,18 +150,17 @@ The ``{ "user.login": 1 }`` index will cover the query below:
149150

150151
db.userdata.find( { "user.login": "tester" }, { "user.login": 1, _id: 0 } )
151152

152-
.. [#index-embedded-document-fields] To index fields
153-
in embedded documents, use :term:`dot notation`.
153+
.. note::
154+
155+
To index fields in embedded documents, use :term:`dot notation`.
154156

155157
.. _multikey-covering:
156158

157159
Multikey Covering
158160
~~~~~~~~~~~~~~~~~
159161

160-
Starting in 3.6, multikey indexes can cover queries over the non-array fields
162+
Multikey indexes can cover queries over the non-array fields
161163
if the index tracks which field or fields cause the index to be multikey.
162-
Multikey indexes created in MongoDB 3.4 or later on storage engines other
163-
than MMAPv1 track this data.
164164

165165
.. include:: /includes/fact-multikey-index-covered-query.rst
166166

Lines changed: 3 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,8 @@
11
ref: _fact-covered-query-sharded-collection
22
content: |
33
4-
.. FYI -- we doc this in the negative since this is included
5-
.. in the limitation/restriction section.
6-
.. We probably could word this in "can only cover ..."
7-
.. to make it more positive.
4+
When run on :program:`mongos`, indexes can only {{cover}} queries on
5+
:term:`sharded <shard>` collections if the index contains
6+
the shard key.
87
9-
Starting in MongoDB 3.0, an index cannot {{cover}} a query on a
10-
:term:`sharded <shard>` collection when run against a
11-
:binary:`~bin.mongos` if the index does not contain the shard key.
12-
13-
In previous versions, an index cannot :ref:`cover <covered-queries>`
14-
a query on a :term:`sharded <shard>` collection when run against a
15-
:binary:`~bin.mongos`.
168
...

0 commit comments

Comments
 (0)