Skip to content

Commit af19821

Browse files
(DOCSP-5918): Support for wildcard indexes (#153)
* (DOCSP-5918): Support for wildcard indexes * Updates per Melissa's comments
1 parent 930e27d commit af19821

File tree

2 files changed

+46
-8
lines changed

2 files changed

+46
-8
lines changed

conf.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -136,6 +136,7 @@
136136
'source': ('https://github.com/mongodb/mongo/blob/master/%s', ''),
137137
'docsgithub' : ( 'http://github.com/mongodb/docs/blob/' + conf.git.branches.current + '/%s', ''),
138138
'manual': ('http://docs.mongodb.org/manual%s', ''),
139+
'manual-next': ('http://docs.mongodb.org/master%s', ''),
139140
'bic': ('https://docs.mongodb.com/bi-connector/current%s',''),
140141
'product': ('http://www.mongodb.com/products/%s?jmp=docs',''),
141142
'dl': ('http://www.mongodb.com/download-center/%s?jmp=docs',''),

source/includes/steps-create-index.yaml

Lines changed: 45 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ title: Add fields to index.
1717
level: 4
1818
ref: index-fields
1919
content: |
20-
To specify a key for the index, select the field and the index type
20+
To specify a key for the index, select the field and the index type.
2121
To index additional fields, click :guilabel:`Add Another Field`.
2222
---
2323
title: Optional. Specify the index options.
@@ -27,18 +27,55 @@ content: |
2727
2828
|compass-short| supports the following index options:
2929
30-
* `Build the index in the background <https://docs.mongodb.com/master/core/index-creation/index.html#background-construction>`_
30+
.. list-table::
31+
:header-rows: 1
32+
:widths: 40 60 20
3133
32-
* :manual:`Create a unique index </core/index-unique>`
34+
* - Option
35+
- Description
36+
- More Information
3337
34-
* :manual:`Create a TTL Index </core/index-ttl>`
38+
* - Build index in the background
3539
36-
* :manual:`Create a partial index </core/index-partial/>`
40+
- If checked, ensure that the MongoDB deployment remains
41+
available during the index build operation.
3742
38-
* `Use custom collation <https://docs.mongodb.com/manual/indexes/index.html#indexes-and-collation>`_
43+
- :manual:`Background Construction </core/index-creation/index.html#background-construction>`
3944
40-
For information on the Custom Collation settings, see :manual:`Collation Document </reference/collation/#collation-document>`
41-
in the MongoDB manual.
45+
* - Create unique index
46+
47+
- If checked, ensure that the indexed fields do not
48+
store duplicate values.
49+
50+
- :manual:`Unique Indexes </core/index-unique>`
51+
52+
* - Create :abbr:`TTL (Time to Live)`
53+
54+
- If checked, automatically delete documents after a
55+
specified number of seconds since the indexed field value.
56+
57+
- :manual:`TTL Indexes </core/index-ttl>`
58+
59+
* - Partial filter expression
60+
61+
- If checked, only index documents which match the specified
62+
filter expression.
63+
64+
- :manual:`Partial Indexes </core/index-partial/>`
65+
66+
* - Use custom collation
67+
68+
- If checked, create a custom collation for the index
69+
using the options provided in |compass-short|.
70+
71+
- :manual:`Collation Document </reference/collation/#collation-document>`
72+
73+
* - Wildcard projection (*New in MongoDB 4.2*)
74+
75+
- If checked, support unknown or arbitrary fields
76+
which match the specified projection in the index.
77+
78+
- :manual-next:`Wildcard Indexes </core/index-wildcard/>`
4279
---
4380
title: Click :guilabel:`Create` to create the index.
4481
level: 4

0 commit comments

Comments
 (0)