Updated docs

mongodb · Aug 2, 2012 · f301eb8 · f301eb8
1 parent 846a41f
commit f301eb8
Show file tree

Hide file tree

Showing 13 changed files with 99 additions and 77 deletions.
diff --git a/_sources/api-generated/collection.txt b/_sources/api-generated/collection.txt
@@ -855,7 +855,7 @@ Options
 .. js:function:: count([query][, options], callback)
 
    :param object [query]: query to filter by before performing count.
-   :param object [options]: additional options during update.
+   :param object [options]: additional options during count.
    :param function callback: must be provided.
    :returns: null 
 
@@ -2654,11 +2654,11 @@ Options
                collection.aggregate([
                    { $project : {
                    	author : 1,
-                   	tags : 1,
+                   	tags : 1
                    }},
                    { $unwind : "$tags" },
                    { $group : {
-                   	_id : { tags : 1 },
+                   	_id : {tags : "$tags"},
                    	authors : { $addToSet : "$author" }
                    }}
                  ], function(err, result) {
@@ -2725,8 +2725,8 @@ Options
                    }},
                    { $unwind : "$tags" },
                    { $group : {
-                    _id : { tags : 1 },
-                    authors : { $addToSet : "$author" }
+                   	_id : {tags : "$tags"},
+                   	authors : { $addToSet : "$author" }
                    }}
                  , function(err, result) {
                    assert.equal(null, err);
@@ -2787,13 +2787,13 @@ Options
                // instead of an Array.
                collection.aggregate(
                    { $project : {
-                     author : 1,
-                     tags : 1
+                   	author : 1,
+                   	tags : 1
                    }},
                    { $unwind : "$tags" },
                    { $group : {
-                    _id : { tags : 1 },
-                    authors : { $addToSet : "$author" }
+                   	_id : {tags : "$tags"},
+                   	authors : { $addToSet : "$author" }
                    }}
                  , function(err, result) {
                    assert.equal(null, err);

diff --git a/_sources/api-generated/db.txt b/_sources/api-generated/db.txt
@@ -477,9 +477,15 @@ collectionNames
 
 Get the list of all collection names for the specified db
 
-.. js:function:: collectionNames([collectionName], callback)
+
+
+Options
+ - **namesOnly** {String, default:false}, Return only the full collection namespace.
+
+.. js:function:: collectionNames([collectionName][, options], callback)
 
    :param string [collectionName]: the collection name we wish to filter by.
+   :param object [options]: additional options during update.
    :param function callback: returns option results.
    :returns: null 
 

diff --git a/_sources/changelog/changelog.txt b/_sources/changelog/changelog.txt
@@ -2,7 +2,7 @@
 Changelog
 =========
 
-1.1.2
+1.1.2 2012-07-28
 ----------------
 - Added Mongos connection type with a fallback list for mongos proxies, supports ha (on by default) and will attempt to reconnect to failed proxies.
 - Documents can now have a toBSON method that lets the user control the serialization behavior for documents being saved.

diff --git a/_sources/github/github.txt b/_sources/github/github.txt
@@ -64,7 +64,7 @@ Web frameworks using MongoDB
          * - **Last push**
            - 9:34:59 on 23/6/2012
          * - **Homepage**
-           - http://search.npmjs.org/#/bread
+           - http://https://npmjs.org/package/bread
          * - **Url**
            - https://github.com/pvorb/node-bread
          * - **Clone Url**
@@ -134,7 +134,7 @@ Object Document Modeling Libraries
          * - **Activity Level**
            - .. image:: ../static/active.png
          * - **Last push**
-           - 22:29:54 on 25/6/2012
+           - 21:50:49 on 1/7/2012
          * - **Homepage**
            - http://
          * - **Url**
@@ -144,7 +144,7 @@ Object Document Modeling Libraries
          * - **Forks**
            - 228
          * - **Watchers**
-           - 2188
+           - 2204
 
 .. topic:: mongo-model
 
@@ -167,7 +167,7 @@ Object Document Modeling Libraries
          * - **Forks**
            - 4
          * - **Watchers**
-           - 45
+           - 47
 
 .. topic:: mongodb-expressions
 
@@ -260,9 +260,9 @@ Content Management Systems
          * - **Clone Url**
            - https://github.com/cliftonc/calipso.git
          * - **Forks**
-           - 131
+           - 132
          * - **Watchers**
-           - 890
+           - 894
 
 Grid FS libraries or tools
 --------------------------
@@ -314,7 +314,7 @@ Wrapper libraries to ease the use of development or provide simple ODM like beha
          * - **Forks**
            - 5
          * - **Watchers**
-           - 36
+           - 37
 
 .. topic:: mongoq
 
@@ -337,7 +337,7 @@ Wrapper libraries to ease the use of development or provide simple ODM like beha
          * - **Forks**
            - 3
          * - **Watchers**
-           - 48
+           - 49
 
 .. topic:: mongolia
 
@@ -381,9 +381,9 @@ Wrapper libraries to ease the use of development or provide simple ODM like beha
          * - **Clone Url**
            - https://github.com/gett/mongojs.git
          * - **Forks**
-           - 16
+           - 18
          * - **Watchers**
-           - 192
+           - 196
 
 .. topic:: mongode
 
@@ -429,7 +429,7 @@ Wrapper libraries to ease the use of development or provide simple ODM like beha
          * - **Forks**
            - 8
          * - **Watchers**
-           - 38
+           - 39
 
 .. topic:: mongodb-async
 
@@ -442,7 +442,7 @@ Wrapper libraries to ease the use of development or provide simple ODM like beha
          * - **Activity Level**
            - .. image:: ../static/active.png
          * - **Last push**
-           - 17:11:28 on 16/6/2012
+           - 4:24:44 on 1/7/2012
          * - **Homepage**
            - http://
          * - **Url**
@@ -547,7 +547,7 @@ REST api's around MongoDB or resource based libraries
          * - **Forks**
            - 34
          * - **Watchers**
-           - 162
+           - 163
 
 .. topic:: lazyBum
 
@@ -854,7 +854,7 @@ General frameworks over MongoDB
          * - **Activity Level**
            - .. image:: ../static/active.png
          * - **Last push**
-           - 3:44:25 on 28/6/2012
+           - 15:35:31 on 31/6/2012
          * - **Homepage**
            - http://
          * - **Url**
@@ -864,7 +864,7 @@ General frameworks over MongoDB
          * - **Forks**
            - 1
          * - **Watchers**
-           - 13
+           - 21
 
 Translation libraries or frameworks
 -----------------------------------
@@ -937,9 +937,9 @@ Libraries or Applications for analytics
          * - **Clone Url**
            - https://github.com/square/cube.git
          * - **Forks**
-           - 179
+           - 180
          * - **Watchers**
-           - 2047
+           - 2058
 
 Libraries for the connect middleware
 ------------------------------------
@@ -986,7 +986,7 @@ Libraries for the connect middleware
          * - **Clone Url**
            - https://github.com/masylum/connect-mongodb.git
          * - **Forks**
-           - 40
+           - 39
          * - **Watchers**
            - 169
 
@@ -1011,7 +1011,7 @@ Libraries for the connect middleware
          * - **Forks**
            - 42
          * - **Watchers**
-           - 139
+           - 140
 
 Libraries or applications for continous integration
 ---------------------------------------------------
@@ -1035,9 +1035,9 @@ Libraries or applications for continous integration
          * - **Clone Url**
            - https://github.com/ryankee/concrete.git
          * - **Forks**
-           - 22
+           - 23
          * - **Watchers**
-           - 186
+           - 193
 
 Exampe applications
 -------------------

diff --git a/_sources/markdown-docs/database.txt b/_sources/markdown-docs/database.txt
@@ -143,7 +143,11 @@ Deleting a database
   .. code-block:: javascript
 
     db_connector.open(function(err, db){
-        db.dropDatabase()
+    	if (err) { throw err; }
+        db.dropDatabase(function(err) {
+    		if (err) { throw err; }
+    		console.log("database has been dropped!");
+    	});
     });
 
 

diff --git a/api-generated/collection.html b/api-generated/collection.html
@@ -934,7 +934,7 @@ <h2>count<a class="headerlink" href="#count" title="Permalink to this headline">
 <tbody valign="top">
 <tr class="field-odd field"><th class="field-name">Arguments:</th><td class="field-body"><ul class="first simple">
 <li><strong>[query]</strong> (<em>object</em>) &#8211; query to filter by before performing count.</li>
-<li><strong>[options]</strong> (<em>object</em>) &#8211; additional options during update.</li>
+<li><strong>[options]</strong> (<em>object</em>) &#8211; additional options during count.</li>
 <li><strong>callback</strong> (<em>function</em>) &#8211; must be provided.</li>
 </ul>
 </td>
@@ -2869,11 +2869,11 @@ <h2>aggregate<a class="headerlink" href="#aggregate" title="Permalink to this he
           <span class="nx">collection</span><span class="p">.</span><span class="nx">aggregate</span><span class="p">([</span>
               <span class="p">{</span> <span class="nx">$project</span> <span class="o">:</span> <span class="p">{</span>
                    <span class="nx">author</span> <span class="o">:</span> <span class="mi">1</span><span class="p">,</span>
-                   <span class="nx">tags</span> <span class="o">:</span> <span class="mi">1</span><span class="p">,</span>
+                   <span class="nx">tags</span> <span class="o">:</span> <span class="mi">1</span>
               <span class="p">}},</span>
               <span class="p">{</span> <span class="nx">$unwind</span> <span class="o">:</span> <span class="s2">&quot;$tags&quot;</span> <span class="p">},</span>
               <span class="p">{</span> <span class="nx">$group</span> <span class="o">:</span> <span class="p">{</span>
-                   <span class="nx">_id</span> <span class="o">:</span> <span class="p">{</span> <span class="nx">tags</span> <span class="o">:</span> <span class="mi">1</span> <span class="p">},</span>
+                   <span class="nx">_id</span> <span class="o">:</span> <span class="p">{</span><span class="nx">tags</span> <span class="o">:</span> <span class="s2">&quot;$tags&quot;</span><span class="p">},</span>
                    <span class="nx">authors</span> <span class="o">:</span> <span class="p">{</span> <span class="nx">$addToSet</span> <span class="o">:</span> <span class="s2">&quot;$author&quot;</span> <span class="p">}</span>
               <span class="p">}}</span>
             <span class="p">],</span> <span class="kd">function</span><span class="p">(</span><span class="nx">err</span><span class="p">,</span> <span class="nx">result</span><span class="p">)</span> <span class="p">{</span>
@@ -2936,8 +2936,8 @@ <h2>aggregate<a class="headerlink" href="#aggregate" title="Permalink to this he
               <span class="p">}},</span>
               <span class="p">{</span> <span class="nx">$unwind</span> <span class="o">:</span> <span class="s2">&quot;$tags&quot;</span> <span class="p">},</span>
               <span class="p">{</span> <span class="nx">$group</span> <span class="o">:</span> <span class="p">{</span>
-               <span class="nx">_id</span> <span class="o">:</span> <span class="p">{</span> <span class="nx">tags</span> <span class="o">:</span> <span class="mi">1</span> <span class="p">},</span>
-               <span class="nx">authors</span> <span class="o">:</span> <span class="p">{</span> <span class="nx">$addToSet</span> <span class="o">:</span> <span class="s2">&quot;$author&quot;</span> <span class="p">}</span>
+                   <span class="nx">_id</span> <span class="o">:</span> <span class="p">{</span><span class="nx">tags</span> <span class="o">:</span> <span class="s2">&quot;$tags&quot;</span><span class="p">},</span>
+                   <span class="nx">authors</span> <span class="o">:</span> <span class="p">{</span> <span class="nx">$addToSet</span> <span class="o">:</span> <span class="s2">&quot;$author&quot;</span> <span class="p">}</span>
               <span class="p">}}</span>
             <span class="p">,</span> <span class="kd">function</span><span class="p">(</span><span class="nx">err</span><span class="p">,</span> <span class="nx">result</span><span class="p">)</span> <span class="p">{</span>
               <span class="nx">assert</span><span class="p">.</span><span class="nx">equal</span><span class="p">(</span><span class="kc">null</span><span class="p">,</span> <span class="nx">err</span><span class="p">);</span>
@@ -2994,13 +2994,13 @@ <h2>aggregate<a class="headerlink" href="#aggregate" title="Permalink to this he
           <span class="c1">// instead of an Array.</span>
           <span class="nx">collection</span><span class="p">.</span><span class="nx">aggregate</span><span class="p">(</span>
               <span class="p">{</span> <span class="nx">$project</span> <span class="o">:</span> <span class="p">{</span>
-                <span class="nx">author</span> <span class="o">:</span> <span class="mi">1</span><span class="p">,</span>
-                <span class="nx">tags</span> <span class="o">:</span> <span class="mi">1</span>
+                   <span class="nx">author</span> <span class="o">:</span> <span class="mi">1</span><span class="p">,</span>
+                   <span class="nx">tags</span> <span class="o">:</span> <span class="mi">1</span>
               <span class="p">}},</span>
               <span class="p">{</span> <span class="nx">$unwind</span> <span class="o">:</span> <span class="s2">&quot;$tags&quot;</span> <span class="p">},</span>
               <span class="p">{</span> <span class="nx">$group</span> <span class="o">:</span> <span class="p">{</span>
-               <span class="nx">_id</span> <span class="o">:</span> <span class="p">{</span> <span class="nx">tags</span> <span class="o">:</span> <span class="mi">1</span> <span class="p">},</span>
-               <span class="nx">authors</span> <span class="o">:</span> <span class="p">{</span> <span class="nx">$addToSet</span> <span class="o">:</span> <span class="s2">&quot;$author&quot;</span> <span class="p">}</span>
+                   <span class="nx">_id</span> <span class="o">:</span> <span class="p">{</span><span class="nx">tags</span> <span class="o">:</span> <span class="s2">&quot;$tags&quot;</span><span class="p">},</span>
+                   <span class="nx">authors</span> <span class="o">:</span> <span class="p">{</span> <span class="nx">$addToSet</span> <span class="o">:</span> <span class="s2">&quot;$author&quot;</span> <span class="p">}</span>
               <span class="p">}}</span>
             <span class="p">,</span> <span class="kd">function</span><span class="p">(</span><span class="nx">err</span><span class="p">,</span> <span class="nx">result</span><span class="p">)</span> <span class="p">{</span>
               <span class="nx">assert</span><span class="p">.</span><span class="nx">equal</span><span class="p">(</span><span class="kc">null</span><span class="p">,</span> <span class="nx">err</span><span class="p">);</span>

diff --git a/api-generated/db.html b/api-generated/db.html
@@ -557,15 +557,23 @@ <h2>collectionsInfo<a class="headerlink" href="#collectionsinfo" title="Permalin
 <div class="section" id="collectionnames">
 <h2>collectionNames<a class="headerlink" href="#collectionnames" title="Permalink to this headline">¶</a></h2>
 <p>Get the list of all collection names for the specified db</p>
+<dl class="docutils">
+<dt>Options</dt>
+<dd><ul class="first last simple">
+<li><strong>namesOnly</strong> {String, default:false}, Return only the full collection namespace.</li>
+</ul>
+</dd>
+</dl>
 <dl class="function">
 <dt id="collectionNames">
-<tt class="descname">collectionNames</tt><big>(</big><span class="optional">[</span><em>collectionName</em><span class="optional">]</span>, <em>callback</em><big>)</big><a class="headerlink" href="#collectionNames" title="Permalink to this definition">¶</a></dt>
+<tt class="descname">collectionNames</tt><big>(</big><em>[collectionName][, options], callback</em><big>)</big><a class="headerlink" href="#collectionNames" title="Permalink to this definition">¶</a></dt>
 <dd><table class="docutils field-list" frame="void" rules="none">
 <col class="field-name" />
 <col class="field-body" />
 <tbody valign="top">
 <tr class="field-odd field"><th class="field-name">Arguments:</th><td class="field-body"><ul class="first simple">
 <li><strong>[collectionName]</strong> (<em>string</em>) &#8211; the collection name we wish to filter by.</li>
+<li><strong>[options]</strong> (<em>object</em>) &#8211; additional options during update.</li>
 <li><strong>callback</strong> (<em>function</em>) &#8211; returns option results.</li>
 </ul>
 </td>

diff --git a/changelog/changelog.html b/changelog/changelog.html
@@ -48,7 +48,7 @@ <h3>Navigation</h3>
   <div class="section" id="changelog">
 <h1>Changelog<a class="headerlink" href="#changelog" title="Permalink to this headline">¶</a></h1>
 <div class="section" id="id1">
-<h2>1.1.2<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h2>
+<h2>1.1.2 2012-07-28<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h2>
 <ul>
 <li><p class="first">Added Mongos connection type with a fallback list for mongos proxies, supports ha (on by default) and will attempt to reconnect to failed proxies.</p>
 </li>
@@ -855,7 +855,7 @@ <h2>0.1 2010-01-30<a class="headerlink" href="#id66" title="Permalink to this he
 <h3>Contents</h3>
 <ul>
 <li><a class="reference internal" href="#">Changelog</a><ul>
-<li><a class="reference internal" href="#id1">1.1.2</a></li>
+<li><a class="reference internal" href="#id1">1.1.2 2012-07-28</a></li>
 <li><a class="reference internal" href="#id2">1.0.2 2012-05-15</a></li>
 <li><a class="reference internal" href="#id3">1.0.1 2012-05-12</a></li>
 <li><a class="reference internal" href="#id4">1.0.0 2012-04-25</a></li>