Skip to content

Commit 3fd8608

Browse files
jason-price-mongodbjason-price-mongodb
and
jason-price-mongodb
authored
DOCSP-33515-shard-key-updates (#5886) (#5958)
* DOCSP-33515-shard-key-updates * DOCSP-33515-shard-key-updates * DOCSP-33515-shard-key-updates * DOCSP-33515-shard-key-updates * DOCSP-33515-shard-key-updates * DOCSP-33515-shard-key-updates * DOCSP-33515-shard-key-updates * DOCSP-33515-shard-key-updates --------- Co-authored-by: jason-price-mongodb <[email protected]>
1 parent 45c042b commit 3fd8608

File tree

3 files changed

+14
-4
lines changed

3 files changed

+14
-4
lines changed

source/includes/analyzeShardKey-supporting-indexes.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,3 +34,6 @@ index requirements:
3434
- Index is not :ref:`multi-key <index-type-multikey>`
3535
- Index is not :ref:`sparse <index-type-sparse>`
3636
- Index is not :ref:`partial <index-type-partial>`
37+
38+
To create supporting indexes, use the
39+
:method:`db.collection.createIndex()` method.

source/includes/cqa-queryAnalysisSampleExpirationSecs.rst

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,7 @@ queryAnalysisSampleExpirationSecs
22
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
33

44
Sampled queries are stored in an internal collection that has a TTL
5-
index with ``expireAfterSeconds``. Configure ``expireAfterSeconds``
6-
with the ``queryAnalysisSampleExpirationSecs`` server parameter.
7-
with the :parameter:`queryAnalysisSampleExpirationSecs`.
5+
index with ``expireAfterSeconds``. To configure ``expireAfterSeconds``,
6+
use the :parameter:`queryAnalysisSampleExpirationSecs` server parameter.
87
Sampled queries are automatically deleted after
98
``queryAnalysisSampleExpirationSecs``.

source/reference/command/analyzeShardKey.txt

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ Limitations
101101
Access Control
102102
--------------
103103

104-
|analyzeShardKey| requires one of the following roles:
104+
|analyzeShardKey| requires one of these roles:
105105

106106
- :authaction:`enableSharding` privilege action against the collection
107107
being analyzed.
@@ -145,6 +145,14 @@ Examples
145145

146146
.. include:: /includes/analyzeShardKey-example-intro.rst
147147

148+
.. note::
149+
150+
Before you run ``analyzeShardKey`` commands, read the
151+
:ref:`supporting-indexes-ref` section earlier on this page. If you
152+
require supporting indexes for the shard key you are analyzing, use
153+
the :method:`db.collection.createIndex()` method to create the
154+
indexes.
155+
148156
{ lastName: 1 } keyCharacteristics
149157
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
150158

0 commit comments

Comments
 (0)