Add back dropCollection to the Persistor.

Add documentation for count, getCollections, DropCollection, and CollectionStats.

Fixed a couple of typos.

Added tests for drop collections combined with getCollections, and also a test for CollectionStats

Author: Mark Spritzler

.gitignore

@@ -4,6 +4,7 @@
 .idea
 .project
 .settings
+*.iml
 module.iml
 bin
 build

README.md

@@ -1,6 +1,9 @@
 # MongoDB Persistor
 
-This module allows data to be saved, retrieved, searched for, and deleted in a MongoDB instance. MongoDB is a great match for persisting vert.x data since it natively handles JSON (BSON) documents. To use this module you must have a MongoDB instance running on your network.
+This module allows data to be saved, retrieved, searched for, and deleted in a MongoDB instance. MongoDB is a great match
+for persisting vert.x data since it natively handles JSON (BSON) documents.
+
+####To use this module you must have a MongoDB instance running on your network.
 
 This is a multi-threaded worker module.
 
@@ -84,7 +87,7 @@ When the save complete successfully, a reply message is sent back to the sender
         "status": "ok"
     }
 
-The reply will also contain a field `_id` if the document that was saved didn't specifiy an id, this will be an automatically generated UUID, for example:
+The reply will also contain a field `_id` if the document that was saved didn't specify an id, this will be an automatically generated UUID, for example:
 
     {
         "status": "ok"
@@ -100,7 +103,8 @@ If an error occurs in saving the document a reply is returned:
         "message": <message>
     }
 
-Where `message` is an error message.    
+Where
+* `message` is an error message.
 
 
 ### Update
@@ -168,7 +172,7 @@ To find documents send a JSON message to the module main address:
 
 Where:
 * `collection` is the name of the MongoDB collection that you wish to search in in. This field is mandatory.
-* `matcher` is a JSON object that you want to match against to find matching documents. This obeys the normal MongoDB matching rues.
+* `matcher` is a JSON object that you want to match against to find matching documents. This obeys the normal MongoDB matching rules.
 * `sort_query` provides an order for sorting the responses that you are returned.
 * `keys` is an optional JSON object that contains the fields that should be returned for matched documents. See MongoDB manual for more information. Example: { "name": 1 } will only return objects with _id and the name field
 * `skip` is a number which determines the number of documents to skip. This is optional. By default no documents are skipped.
@@ -194,7 +198,8 @@ When the find complete successfully, a reply message is sent back to the sender
         "results": <results>
     }   
 
-Where `results` is a JSON array containing the results of the find operation. For example:
+Where
+*`results` is a JSON array containing the results of the find operation. For example:
 
     {
         "status": "ok",
@@ -224,7 +229,8 @@ If an error occurs in finding the documents a reply is returned:
         "message": <message>
     }
 
-Where `message` is an error message.
+Where
+*`message` is an error message.
 
 If you would like to paginate your result :
 
@@ -243,26 +249,6 @@ Equivalence in mongoDB:
 
 db.order.find().skip(10).limit(10)
 
-### Count
-
-Count all matching document in the database.
-
-To count a document send a JSON message to the module main address:
-
-    {
-        "action": "count",
-        "collection": <collection>,
-        "matcher": <matcher>
-    }
-
-When the count complete successfully, a reply message is sent back to the sender with the following data:
-
-    {
-         "status": "ok",
-         "count" : <number>
-    }
-
-
 #### Batching
 
 If a find returns many documents we do not want to load them all up into memory at once and send them in a single JSON message since this could result in the server running out of RAM.
@@ -315,7 +301,7 @@ To find a document send a JSON message to the module main address:
 
 Where:
 * `collection` is the name of the MongoDB collection that you wish to search in in. This field is mandatory.
-* `matcher` is a JSON object that you want to match against to find a matching document. This obeys the normal MongoDB matching rues.
+* `matcher` is a JSON object that you want to match against to find a matching document. This obeys the normal MongoDB matching rules.
 * `keys` is an optional JSON object that contains the fields that should be returned for matched documents. See MongoDB manual for more information. Example: { "name": 1 } will only return objects with _id and the name field
 
 If more than one document matches, just the first one will be returned.
@@ -346,7 +332,56 @@ If an error occurs in finding the documents a reply is returned:
         "message": <message>
     }
 
-Where `message` is an error message. 
+Where
+*`message` is an error message.
+
+### Count
+
+Counts the number of documents within a collection:
+
+   {
+       "action": "count",
+       "collection": <collection>,
+       "matcher": <matcher>
+   }
+
+Where:
+* `collection` is the name of the MongoDB collection that you wish to delete from. This field is mandatory.
+* `matcher` is a JSON object that you want to match against to count matching documents. This obeys the normal MongoDB matching rules.
+
+All documents within the collection will be counted.
+
+An example would be:
+
+    {
+        "action": "count",
+        "collection": "items",
+        "matcher": {
+            "active": true
+        }
+    }
+
+This should return the count of all documents that have the attribute active set to true.
+
+When the count completes successfully, a reply message is sent back to the sender with the following data:
+
+    {
+        "status": "ok",
+        "count": <count>
+    }
+
+Where
+*`count` is the number of documents in the collection that matched the matcher.
+
+If an error occurs in finding the documents a reply is returned:
+
+    {
+        "status": "error",
+        "message": <message>
+    }
+
+Where
+*`message` is an error message.
 
 ### Delete
 
@@ -362,7 +397,7 @@ To delete documents send a JSON message to the module main address:
 
 Where:
 * `collection` is the name of the MongoDB collection that you wish to delete from. This field is mandatory.
-* `matcher` is a JSON object that you want to match against to delete matching documents. This obeys the normal MongoDB matching rues.
+* `matcher` is a JSON object that you want to match against to delete matching documents. This obeys the normal MongoDB matching rules.
 
 All documents that match will be deleted.
 
@@ -385,7 +420,8 @@ When the find complete successfully, a reply message is sent back to the sender
         "number": <number>
     }       
 
-Where `number` is the number of documents deleted.    
+Where
+*`number` is the number of documents deleted.
 
 If an error occurs in finding the documents a reply is returned:
 
@@ -394,7 +430,148 @@ If an error occurs in finding the documents a reply is returned:
         "message": <message>
     }
 
-Where `message` is an error message.
+Where
+*`message` is an error message.
+
+### Get Collections List
+
+Returns the list of collection names in the db:
+
+   {
+       "action": "getCollections"
+   }
+
+All collections within the current db will be returned if they exist.
+
+An example would be:
+
+    {
+        "action": "getCollections"
+    }
+
+This should return the list of all collections within the db
+
+When getCollections completes successfully, a reply message is sent back to the sender with the following data:
+
+    {
+        "status": "ok",
+        "collections": [
+            <listOfCollections>
+        ]
+    }
+
+Where
+* <listOfCollections> is a list containing each collection name in the db.
+
+If an error occurs in finding the documents a reply is returned:
+
+    {
+        "status": "error",
+        "message": <message>
+    }
+
+Where
+* `message` is an error message.
+
+### DB stats
+
+Returns statistics about the db:
+
+   {
+       "action": "collectionStats",
+       "collection": <collection>
+   }
+
+Where:
+* `collection` is the name of the MongoDB collection that you wish to get statistics on in the db. This field is mandatory.
+
+An example would be:
+
+    {
+        "action": "collectionStats",
+        "collection": "items"
+    }
+
+This will return the statistics for the items collection within the db.
+
+When collectionStats completes successfully, a reply message is sent back to the sender with the following data:
+
+    {
+        "status": "ok",
+        "stats": {
+            "serverUsed":"localhost/127.0.0.1:27017",
+            "ns"": "test_coll.items",
+            "count": 1,
+            "size": 136,
+            "avgObjSize": 136.0,
+            "storageSize": 8192,
+            "numExtents": 1,
+            "nindexes": 1,
+            "lastExtentSize": 8192,
+            "paddingFactor": 1.0,
+            "systemFlags": 1,
+            "userFlags": 0,
+            "totalIndexSize": 8176,
+            "indexSizes": {
+                "_id_":8176
+            },
+            "ok":1.0
+        }
+    }
+
+Instead of putting placeholders in the DOC here are almost all the real values from the test_client.js run which tests collectionStats
+I did change the "ns" value to match the collection name in the sample above.
+
+If an error occurs in finding the documents a reply is returned:
+
+    {
+        "status": "error",
+        "message": <message>
+    }
+
+Where
+* `message` is an error message.
+
+### Drop Collection
+
+Drops a collection from the db:
+
+   {
+       "action": "dropCollection",
+       "collection": <collection>
+   }
+
+Where:
+* `collection` is the name of the MongoDB collection that you wish to drop from the db. This field is mandatory.
+
+The collection will be removed from the db. This means that all the documents within the collection are gone. Use with CARE
+
+An example would be:
+
+    {
+        "action": "dropCollection",
+        "collection": "items"
+    }
+
+This should return an "ok" response, but nothing else. Check out the test_client.js to see our test to make sure
+that dropCollection works. We just then go retrieve the collection list to make sure the collection we dropped is not
+in the collection list returned but "getCollections" action
+
+When the drop completes successfully, a reply message is sent back to the sender with the following data:
+
+    {
+        "status": "ok",
+    }
+
+If an error occurs in finding the documents a reply is returned:
+
+    {
+        "status": "error",
+        "message": <message>
+    }
+
+Where
+* `message` is an error message.
 
 ### Command
 
@@ -446,5 +623,5 @@ An example for delete would be
         "action": "delete",
         "collection": <collection>,
         "matcher": <matcher>,
-        "write_concern": "SAFE"
+        "writeConcern": "SAFE"
     }