DOCS-533 add notes/warnings to commands which block db / server

Author: Ed Costello

source/includes/warning-blocking-collection.rst

@@ -0,0 +1,5 @@
+.. warning::
+
+   This command obtains a write lock on the affected collection
+   and will block other operations until it has completed.
+

source/includes/warning-blocking-database.rst

@@ -0,0 +1,5 @@
+.. warning::
+
+   This command obtains a write lock on the affected database
+   and will block other operations until it has completed.
+

source/includes/warning-blocking-global.rst

@@ -0,0 +1,5 @@
+.. warning::
+
+   This command obtains a global write lock and will block other
+   operations until it has completed.
+

source/reference/command/clean.txt

@@ -7,5 +7,7 @@ clean (internal)
 .. dbcommand:: clean
 
    :dbcommand:`clean` is an internal command.
+   
+   .. include:: /includes/warning-blocking-database.rst
 
    .. write-lock, slave-ok

source/reference/command/clone.txt

@@ -33,3 +33,7 @@ clone
      allow other operations to complete.
 
    See :dbcommand:`copydb`  for similar functionality.
+
+   .. include:: /includes/warning-blocking-database.rst
+
+.. TODO: does obtain WRITE lock, does this affect solely origination server?

source/reference/command/closeAllDatabases.txt

@@ -9,3 +9,5 @@ closeAllDatabases (internal)
    :dbcommand:`closeAllDatabases` is an internal command that
    invalidates all cursors and closes the open database files. The
    next operation that uses the database will reopen the file.
+
+   .. include:: /includes/warning-blocking-global.rst

source/reference/command/collMod.txt

@@ -36,3 +36,5 @@ collMod
       :collflag:`usePowerOf2Sizes` is useful for collections where you
       will be inserting and deleting large numbers of documents to
       ensure that MongoDB will effectively use space on disk.
+
+   .. include:: /includes/warning-blocking-database.rst

source/reference/command/convertToCapped.txt

@@ -25,3 +25,5 @@ convertToCapped
       the original collection on the new collection. If you need
       indexes on this collection you will need to create these indexes
       after the conversion is complete.
+
+   .. include:: /includes/warning-blocking-operation.rst

source/reference/command/copydbgetnonce.txt

@@ -8,5 +8,7 @@ copydbgetnonce (internal)
 
    Client libraries use :dbcommand:`copydbgetnonce` to get a one-time
    password for use with the :dbcommand:`copydb` command.
+   
+   .. include:: /includes/warning-blocking-operation.rst
 
    .. write-lock, admin-only

source/reference/command/create.txt

@@ -41,3 +41,5 @@ create
 
    The :method:`db.createCollection()` provides a wrapper function that
    provides access to this functionality.
+
+   .. include:: /includes/warning-blocking-database.rst

source/reference/command/diagLogging.txt

@@ -7,5 +7,7 @@ diagLogging (internal)
 .. dbcommand:: diagLogging
 
    :dbcommand:`diagLogging` is an internal command.
+   
+   .. include:: /includes/warning-blocking-database.rst
 
    .. write-lock, slave-ok,

source/reference/command/drop.txt

@@ -22,3 +22,5 @@ drop
 
    Note that this command also removes any indexes associated with the
    dropped collection.
+
+   .. include:: /includes/warning-blocking-database.rst

source/reference/command/dropDatabase.txt

@@ -24,4 +24,6 @@ dropDatabase
 
       db.dropDatabase();
 
+   .. include:: /includes/warning-blocking-global.rst
+
    .. write-lock

source/reference/command/dropIndexes.txt

@@ -6,7 +6,8 @@ dropIndexes
 
 .. dbcommand:: dropIndexes
 
-   The :dbcommand:`dropIndexes` command drops one or all indexes from the current collection.
+   The :dbcommand:`dropIndexes` command drops one or all indexes from 
+   the current collection.
    To drop all indexes, issue the command like so:
 
    .. code-block:: javascript
@@ -26,3 +27,5 @@ dropIndexes
    .. code-block:: javascript
 
       db.collection.dropIndex("age_1");
+
+   .. include:: /includes/warning-blocking-database.rst

source/reference/command/godinsert.txt

@@ -7,5 +7,7 @@ godinsert (internal)
 .. dbcommand:: godinsert
 
    :dbcommand:`godinsert` is an internal command for testing purposes only.
+   
+   .. include:: /includes/warning-blocking-operation.rst
 
    .. write-lock, slave-ok

source/reference/command/handshake.txt

@@ -8,4 +8,4 @@ handshake (internal)
 
    :dbcommand:`handshake` is an internal command.
 
-   .. slave-ok
+   .. slave-ok, no-lock

source/reference/command/profile.txt

@@ -51,3 +51,6 @@ profile
                 shell.
 
    .. include:: /includes/note-disable-profiling-fsynclock.rst
+   
+   .. include:: /includes/warning-blocking-database.rst
+

source/reference/command/recvChunkStart.txt

@@ -8,5 +8,7 @@ recvChunkStart (internal)
 
    :dbcommand:`_recvChunkStart` is an internal command. Do not call
    directly.
+   
+   .. include:: /includes/warning-blocking-operation.rst
 
    .. admin-only, write-lock

source/reference/command/repairDatabase.txt

@@ -40,6 +40,8 @@ repairDatabase
    line and use the :option:`--repairpath <mongod --repairpath>`
    switch to specify the folder in which to store the temporary repair
    files.
+   
+   .. include:: /includes/warning-blocking-global.rst
 
    This command is accessible via a number of different avenues. You
    may:

source/reference/command/resync.txt

@@ -10,5 +10,7 @@ resync
    :program:`mongod` instance to re-synchronize itself. Note
    that this command is relevant to master-slave replication only. It does
    no apply to replica sets.
+   
+   .. include:: /includes/warning-blocking-operation.rst
 
    .. write-lock, slave-ok, admin-only.

source/reference/command/sleep.txt

@@ -7,7 +7,7 @@ sleep (internal)
 .. dbcommand:: sleep
 
    :dbcommand:`sleep` is an internal command for testing purposes. The
-   :dbcommand:`sleep` command forces the db block all operations. It
+   :dbcommand:`sleep` command forces the database to block all operations. It
    takes the following options:
 
    .. code-block:: javascript
@@ -19,3 +19,5 @@ sleep (internal)
    seconds. Without arguments, :dbcommand:`sleep`, causes a "read
    lock" for 100 seconds.
 
+   .. include:: /includes/warning-blocking-operation.rst
+