-
Notifications
You must be signed in to change notification settings - Fork 1.7k
/
index-multikey.txt
319 lines (221 loc) · 9.35 KB
/
index-multikey.txt
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
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
.. index:: index; multikey
.. _index-type-multi-key:
.. _index-type-multikey:
================
Multikey Indexes
================
.. default-domain:: mongodb
.. contents:: On this page
:local:
:backlinks: none
:depth: 1
:class: singlecol
To index a field that holds an array value, MongoDB creates an index
key for each element in the array. These *multikey* indexes support
efficient queries against array fields. Multikey indexes can be
constructed over arrays that hold both scalar values [#scalar]_ (e.g. strings,
numbers) *and* nested documents.
.. include:: /images/index-multikey.rst
.. [#scalar]
A scalar value refers to value that is neither an embedded document
nor an array.
Create Multikey Index
---------------------
To create a multikey index, use the
:method:`db.collection.createIndex()` method:
.. code-block:: javascript
db.coll.createIndex( { <field>: < 1 or -1 > } )
MongoDB automatically creates a multikey index if any indexed field is
an array; you do not need to explicitly specify the multikey type.
.. versionchanged:: 3.4
*For the WiredTiger and In-Memory storage engines only*,
Starting in MongoDB 3.4, for multikey indexes created using MongoDB
3.4 or later, MongoDB keeps track of which indexed field or fields
cause an index to be a multikey index. Tracking this information
allows the MongoDB query engine to use tighter index bounds.
Index Bounds
------------
If an index is multikey, then computation of the index bounds follows
special rules. For details on multikey index bounds, see
:doc:`/core/multikey-index-bounds`.
Unique Multikey Index
---------------------
For :doc:`unique </core/index-unique>` indexes, the unique constraint
applies across separate documents in the collection rather than within
a single document.
Because the unique constraint applies to separate documents, for a
:ref:`unique multikey index <unique-separate-documents>`, a document
may have array elements that result in repeating index key values as
long as the index key values for that document do not duplicate those
of another document.
For more information, see :ref:`unique-separate-documents`.
Limitations
-----------
Compound Multikey Indexes
~~~~~~~~~~~~~~~~~~~~~~~~~
For a :ref:`compound <index-type-compound>` multikey index, each
indexed document can have *at most* one indexed field whose value is an
array. That is:
- You cannot create a compound multikey index if more than one
to-be-indexed field of a document is an array. For example, consider
a collection that contains the following document:
.. code-block:: javascript
{ _id: 1, a: [ 1, 2 ], b: [ 1, 2 ], category: "AB - both arrays" }
You cannot create a compound multikey index ``{ a: 1, b: 1 }`` on the
collection since both the ``a`` and ``b`` fields are arrays.
- Or, if a compound multikey index already exists, you cannot insert a
document that would violate this restriction.
Consider a collection that contains the following documents:
.. code-block:: javascript
{ _id: 1, a: [1, 2], b: 1, category: "A array" }
{ _id: 2, a: 1, b: [1, 2], category: "B array" }
A compound multikey index ``{ a: 1, b: 1 }`` is permissible since for
each document, only one field indexed by the compound multikey index
is an array; i.e. no document contains array values for both ``a``
and ``b`` fields.
However, after creating the compound multikey index, if you attempt
to insert a document where both ``a`` and ``b`` fields are arrays,
MongoDB will fail the insert.
If a field is an array of documents, you can index the embedded fields
to create a compound index. For example, consider a collection
that contains the following documents:
.. code-block:: javascript
{ _id: 1, a: [ { x: 5, z: [ 1, 2 ] }, { z: [ 1, 2 ] } ] }
{ _id: 2, a: [ { x: 5 }, { z: 4 } ] }
You can create a compound index on ``{ "a.x": 1, "a.z": 1 }``. The
restriction where *at most* one indexed field can be an array also
applies.
For an example, see :ref:`multikey-embedded-documents`.
.. seealso::
- :ref:`unique-separate-documents`
- :ref:`index-unique-index`
Shard Keys
~~~~~~~~~~
You **cannot** specify a multikey index as the shard key index.
However, if the shard key index is a :ref:`prefix
<compound-index-prefix>` of a compound index, the compound index is
allowed to become a compound *multikey* index if one of the other keys
(i.e. keys that are not part of the shard key) indexes an array.
Compound multikey indexes can have an impact on performance.
Hashed Indexes
~~~~~~~~~~~~~~
:doc:`Hashed </core/index-hashed>` indexes **cannot** be multikey.
Covered Queries
~~~~~~~~~~~~~~~
.. include:: /includes/fact-multikey-index-covered-query.rst
Query on the Array Field as a Whole
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
When a query filter specifies an :ref:`exact match for an array as a
whole <array-match-exact>`, MongoDB can use the multikey index to look
up the first element of the query array but cannot use the multikey
index scan to find the whole array. Instead, after using the multikey
index to look up the first element of the query array, MongoDB
retrieves the associated documents and filters for documents whose
array matches the array in the query.
For example, consider an ``inventory`` collection that contains the
following documents:
.. code-block:: javascript
{ _id: 5, type: "food", item: "aaa", ratings: [ 5, 8, 9 ] }
{ _id: 6, type: "food", item: "bbb", ratings: [ 5, 9 ] }
{ _id: 7, type: "food", item: "ccc", ratings: [ 9, 5, 8 ] }
{ _id: 8, type: "food", item: "ddd", ratings: [ 9, 5 ] }
{ _id: 9, type: "food", item: "eee", ratings: [ 5, 9, 5 ] }
The collection has a multikey index on the ``ratings`` field:
.. code-block:: javascript
db.inventory.createIndex( { ratings: 1 } )
The following query looks for documents where the ``ratings`` field is
the array ``[ 5, 9 ]``:
.. code-block:: javascript
db.inventory.find( { ratings: [ 5, 9 ] } )
MongoDB can use the multikey index to find documents that have ``5`` at
any position in the ``ratings`` array. Then, MongoDB retrieves these
documents and filters for documents whose ``ratings`` array equals the
query array ``[ 5, 9 ]``.
Index Format for Previous MongoDB Versions
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Indexes built on MongoDB 3.2 or earlier do not contain the necessary
flags to support optimized multikey index use. To benefit from the
performance enhancements of multikey indexes, you must either:
- Rebuild the older-format indexes on MongoDB 3.4 or later. See
:method:`db.collection.reIndex()`.
- On a replica set, :doc:`resync the replica set members
</tutorial/resync-replica-set-member/>` containing older-format
indexes.
Examples
--------
Index Basic Arrays
~~~~~~~~~~~~~~~~~~
Consider a ``survey`` collection with the following document:
.. code-block:: javascript
{ _id: 1, item: "ABC", ratings: [ 2, 5, 9 ] }
Create an index on the field ``ratings``:
.. code-block:: javascript
db.survey.createIndex( { ratings: 1 } )
Since the ``ratings`` field contains an array, the index on ``ratings``
is multikey. The multikey index contains the following three index
keys, each pointing to the same document:
- ``2``,
- ``5``, and
- ``9``.
.. _multikey-embedded-documents:
Index Arrays with Embedded Documents
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
You can create multikey indexes on array fields that contain nested
objects.
Consider an ``inventory`` collection with documents of the following
form:
.. code-block:: javascript
{
_id: 1,
item: "abc",
stock: [
{ size: "S", color: "red", quantity: 25 },
{ size: "S", color: "blue", quantity: 10 },
{ size: "M", color: "blue", quantity: 50 }
]
}
{
_id: 2,
item: "def",
stock: [
{ size: "S", color: "blue", quantity: 20 },
{ size: "M", color: "blue", quantity: 5 },
{ size: "M", color: "black", quantity: 10 },
{ size: "L", color: "red", quantity: 2 }
]
}
{
_id: 3,
item: "ijk",
stock: [
{ size: "M", color: "blue", quantity: 15 },
{ size: "L", color: "blue", quantity: 100 },
{ size: "L", color: "red", quantity: 25 }
]
}
...
The following operation creates a multikey index on the ``stock.size``
and ``stock.quantity`` fields:
.. code-block:: javascript
db.inventory.createIndex( { "stock.size": 1, "stock.quantity": 1 } )
The compound multikey index can support queries with predicates that
include both indexed fields as well as predicates that include only the
index prefix ``"stock.size"``, as in the following examples:
.. code-block:: javascript
db.inventory.find( { "stock.size": "M" } )
db.inventory.find( { "stock.size": "S", "stock.quantity": { $gt: 20 } } )
For details on how MongoDB can combine multikey index bounds, see
:doc:`/core/multikey-index-bounds`. For more information on behavior of
compound indexes and prefixes, see :ref:`compound indexes and prefixes
<compound-index-prefix>`.
The compound multikey index can also support sort operations, such as
the following examples:
.. code-block:: javascript
db.inventory.find( ).sort( { "stock.size": 1, "stock.quantity": 1 } )
db.inventory.find( { "stock.size": "M" } ).sort( { "stock.quantity": 1 } )
For more information on behavior of compound indexes and sort
operations, see :doc:`/tutorial/sort-results-with-indexes`.
.. class:: hidden
.. toctree::
:titlesonly:
/core/multikey-index-bounds