Skip to content

Commit

Permalink
Checked in missing docs
Browse files Browse the repository at this point in the history
  • Loading branch information
christkv committed Nov 27, 2012
1 parent f082d25 commit cf66157
Show file tree
Hide file tree
Showing 43 changed files with 1,156 additions and 54 deletions.
16 changes: 8 additions & 8 deletions _sources/api-generated/collection.txt
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Inserts a single document or a an array of documents into MongoDB.


Options
- **w**, {Number/String, > -1 || 'majority' || tag name} the write concern for the operation where &lt; 1 is no acknowlegement of write and w >= 1, w = 'majority' or tag acknowledges the write (<a href='https://wiki.10gen.com/display/DOCS/getLastError+Command'>https://wiki.10gen.com/display/DOCS/getLastError+Command</a>)
- **w**, {Number/String, > -1 || 'majority' || tag name} the write concern for the operation where &lt; 1 is no acknowlegement of write and w >= 1, w = 'majority' or tag acknowledges the write
- **wtimeout**, {Number, 0} set the timeout for waiting for write concern to finish (combines with w option)
- **fsync**, (Boolean, default:false) write waits for fsync before returning
- **journal**, (Boolean, default:false) write waits for journal sync before returning
Expand Down Expand Up @@ -251,7 +251,7 @@ Removes documents specified by <code>selector</code> from the db.


Options
- **w**, {Number/String, > -1 || 'majority' || tag name} the write concern for the operation where &lt; 1 is no acknowlegement of write and w >= 1, w = 'majority' or tag acknowledges the write (<a href='https://wiki.10gen.com/display/DOCS/getLastError+Command'>https://wiki.10gen.com/display/DOCS/getLastError+Command</a>)
- **w**, {Number/String, > -1 || 'majority' || tag name} the write concern for the operation where &lt; 1 is no acknowlegement of write and w >= 1, w = 'majority' or tag acknowledges the write
- **wtimeout**, {Number, 0} set the timeout for waiting for write concern to finish (combines with w option)
- **fsync**, (Boolean, default:false) write waits for fsync before returning
- **journal**, (Boolean, default:false) write waits for journal sync before returning
Expand Down Expand Up @@ -487,7 +487,7 @@ operators and update instead for more efficient operations.


Options
- **w**, {Number/String, > -1 || 'majority' || tag name} the write concern for the operation where &lt; 1 is no acknowlegement of write and w >= 1, w = 'majority' or tag acknowledges the write (<a href='https://wiki.10gen.com/display/DOCS/getLastError+Command'>https://wiki.10gen.com/display/DOCS/getLastError+Command</a>)
- **w**, {Number/String, > -1 || 'majority' || tag name} the write concern for the operation where &lt; 1 is no acknowlegement of write and w >= 1, w = 'majority' or tag acknowledges the write
- **wtimeout**, {Number, 0} set the timeout for waiting for write concern to finish (combines with w option)
- **fsync**, (Boolean, default:false) write waits for fsync before returning
- **journal**, (Boolean, default:false) write waits for journal sync before returning
Expand Down Expand Up @@ -613,7 +613,7 @@ Updates documents.


Options
- **w**, {Number/String, > -1 || 'majority' || tag name} the write concern for the operation where &lt; 1 is no acknowlegement of write and w >= 1, w = 'majority' or tag acknowledges the write (<a href='https://wiki.10gen.com/display/DOCS/getLastError+Command'>https://wiki.10gen.com/display/DOCS/getLastError+Command</a>)
- **w**, {Number/String, > -1 || 'majority' || tag name} the write concern for the operation where &lt; 1 is no acknowlegement of write and w >= 1, w = 'majority' or tag acknowledges the write
- **wtimeout**, {Number, 0} set the timeout for waiting for write concern to finish (combines with w option)
- **fsync**, (Boolean, default:false) write waits for fsync before returning
- **journal**, (Boolean, default:false) write waits for journal sync before returning
Expand Down Expand Up @@ -1033,7 +1033,7 @@ Find and update a document.


Options
- **w**, {Number/String, > -1 || 'majority' || tag name} the write concern for the operation where &lt; 1 is no acknowlegement of write and w >= 1, w = 'majority' or tag acknowledges the write (<a href='https://wiki.10gen.com/display/DOCS/getLastError+Command'>https://wiki.10gen.com/display/DOCS/getLastError+Command</a>)
- **w**, {Number/String, > -1 || 'majority' || tag name} the write concern for the operation where &lt; 1 is no acknowlegement of write and w >= 1, w = 'majority' or tag acknowledges the write
- **wtimeout**, {Number, 0} set the timeout for waiting for write concern to finish (combines with w option)
- **fsync**, (Boolean, default:false) write waits for fsync before returning
- **journal**, (Boolean, default:false) write waits for journal sync before returning
Expand Down Expand Up @@ -1139,7 +1139,7 @@ Find and remove a document


Options
- **w**, {Number/String, > -1 || 'majority' || tag name} the write concern for the operation where &lt; 1 is no acknowlegement of write and w >= 1, w = 'majority' or tag acknowledges the write (<a href='https://wiki.10gen.com/display/DOCS/getLastError+Command'>https://wiki.10gen.com/display/DOCS/getLastError+Command</a>)
- **w**, {Number/String, > -1 || 'majority' || tag name} the write concern for the operation where &lt; 1 is no acknowlegement of write and w >= 1, w = 'majority' or tag acknowledges the write
- **wtimeout**, {Number, 0} set the timeout for waiting for write concern to finish (combines with w option)
- **fsync**, (Boolean, default:false) write waits for fsync before returning
- **journal**, (Boolean, default:false) write waits for journal sync before returning
Expand Down Expand Up @@ -1500,7 +1500,7 @@ Creates an index on the collection.


Options
- **w**, {Number/String, > -1 || 'majority' || tag name} the write concern for the operation where &lt; 1 is no acknowlegement of write and w >= 1, w = 'majority' or tag acknowledges the write (<a href='https://wiki.10gen.com/display/DOCS/getLastError+Command'>https://wiki.10gen.com/display/DOCS/getLastError+Command</a>)
- **w**, {Number/String, > -1 || 'majority' || tag name} the write concern for the operation where &lt; 1 is no acknowlegement of write and w >= 1, w = 'majority' or tag acknowledges the write
- **wtimeout**, {Number, 0} set the timeout for waiting for write concern to finish (combines with w option)
- **fsync**, (Boolean, default:false) write waits for fsync before returning
- **journal**, (Boolean, default:false) write waits for journal sync before returning
Expand Down Expand Up @@ -1641,7 +1641,7 @@ Ensures that an index exists, if it does not it creates it


Options
- **w**, {Number/String, > -1 || 'majority' || tag name} the write concern for the operation where &lt; 1 is no acknowlegement of write and w >= 1, w = 'majority' or tag acknowledges the write (<a href='https://wiki.10gen.com/display/DOCS/getLastError+Command'>https://wiki.10gen.com/display/DOCS/getLastError+Command</a>)
- **w**, {Number/String, > -1 || 'majority' || tag name} the write concern for the operation where &lt; 1 is no acknowlegement of write and w >= 1, w = 'majority' or tag acknowledges the write
- **wtimeout**, {Number, 0} set the timeout for waiting for write concern to finish (combines with w option)
- **fsync**, (Boolean, default:false) write waits for fsync before returning
- **journal**, (Boolean, default:false) write waits for journal sync before returning
Expand Down
15 changes: 8 additions & 7 deletions _sources/api-generated/db.txt
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Create a new Db instance.


Options
- **w**, {Number/String, > -1 || 'majority' || tag name} the write concern for the operation where &lt; 1 is no acknowlegement of write and w >= 1, w = 'majority' or tag acknowledges the write (<a href='https://wiki.10gen.com/display/DOCS/getLastError+Command'>https://wiki.10gen.com/display/DOCS/getLastError+Command</a>)
- **w**, {Number/String, > -1 || 'majority' || tag name} the write concern for the operation where < 1 is no acknowlegement of write and w >= 1, w = 'majority' or tag acknowledges the write
- **wtimeout**, {Number, 0} set the timeout for waiting for write concern to finish (combines with w option)
- **fsync**, (Boolean, default:false) write waits for fsync before returning
- **journal**, (Boolean, default:false) write waits for journal sync before returning
Expand All @@ -31,6 +31,7 @@ Options
- **recordQueryStats** {Boolean, default:false}, record query statistics during execution.
- **retryMiliSeconds** {Number, default:5000}, number of miliseconds between retries.
- **numberOfRetries** {Number, default:5}, number of retries off connection.
- **logger** {Object, default:null}, an object representing a logger that you want to use, needs to support functions debug, log, error **({error:function(message, object) {}, log:function(message, object) {}, debug:function(message, object) {}})**.



Expand Down Expand Up @@ -557,7 +558,7 @@ Fetch a specific collection (containing the actual collection information)


Options
- **w**, {Number/String, > -1 || 'majority' || tag name} the write concern for the operation where &lt; 1 is no acknowlegement of write and w >= 1, w = 'majority' or tag acknowledges the write (<a href='https://wiki.10gen.com/display/DOCS/getLastError+Command'>https://wiki.10gen.com/display/DOCS/getLastError+Command</a>)
- **w**, {Number/String, > -1 || 'majority' || tag name} the write concern for the operation where &lt; 1 is no acknowlegement of write and w >= 1, w = 'majority' or tag acknowledges the write
- **wtimeout**, {Number, 0} set the timeout for waiting for write concern to finish (combines with w option)
- **fsync**, (Boolean, default:false) write waits for fsync before returning
- **journal**, (Boolean, default:false) write waits for journal sync before returning
Expand Down Expand Up @@ -1035,7 +1036,7 @@ Add a user to the database.


Options
- **w**, {Number/String, > -1 || 'majority' || tag name} the write concern for the operation where &lt; 1 is no acknowlegement of write and w >= 1, w = 'majority' or tag acknowledges the write (<a href='https://wiki.10gen.com/display/DOCS/getLastError+Command'>https://wiki.10gen.com/display/DOCS/getLastError+Command</a>)
- **w**, {Number/String, > -1 || 'majority' || tag name} the write concern for the operation where &lt; 1 is no acknowlegement of write and w >= 1, w = 'majority' or tag acknowledges the write
- **wtimeout**, {Number, 0} set the timeout for waiting for write concern to finish (combines with w option)
- **fsync**, (Boolean, default:false) write waits for fsync before returning
- **journal**, (Boolean, default:false) write waits for journal sync before returning
Expand Down Expand Up @@ -1099,7 +1100,7 @@ Remove a user from a database


Options
- **w**, {Number/String, > -1 || 'majority' || tag name} the write concern for the operation where &lt; 1 is no acknowlegement of write and w >= 1, w = 'majority' or tag acknowledges the write (<a href='https://wiki.10gen.com/display/DOCS/getLastError+Command'>https://wiki.10gen.com/display/DOCS/getLastError+Command</a>)
- **w**, {Number/String, > -1 || 'majority' || tag name} the write concern for the operation where &lt; 1 is no acknowlegement of write and w >= 1, w = 'majority' or tag acknowledges the write
- **wtimeout**, {Number, 0} set the timeout for waiting for write concern to finish (combines with w option)
- **fsync**, (Boolean, default:false) write waits for fsync before returning
- **journal**, (Boolean, default:false) write waits for journal sync before returning
Expand Down Expand Up @@ -1181,7 +1182,7 @@ Creates a collection on a server pre-allocating space, need to create f.ex cappe


Options
- **w**, {Number/String, > -1 || 'majority' || tag name} the write concern for the operation where &lt; 1 is no acknowlegement of write and w >= 1, w = 'majority' or tag acknowledges the write (<a href='https://wiki.10gen.com/display/DOCS/getLastError+Command'>https://wiki.10gen.com/display/DOCS/getLastError+Command</a>)
- **w**, {Number/String, > -1 || 'majority' || tag name} the write concern for the operation where &lt; 1 is no acknowlegement of write and w >= 1, w = 'majority' or tag acknowledges the write
- **wtimeout**, {Number, 0} set the timeout for waiting for write concern to finish (combines with w option)
- **fsync**, (Boolean, default:false) write waits for fsync before returning
- **journal**, (Boolean, default:false) write waits for journal sync before returning
Expand Down Expand Up @@ -1682,7 +1683,7 @@ Creates an index on the collection.


Options
- **w**, {Number/String, > -1 || 'majority' || tag name} the write concern for the operation where &lt; 1 is no acknowlegement of write and w >= 1, w = 'majority' or tag acknowledges the write (<a href='https://wiki.10gen.com/display/DOCS/getLastError+Command'>https://wiki.10gen.com/display/DOCS/getLastError+Command</a>)
- **w**, {Number/String, > -1 || 'majority' || tag name} the write concern for the operation where &lt; 1 is no acknowlegement of write and w >= 1, w = 'majority' or tag acknowledges the write
- **wtimeout**, {Number, 0} set the timeout for waiting for write concern to finish (combines with w option)
- **fsync**, (Boolean, default:false) write waits for fsync before returning
- **journal**, (Boolean, default:false) write waits for journal sync before returning
Expand Down Expand Up @@ -1778,7 +1779,7 @@ Ensures that an index exists, if it does not it creates it


Options
- **w**, {Number/String, > -1 || 'majority' || tag name} the write concern for the operation where &lt; 1 is no acknowlegement of write and w >= 1, w = 'majority' or tag acknowledges the write (<a href='https://wiki.10gen.com/display/DOCS/getLastError+Command'>https://wiki.10gen.com/display/DOCS/getLastError+Command</a>)
- **w**, {Number/String, > -1 || 'majority' || tag name} the write concern for the operation where &lt; 1 is no acknowlegement of write and w >= 1, w = 'majority' or tag acknowledges the write
- **wtimeout**, {Number, 0} set the timeout for waiting for write concern to finish (combines with w option)
- **fsync**, (Boolean, default:false) write waits for fsync before returning
- **journal**, (Boolean, default:false) write waits for journal sync before returning
Expand Down
12 changes: 12 additions & 0 deletions _sources/api-generated/index.txt
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,16 @@ Driver API
.. toctree::
:maxdepth: 2

admin
collection
mongoclient
db
cursor
cursorstream
gridstore
readstream
grid
server
mongos
replset
readpreference
1 change: 1 addition & 0 deletions _sources/api-generated/replset.txt
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ Options
- **strategy** {String, default:null}, selection strategy for reads choose between (ping and statistical, default is round-robin)
- **secondaryAcceptableLatencyMS** {Number, default:15}, sets the range of servers to pick when using NEAREST (lowest ping ms + the latency fence, ex: range of 1 to (1 + 15) ms)
- **connectArbiter** {Boolean, default:false}, sets if the driver should connect to arbiters or not.
- **logger** {Object, default:null}, an object representing a logger that you want to use, needs to support functions debug, log, error **({error:function(message, object) {}, log:function(message, object) {}, debug:function(message, object) {}})**.


---------
Expand Down
4 changes: 2 additions & 2 deletions _sources/github/github.txt
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,7 @@ Object Document Modeling Libraries
* - **Forks**
- 306
* - **Watchers**
- 2530
- 2531

.. topic:: mongo-model

Expand Down Expand Up @@ -916,7 +916,7 @@ Libraries or Applications for analytics
* - **Forks**
- 208
* - **Watchers**
- 2280
- 2281

Libraries for the connect middleware
------------------------------------
Expand Down
8 changes: 8 additions & 0 deletions api-articles/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,14 @@ <h3>Contents</h3>
<h3>Manual</h3>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../api-generated/mongoclient.html">MongoClient()</a></li>
<li class="toctree-l1"><a class="reference internal" href="../api-generated/db.html">Db()</a></li>
<li class="toctree-l1"><a class="reference internal" href="../api-generated/collection.html">Collection()</a></li>
<li class="toctree-l1"><a class="reference internal" href="../api-generated/admin.html">Admin()</a></li>
<li class="toctree-l1"><a class="reference internal" href="../api-generated/cursor.html">Cursor()</a></li>
<li class="toctree-l1"><a class="reference internal" href="../api-generated/cursorstream.html">CursorStream()</a></li>
<li class="toctree-l1"><a class="reference internal" href="../api-generated/grid.html">Grid()</a></li>
<li class="toctree-l1"><a class="reference internal" href="../api-generated/gridstore.html">GridStore()</a></li>
<li class="toctree-l1"><a class="reference internal" href="../api-generated/readstream.html">ReadStream()</a></li>
<li class="toctree-l1"><a class="reference internal" href="../api-bson-generated/bson.html">BSON()</a></li>
<li class="toctree-l1"><a class="reference internal" href="../api-bson-generated/objectid.html">ObjectID()</a></li>
<li class="toctree-l1"><a class="reference internal" href="../api-bson-generated/binary.html">Binary()</a></li>
Expand Down
8 changes: 8 additions & 0 deletions api-articles/nodekoarticle1.html
Original file line number Diff line number Diff line change
Expand Up @@ -411,6 +411,14 @@ <h3>Contents</h3>
<h3>Manual</h3>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../api-generated/mongoclient.html">MongoClient()</a></li>
<li class="toctree-l1"><a class="reference internal" href="../api-generated/db.html">Db()</a></li>
<li class="toctree-l1"><a class="reference internal" href="../api-generated/collection.html">Collection()</a></li>
<li class="toctree-l1"><a class="reference internal" href="../api-generated/admin.html">Admin()</a></li>
<li class="toctree-l1"><a class="reference internal" href="../api-generated/cursor.html">Cursor()</a></li>
<li class="toctree-l1"><a class="reference internal" href="../api-generated/cursorstream.html">CursorStream()</a></li>
<li class="toctree-l1"><a class="reference internal" href="../api-generated/grid.html">Grid()</a></li>
<li class="toctree-l1"><a class="reference internal" href="../api-generated/gridstore.html">GridStore()</a></li>
<li class="toctree-l1"><a class="reference internal" href="../api-generated/readstream.html">ReadStream()</a></li>
<li class="toctree-l1"><a class="reference internal" href="../api-bson-generated/bson.html">BSON()</a></li>
<li class="toctree-l1"><a class="reference internal" href="../api-bson-generated/objectid.html">ObjectID()</a></li>
<li class="toctree-l1"><a class="reference internal" href="../api-bson-generated/binary.html">Binary()</a></li>
Expand Down
8 changes: 8 additions & 0 deletions api-articles/nodekoarticle2.html
Original file line number Diff line number Diff line change
Expand Up @@ -307,6 +307,14 @@ <h3>Contents</h3>
<h3>Manual</h3>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../api-generated/mongoclient.html">MongoClient()</a></li>
<li class="toctree-l1"><a class="reference internal" href="../api-generated/db.html">Db()</a></li>
<li class="toctree-l1"><a class="reference internal" href="../api-generated/collection.html">Collection()</a></li>
<li class="toctree-l1"><a class="reference internal" href="../api-generated/admin.html">Admin()</a></li>
<li class="toctree-l1"><a class="reference internal" href="../api-generated/cursor.html">Cursor()</a></li>
<li class="toctree-l1"><a class="reference internal" href="../api-generated/cursorstream.html">CursorStream()</a></li>
<li class="toctree-l1"><a class="reference internal" href="../api-generated/grid.html">Grid()</a></li>
<li class="toctree-l1"><a class="reference internal" href="../api-generated/gridstore.html">GridStore()</a></li>
<li class="toctree-l1"><a class="reference internal" href="../api-generated/readstream.html">ReadStream()</a></li>
<li class="toctree-l1"><a class="reference internal" href="../api-bson-generated/bson.html">BSON()</a></li>
<li class="toctree-l1"><a class="reference internal" href="../api-bson-generated/objectid.html">ObjectID()</a></li>
<li class="toctree-l1"><a class="reference internal" href="../api-bson-generated/binary.html">Binary()</a></li>
Expand Down
Loading

0 comments on commit cf66157

Please sign in to comment.