Skip to content

Commit 83051ce

Browse files
author
Bob Grabar
committed
DOCS-446 new replica sets command page
1 parent 67ee40d commit 83051ce

File tree

4 files changed

+133
-37
lines changed

4 files changed

+133
-37
lines changed

source/reference/commands.txt

Lines changed: 18 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -81,8 +81,8 @@ User Commands
8181

8282
.. _sharding-commands:
8383

84-
Sharding
85-
~~~~~~~~
84+
Sharding Commands
85+
~~~~~~~~~~~~~~~~~
8686

8787
.. seealso:: :doc:`/sharding` for more information about MongoDB's
8888
sharding functionality.
@@ -108,8 +108,8 @@ Sharding
108108
.. include:: command/printShardingStatus.txt
109109
:start-after: mongodb
110110

111-
Aggregation
112-
~~~~~~~~~~~
111+
Aggregation Commands
112+
~~~~~~~~~~~~~~~~~~~~
113113

114114
.. include:: command/group.txt
115115
:start-after: mongodb
@@ -132,8 +132,12 @@ Aggregation
132132
.. include:: command/aggregate.txt
133133
:start-after: mongodb
134134

135-
Replication
136-
~~~~~~~~~~~
135+
Replication Commands
136+
~~~~~~~~~~~~~~~~~~~~
137+
138+
.. This list of Replica Set Commands also exists in the
139+
replica-commands.txt document. If updated here, it must also be
140+
updated there. We might want to consider an include for the whole list.
137141

138142
.. seealso:: ":doc:`/core/replication`" for more information regarding
139143
replication.
@@ -165,8 +169,8 @@ Geospatial Commands
165169
.. include:: command/geoSearch.txt
166170
:start-after: mongodb
167171

168-
Collections
169-
~~~~~~~~~~~
172+
Collection Commands
173+
~~~~~~~~~~~~~~~~~~~
170174

171175
.. include:: command/drop.txt
172176
:start-after: mongodb
@@ -192,8 +196,8 @@ Collections
192196
.. include:: command/collMod.txt
193197
:start-after: mongodb
194198

195-
Administration
196-
~~~~~~~~~~~~~~
199+
Administration Commands
200+
~~~~~~~~~~~~~~~~~~~~~~~
197201

198202
.. include:: command/touch.txt
199203
:start-after: mongodb
@@ -234,8 +238,8 @@ Administration
234238
.. include:: command/getParameter.txt
235239
:start-after: mongodb
236240

237-
Diagnostics
238-
~~~~~~~~~~~
241+
Diagnostic Commands
242+
~~~~~~~~~~~~~~~~~~~
239243

240244
.. include:: command/dbStats.txt
241245
:start-after: mongodb
@@ -312,8 +316,8 @@ Other Commands
312316
.. include:: command/split.txt
313317
:start-after: mongodb
314318

315-
Internal Use
316-
------------
319+
Internal Use Commands
320+
---------------------
317321

318322
.. include:: command/availableQueryOptions.txt
319323
:start-after: mongodb

source/reference/javascript.txt

Lines changed: 27 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -81,8 +81,8 @@ Call cursor methods on cursors to modify how MongoDB returns objects to the curs
8181
.. include:: method/cursor.hint.txt
8282
:start-after: mongodb
8383

84-
Data Aggregation
85-
~~~~~~~~~~~~~~~~
84+
Data Aggregation Methods
85+
~~~~~~~~~~~~~~~~~~~~~~~~
8686

8787
.. include:: method/db.collection.aggregate.txt
8888
:start-after: mongodb
@@ -96,8 +96,8 @@ Data Aggregation
9696
Administrative Functions
9797
------------------------
9898

99-
Database
100-
~~~~~~~~
99+
Database Methods
100+
~~~~~~~~~~~~~~~~
101101

102102
.. include:: method/db.addUser.txt
103103
:start-after: mongodb
@@ -213,8 +213,8 @@ Database
213213
.. include:: method/db.fsyncUnlock.txt
214214
:start-after: mongodb
215215

216-
Collection
217-
~~~~~~~~~~
216+
Collection Methods
217+
~~~~~~~~~~~~~~~~~~
218218

219219
These methods operate on collection objects. Also consider the
220220
":ref:`js-query-and-update-methods`" and
@@ -278,8 +278,8 @@ that you may use with collection objects.
278278
.. include:: method/db.collection.stats.txt
279279
:start-after: mongodb
280280

281-
Sharding
282-
~~~~~~~~
281+
Sharding Methods
282+
~~~~~~~~~~~~~~~~
283283

284284
.. seealso:: The ":doc:`/core/sharding`" page for more information on
285285
the sharding technology and methods for creating :term:`shard
@@ -326,10 +326,15 @@ Sharding
326326

327327
.. _replica-set-functions:
328328

329-
Replica Sets
330-
~~~~~~~~~~~~
329+
Replica Set Methods
330+
~~~~~~~~~~~~~~~~~~~
331+
332+
.. This list of Replica Set Methods also exists in the
333+
replica-commands.txt document. If updated here, it also must be
334+
updated there, and vice versa. We might want to consider an include
335+
for the whole list.
331336

332-
.. seealso:: ":doc:`/core/replication`" for more information regarding
337+
.. seealso:: :doc:`/core/replication` for more information regarding
333338
replication.
334339

335340
.. include:: method/rs.status.txt
@@ -371,10 +376,10 @@ Replica Sets
371376
.. include:: method/rs.syncFrom.txt
372377
:start-after: mongodb
373378

374-
Native Shell Functions
375-
----------------------
379+
Native Shell Methods
380+
--------------------
376381

377-
These functions provide a number of low level and internal functions
382+
These methods provide a number of low level and internal functions
378383
that may be useful in the context of some advanced operations in the
379384
shell. The JavaScript standard library is accessible in the
380385
:program:`mongo` shell.
@@ -427,17 +432,17 @@ shell. The JavaScript standard library is accessible in the
427432
Non-User Functions and Methods
428433
------------------------------
429434

430-
Deprecated
431-
~~~~~~~~~~
435+
Deprecated Methods
436+
~~~~~~~~~~~~~~~~~~
432437

433438
.. include:: method/db.getPrevError.txt
434439
:start-after: mongodb
435440

436441
.. include:: method/db.resetError.txt
437442
:start-after: mongodb
438443

439-
Native Functions
440-
~~~~~~~~~~~~~~~~
444+
Native Methods
445+
~~~~~~~~~~~~~~
441446

442447
.. include:: method/srand.txt
443448
:start-after: mongodb
@@ -448,11 +453,11 @@ Native Functions
448453
.. include:: method/isWindows.txt
449454
:start-after: mongodb
450455

451-
Internal Functions
452-
~~~~~~~~~~~~~~~~~~
456+
Internal Methods
457+
~~~~~~~~~~~~~~~~
453458

454-
These functions are accessible in the shell but exist to support other
455-
functionality in the environment. Do not call these functions
459+
These methods are accessible in the shell but exist to support other
460+
functionality in the environment. Do not call these methods
456461
directly.
457462

458463
.. include:: method/startMongoProgram.txt

source/reference/replica-commands.txt

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
====================
2+
Replica Set Commands
3+
====================
4+
5+
.. default-domain:: mongodb
6+
7+
This reference describes the JavaScript methods and the database commands that
8+
can be used on replica sets.
9+
10+
For a list of all replica set documentation, see :doc:`/replication`.
11+
12+
JavaScript Methods
13+
------------------
14+
15+
.. This list of methods also exists in the javascript.txt document. If
16+
updated here, it also must be updated there. We might want to
17+
consider an include for the whole list.
18+
19+
The following methods apply to replica sets. For a complete list of all
20+
methods, see :doc:`/reference/method`.
21+
22+
.. include:: method/rs.status.txt
23+
:start-after: mongodb
24+
25+
.. include:: method/rs.initiate.txt
26+
:start-after: mongodb
27+
28+
.. include:: method/rs.conf.txt
29+
:start-after: mongodb
30+
31+
.. include:: method/rs.reconfig.txt
32+
:start-after: mongodb
33+
34+
.. include:: method/rs.add.txt
35+
:start-after: mongodb
36+
37+
.. include:: method/rs.addArb.txt
38+
:start-after: mongodb
39+
40+
.. include:: method/rs.stepDown.txt
41+
:start-after: mongodb
42+
43+
.. include:: method/rs.freeze.txt
44+
:start-after: mongodb
45+
46+
.. include:: method/rs.remove.txt
47+
:start-after: mongodb
48+
49+
.. include:: method/rs.slaveOk.txt
50+
:start-after: mongodb
51+
52+
.. include:: method/db.isMaster.txt
53+
:start-after: mongodb
54+
55+
.. include:: method/rs.help.txt
56+
:start-after: mongodb
57+
58+
.. include:: method/rs.syncFrom.txt
59+
:start-after: mongodb
60+
61+
Database Commands
62+
-----------------
63+
64+
.. This list of commands also exists in the commands.txt document. If
65+
updated here, it also must be updated there.
66+
67+
The following commands apply to replica sets. For a complete list of all
68+
commands, see :doc:`/reference/commands`.
69+
70+
.. include:: command/resync.txt
71+
:start-after: mongodb
72+
73+
.. include:: command/replSetFreeze.txt
74+
:start-after: mongodb
75+
76+
.. include:: command/replSetGetStatus.txt
77+
:start-after: mongodb
78+
79+
.. include:: command/replSetInitiate.txt
80+
:start-after: mongodb
81+
82+
.. include:: command/replSetReconfig.txt
83+
:start-after: mongodb
84+
85+
.. include:: command/replSetSyncFrom.txt
86+
:start-after: mongodb

source/replication.txt

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,10 +58,11 @@ The following describes the replica set configuration object:
5858

5959
- :doc:`/reference/replica-configuration`
6060

61-
The following describe status commands:
61+
The following describe replica set commands:
6262

6363
- :doc:`/reference/replica-status`
6464
- :doc:`/reference/replication-info`
65+
- :doc:`/reference/replica-commands`
6566

6667
.. _replica-set-data-center-awareness:
6768

0 commit comments

Comments
 (0)