From 83051ce72acfc1626a73a5d36a365d8ef941c8f3 Mon Sep 17 00:00:00 2001 From: Bob Grabar Date: Wed, 19 Sep 2012 16:03:58 -0400 Subject: [PATCH] DOCS-446 new replica sets command page --- source/reference/commands.txt | 32 +++++----- source/reference/javascript.txt | 49 ++++++++------- source/reference/replica-commands.txt | 86 +++++++++++++++++++++++++++ source/replication.txt | 3 +- 4 files changed, 133 insertions(+), 37 deletions(-) create mode 100644 source/reference/replica-commands.txt diff --git a/source/reference/commands.txt b/source/reference/commands.txt index efcd7af7279..863c6a71ed4 100644 --- a/source/reference/commands.txt +++ b/source/reference/commands.txt @@ -81,8 +81,8 @@ User Commands .. _sharding-commands: -Sharding -~~~~~~~~ +Sharding Commands +~~~~~~~~~~~~~~~~~ .. seealso:: :doc:`/sharding` for more information about MongoDB's sharding functionality. @@ -108,8 +108,8 @@ Sharding .. include:: command/printShardingStatus.txt :start-after: mongodb -Aggregation -~~~~~~~~~~~ +Aggregation Commands +~~~~~~~~~~~~~~~~~~~~ .. include:: command/group.txt :start-after: mongodb @@ -132,8 +132,12 @@ Aggregation .. include:: command/aggregate.txt :start-after: mongodb -Replication -~~~~~~~~~~~ +Replication Commands +~~~~~~~~~~~~~~~~~~~~ + +.. This list of Replica Set Commands also exists in the + replica-commands.txt document. If updated here, it must also be + updated there. We might want to consider an include for the whole list. .. seealso:: ":doc:`/core/replication`" for more information regarding replication. @@ -165,8 +169,8 @@ Geospatial Commands .. include:: command/geoSearch.txt :start-after: mongodb -Collections -~~~~~~~~~~~ +Collection Commands +~~~~~~~~~~~~~~~~~~~ .. include:: command/drop.txt :start-after: mongodb @@ -192,8 +196,8 @@ Collections .. include:: command/collMod.txt :start-after: mongodb -Administration -~~~~~~~~~~~~~~ +Administration Commands +~~~~~~~~~~~~~~~~~~~~~~~ .. include:: command/touch.txt :start-after: mongodb @@ -234,8 +238,8 @@ Administration .. include:: command/getParameter.txt :start-after: mongodb -Diagnostics -~~~~~~~~~~~ +Diagnostic Commands +~~~~~~~~~~~~~~~~~~~ .. include:: command/dbStats.txt :start-after: mongodb @@ -312,8 +316,8 @@ Other Commands .. include:: command/split.txt :start-after: mongodb -Internal Use ------------- +Internal Use Commands +--------------------- .. include:: command/availableQueryOptions.txt :start-after: mongodb diff --git a/source/reference/javascript.txt b/source/reference/javascript.txt index 50b94a08c91..46daaa89b41 100644 --- a/source/reference/javascript.txt +++ b/source/reference/javascript.txt @@ -81,8 +81,8 @@ Call cursor methods on cursors to modify how MongoDB returns objects to the curs .. include:: method/cursor.hint.txt :start-after: mongodb -Data Aggregation -~~~~~~~~~~~~~~~~ +Data Aggregation Methods +~~~~~~~~~~~~~~~~~~~~~~~~ .. include:: method/db.collection.aggregate.txt :start-after: mongodb @@ -96,8 +96,8 @@ Data Aggregation Administrative Functions ------------------------ -Database -~~~~~~~~ +Database Methods +~~~~~~~~~~~~~~~~ .. include:: method/db.addUser.txt :start-after: mongodb @@ -213,8 +213,8 @@ Database .. include:: method/db.fsyncUnlock.txt :start-after: mongodb -Collection -~~~~~~~~~~ +Collection Methods +~~~~~~~~~~~~~~~~~~ These methods operate on collection objects. Also consider the ":ref:`js-query-and-update-methods`" and @@ -278,8 +278,8 @@ that you may use with collection objects. .. include:: method/db.collection.stats.txt :start-after: mongodb -Sharding -~~~~~~~~ +Sharding Methods +~~~~~~~~~~~~~~~~ .. seealso:: The ":doc:`/core/sharding`" page for more information on the sharding technology and methods for creating :term:`shard @@ -326,10 +326,15 @@ Sharding .. _replica-set-functions: -Replica Sets -~~~~~~~~~~~~ +Replica Set Methods +~~~~~~~~~~~~~~~~~~~ + +.. This list of Replica Set Methods also exists in the + replica-commands.txt document. If updated here, it also must be + updated there, and vice versa. We might want to consider an include + for the whole list. -.. seealso:: ":doc:`/core/replication`" for more information regarding +.. seealso:: :doc:`/core/replication` for more information regarding replication. .. include:: method/rs.status.txt @@ -371,10 +376,10 @@ Replica Sets .. include:: method/rs.syncFrom.txt :start-after: mongodb -Native Shell Functions ----------------------- +Native Shell Methods +-------------------- -These functions provide a number of low level and internal functions +These methods provide a number of low level and internal functions that may be useful in the context of some advanced operations in the shell. The JavaScript standard library is accessible in the :program:`mongo` shell. @@ -427,8 +432,8 @@ shell. The JavaScript standard library is accessible in the Non-User Functions and Methods ------------------------------ -Deprecated -~~~~~~~~~~ +Deprecated Methods +~~~~~~~~~~~~~~~~~~ .. include:: method/db.getPrevError.txt :start-after: mongodb @@ -436,8 +441,8 @@ Deprecated .. include:: method/db.resetError.txt :start-after: mongodb -Native Functions -~~~~~~~~~~~~~~~~ +Native Methods +~~~~~~~~~~~~~~ .. include:: method/srand.txt :start-after: mongodb @@ -448,11 +453,11 @@ Native Functions .. include:: method/isWindows.txt :start-after: mongodb -Internal Functions -~~~~~~~~~~~~~~~~~~ +Internal Methods +~~~~~~~~~~~~~~~~ -These functions are accessible in the shell but exist to support other -functionality in the environment. Do not call these functions +These methods are accessible in the shell but exist to support other +functionality in the environment. Do not call these methods directly. .. include:: method/startMongoProgram.txt diff --git a/source/reference/replica-commands.txt b/source/reference/replica-commands.txt new file mode 100644 index 00000000000..afcfef7d0cb --- /dev/null +++ b/source/reference/replica-commands.txt @@ -0,0 +1,86 @@ +==================== +Replica Set Commands +==================== + +.. default-domain:: mongodb + +This reference describes the JavaScript methods and the database commands that +can be used on replica sets. + +For a list of all replica set documentation, see :doc:`/replication`. + +JavaScript Methods +------------------ + +.. This list of methods also exists in the javascript.txt document. If + updated here, it also must be updated there. We might want to + consider an include for the whole list. + +The following methods apply to replica sets. For a complete list of all +methods, see :doc:`/reference/method`. + +.. include:: method/rs.status.txt + :start-after: mongodb + +.. include:: method/rs.initiate.txt + :start-after: mongodb + +.. include:: method/rs.conf.txt + :start-after: mongodb + +.. include:: method/rs.reconfig.txt + :start-after: mongodb + +.. include:: method/rs.add.txt + :start-after: mongodb + +.. include:: method/rs.addArb.txt + :start-after: mongodb + +.. include:: method/rs.stepDown.txt + :start-after: mongodb + +.. include:: method/rs.freeze.txt + :start-after: mongodb + +.. include:: method/rs.remove.txt + :start-after: mongodb + +.. include:: method/rs.slaveOk.txt + :start-after: mongodb + +.. include:: method/db.isMaster.txt + :start-after: mongodb + +.. include:: method/rs.help.txt + :start-after: mongodb + +.. include:: method/rs.syncFrom.txt + :start-after: mongodb + +Database Commands +----------------- + +.. This list of commands also exists in the commands.txt document. If + updated here, it also must be updated there. + +The following commands apply to replica sets. For a complete list of all +commands, see :doc:`/reference/commands`. + +.. include:: command/resync.txt + :start-after: mongodb + +.. include:: command/replSetFreeze.txt + :start-after: mongodb + +.. include:: command/replSetGetStatus.txt + :start-after: mongodb + +.. include:: command/replSetInitiate.txt + :start-after: mongodb + +.. include:: command/replSetReconfig.txt + :start-after: mongodb + +.. include:: command/replSetSyncFrom.txt + :start-after: mongodb diff --git a/source/replication.txt b/source/replication.txt index e4b33043c5e..e065a67fc90 100644 --- a/source/replication.txt +++ b/source/replication.txt @@ -58,10 +58,11 @@ The following describes the replica set configuration object: - :doc:`/reference/replica-configuration` -The following describe status commands: +The following describe replica set commands: - :doc:`/reference/replica-status` - :doc:`/reference/replication-info` +- :doc:`/reference/replica-commands` .. _replica-set-data-center-awareness: