Skip to content

Commit a444e31

Browse files
authored
DOCSP-21337 Clarify Sharding TSC (#847) (#864)
* DOCSP-21337 Add step to confirm sharding is enabled * tweaks * tweaks * tweaks
1 parent e6535db commit a444e31

File tree

2 files changed

+53
-2
lines changed

2 files changed

+53
-2
lines changed

source/includes/steps-shard-existing-tsc.yaml

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,34 @@ content: |
1111
1212
mongosh --host <hostname> --port <port>
1313
---
14+
title: Confirm that sharding is enabled on your database.
15+
ref: new-sharded-tsc-confirm-sharding
16+
stepnum: 2
17+
level: 4
18+
content: |
19+
Run :method:`sh.status()` to confirm that sharding is enabled on your database:
20+
21+
.. code-block:: javascript
22+
23+
sh.status()
24+
25+
The command returns the sharding information:
26+
27+
.. code-block:: javascript
28+
29+
--- Sharding Status ---
30+
sharding version: {
31+
"_id" : 1,
32+
"minCompatibleVersion" : 5,
33+
"currentVersion" : 6,
34+
...
35+
36+
If ``sh.status()`` returns ``This db does not have sharding enabled.``,
37+
:ref:`enable sharding <sharding-setup-enable-sharding>`.
38+
---
1439
title: Shard the collection.
1540
ref: new-sharded-tsc-create
16-
stepnum: 2
41+
stepnum: 3
1742
level: 4
1843
content: |
1944
Use the :method:`~sh.shardCollection()` method to shard the

source/includes/steps-shard-new-tsc.yaml

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,36 @@ content: |
1010
.. code-block:: javascript
1111
1212
mongosh --host <hostname> --port <port>
13+
14+
---
15+
title: Confirm that sharding is enabled on your database.
16+
ref: new-sharded-tsc-confirm-sharding
17+
stepnum: 2
18+
level: 4
19+
content: |
20+
Run :method:`sh.status()` to confirm that sharding is enabled on your database:
21+
22+
.. code-block:: javascript
23+
24+
sh.status()
25+
26+
The command returns the sharding information:
27+
28+
.. code-block:: javascript
29+
30+
--- Sharding Status ---
31+
sharding version: {
32+
"_id" : 1,
33+
"minCompatibleVersion" : 5,
34+
"currentVersion" : 6,
35+
...
36+
37+
If ``sh.status()`` returns ``This db does not have sharding enabled.``,
38+
:ref:`enable sharding <sharding-setup-enable-sharding>`.
1339
---
1440
title: Create the collection.
1541
ref: new-sharded-tsc-create
16-
stepnum: 2
42+
stepnum: 3
1743
level: 4
1844
content: |
1945
Use the :method:`~sh.shardCollection()` method with the :ref:`timeseries

0 commit comments

Comments
 (0)