Skip to content

Commit

Permalink
Updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
christkv committed Apr 20, 2012
1 parent b9c3f3c commit 5b5cae3
Show file tree
Hide file tree
Showing 11 changed files with 506 additions and 84 deletions.
9 changes: 7 additions & 2 deletions _sources/api-generated/db.txt
Expand Up @@ -2003,10 +2003,15 @@ Connect to MongoDB using a url as documented at

www.mongodb.org/display/DOCS/Connections

.. js:function:: Db.connect(url, options, callback)


Options
- **uri_decode_auth** {Boolean, default:false} uri decode the user name and password for authentication

.. js:function:: Db.connect(url[, options], callback)

:param string url: connection url for MongoDB.
:param object options: additional options not covered by the url.
:param object [options]: optional options for insert command
:param function callback: callback returns the initialized db.
:returns: null

Expand Down
28 changes: 28 additions & 0 deletions _sources/api-generated/replset.txt
@@ -0,0 +1,28 @@
=======
ReplSet
=======

------------------
Constructor
------------------


ReplSet constructor provides replicaset functionality


.. js:class:: ReplSet

:param array list: of server objects participating in the replicaset.
:param object [options]: additional options for the collection.


Options
- **ha** {Boolean, default:false}, turn on high availability.
- **haInterval** {Number, default:2000}, time between each replicaset status check.
- **reconnectWait** {Number, default:1000}, time to wait in miliseconds before attempting reconnect.
- **retries** {Number, default:30}, number of times to attempt a replicaset reconnect.
- **rs_name** {String}, the name of the replicaset to connect to.
- **readPreference** {String}, the prefered read preference (Server.READ_PRIMARY, Server.READ_SECONDARY, Server.READ_SECONDARY_ONLY).
- **read_secondary** {Boolean, deprecated}, allow reads from secondary.
- **strategy** {String, default:null}, selection strategy for reads choose between (ping and statistical, default is round-robin)

28 changes: 28 additions & 0 deletions _sources/api-generated/server.txt
@@ -0,0 +1,28 @@
========
Server()
========

------------------
Constructor
------------------


Class representing a single MongoDB Server connection


.. js:class:: Server()

:param string host: the server host
:param number port: the server port
:param object [options]: optional options for insert command


Options
- **readPreference** {String, default:null}, set's the read preference (Server.READ_PRIMAR, Server.READ_SECONDARY_ONLY, Server.READ_SECONDARY)
- **ssl** {Boolean, default:false}, use ssl connection (needs to have a mongod server with ssl support)
- **slaveOk** {Boolean, default:false}, legacy option allowing reads from secondary, use **readPrefrence** instead.
- **poolSize** {Number, default:1}, number of connections in the connection pool, set to 1 as default for legacy reasons.
- **socketOptions** {Object, default:null}, an object containing socket options to use (noDelay:(boolean), keepAlive:(number), timeout:(number))
- **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) {}})**.
- **auto_reconnect** {Boolean, default:false}, reconnect on error.

78 changes: 39 additions & 39 deletions _sources/github/github.txt
Expand Up @@ -16,7 +16,7 @@ Web frameworks using MongoDB
* - **Activity Level**
- .. image:: ../static/active.png
* - **Last push**
- 0:19:12 on 12/3/2012
- 16:2:27 on 13/3/2012
* - **Homepage**
- http://
* - **Url**
Expand All @@ -39,7 +39,7 @@ Web frameworks using MongoDB
* - **Activity Level**
- .. image:: ../static/active.png
* - **Last push**
- 3:0:43 on 9/3/2012
- 3:4:26 on 16/3/2012
* - **Homepage**
- http://
* - **Url**
Expand All @@ -62,7 +62,7 @@ Web frameworks using MongoDB
* - **Activity Level**
- .. image:: ../static/active.png
* - **Last push**
- 12:40:40 on 6/2/2012
- 10:10:55 on 17/3/2012
* - **Homepage**
- http://search.npmjs.org/#/bread
* - **Url**
Expand Down Expand Up @@ -134,17 +134,17 @@ Object Document Modeling Libraries
* - **Activity Level**
- .. image:: ../static/active.png
* - **Last push**
- 18:58:47 on 9/3/2012
- 23:56:15 on 19/3/2012
* - **Homepage**
- http://
* - **Url**
- https://github.com/LearnBoost/mongoose
* - **Clone Url**
- https://github.com/LearnBoost/mongoose.git
* - **Forks**
- 178
- 182
* - **Watchers**
- 1876
- 1902

.. topic:: mongo-model

Expand All @@ -157,7 +157,7 @@ Object Document Modeling Libraries
* - **Activity Level**
- .. image:: ../static/active.png
* - **Last push**
- 14:48:3 on 31/2/2012
- 23:4:26 on 17/3/2012
* - **Homepage**
- http://http://alexeypetrushin.github.com/mongo-model
* - **Url**
Expand All @@ -167,7 +167,7 @@ Object Document Modeling Libraries
* - **Forks**
- 4
* - **Watchers**
- 35
- 38

.. topic:: mongodb-expressions

Expand Down Expand Up @@ -227,9 +227,9 @@ Content Management Systems
:header-rows: 0

* - **Activity Level**
- .. image:: ../static/nonactive.png
- .. image:: ../static/active.png
* - **Last push**
- 19:13:40 on 11/6/2011
- 6:25:45 on 18/3/2012
* - **Homepage**
- http://
* - **Url**
Expand All @@ -252,17 +252,17 @@ Content Management Systems
* - **Activity Level**
- .. image:: ../static/active.png
* - **Last push**
- 16:57:40 on 11/3/2012
- 10:54:59 on 16/3/2012
* - **Homepage**
- http://calip.so
* - **Url**
- https://github.com/cliftonc/calipso
* - **Clone Url**
- https://github.com/cliftonc/calipso.git
* - **Forks**
- 109
- 108
* - **Watchers**
- 778
- 787

Grid FS libraries or tools
--------------------------
Expand Down Expand Up @@ -312,9 +312,9 @@ Wrapper libraries to ease the use of development or provide simple ODM like beha
* - **Clone Url**
- https://github.com/guileen/node-mongoskin.git
* - **Forks**
- 24
- 25
* - **Watchers**
- 278
- 283

.. topic:: mongoq

Expand Down Expand Up @@ -383,7 +383,7 @@ Wrapper libraries to ease the use of development or provide simple ODM like beha
* - **Forks**
- 8
* - **Watchers**
- 127
- 130

.. topic:: mongode

Expand All @@ -406,7 +406,7 @@ Wrapper libraries to ease the use of development or provide simple ODM like beha
* - **Forks**
- 1
* - **Watchers**
- 36
- 37

.. topic:: node-mongodb-wrapper

Expand All @@ -419,17 +419,17 @@ Wrapper libraries to ease the use of development or provide simple ODM like beha
* - **Activity Level**
- .. image:: ../static/active.png
* - **Last push**
- 14:13:28 on 27/1/2012
- 17:45:57 on 19/3/2012
* - **Homepage**
- http://http://i.tv
* - **Url**
- https://github.com/idottv/node-mongodb-wrapper
* - **Clone Url**
- https://github.com/idottv/node-mongodb-wrapper.git
* - **Forks**
- 5
- 7
* - **Watchers**
- 28
- 31

.. topic:: mongodb-async

Expand Down Expand Up @@ -547,7 +547,7 @@ REST api's around MongoDB or resource based libraries
* - **Forks**
- 24
* - **Watchers**
- 129
- 136

.. topic:: lazyBum

Expand Down Expand Up @@ -779,7 +779,7 @@ Logging libraries or applications
* - **Activity Level**
- .. image:: ../static/active.png
* - **Last push**
- 19:45:47 on 1/3/2012
- 11:52:6 on 19/3/2012
* - **Homepage**
- http://dev/null
* - **Url**
Expand All @@ -789,7 +789,7 @@ Logging libraries or applications
* - **Forks**
- 1
* - **Watchers**
- 14
- 17

Monitoring applications or libraries
------------------------------------
Expand Down Expand Up @@ -911,9 +911,9 @@ Translation libraries or frameworks
* - **Clone Url**
- https://github.com/masylum/dialect.git
* - **Forks**
- 14
- 15
* - **Watchers**
- 92
- 96

Libraries or Applications for analytics
---------------------------------------
Expand All @@ -929,17 +929,17 @@ Libraries or Applications for analytics
* - **Activity Level**
- .. image:: ../static/active.png
* - **Last push**
- 17:10:35 on 11/3/2012
- 1:24:7 on 20/3/2012
* - **Homepage**
- http://http://square.github.com/cube
* - **Url**
- https://github.com/square/cube
* - **Clone Url**
- https://github.com/square/cube.git
* - **Forks**
- 136
- 138
* - **Watchers**
- 1686
- 1699

Libraries for the connect middleware
------------------------------------
Expand All @@ -963,9 +963,9 @@ Libraries for the connect middleware
* - **Clone Url**
- https://github.com/bartt/connect-session-mongo.git
* - **Forks**
- 4
- 5
* - **Watchers**
- 9
- 10

.. topic:: connect-mongodb

Expand All @@ -986,9 +986,9 @@ Libraries for the connect middleware
* - **Clone Url**
- https://github.com/masylum/connect-mongodb.git
* - **Forks**
- 21
- 23
* - **Watchers**
- 139
- 144

.. topic:: connect-mongo

Expand All @@ -1001,17 +1001,17 @@ Libraries for the connect middleware
* - **Activity Level**
- .. image:: ../static/active.png
* - **Last push**
- 15:8:21 on 6/3/2012
- 1:10:40 on 15/3/2012
* - **Homepage**
- http://
- http://http://kcbanner.github.com/connect-mongo/
* - **Url**
- https://github.com/kcbanner/connect-mongo
* - **Clone Url**
- https://github.com/kcbanner/connect-mongo.git
* - **Forks**
- 37
* - **Watchers**
- 101
- 109

Libraries or applications for continous integration
---------------------------------------------------
Expand All @@ -1027,17 +1027,17 @@ Libraries or applications for continous integration
* - **Activity Level**
- .. image:: ../static/active.png
* - **Last push**
- 14:19:55 on 11/3/2012
- 0:9:49 on 15/3/2012
* - **Homepage**
- http://
- http://http://ryankee.github.com/concrete
* - **Url**
- https://github.com/ryankee/concrete
* - **Clone Url**
- https://github.com/ryankee/concrete.git
* - **Forks**
- 17
* - **Watchers**
- 147
- 150

Exampe applications
-------------------
Expand Down Expand Up @@ -1086,5 +1086,5 @@ Exampe applications
* - **Forks**
- 1
* - **Watchers**
- 3
- 4

11 changes: 9 additions & 2 deletions api-generated/db.html
Expand Up @@ -2251,16 +2251,23 @@ <h2>dropDatabase<a class="headerlink" href="#dropdatabase" title="Permalink to t
<h2>Db.connect<a class="headerlink" href="#db-connect" title="Permalink to this headline"></a></h2>
<p>Connect to MongoDB using a url as documented at</p>
<p>www.mongodb.org/display/DOCS/Connections</p>
<dl class="docutils">
<dt>Options</dt>
<dd><ul class="first last simple">
<li><strong>uri_decode_auth</strong> {Boolean, default:false} uri decode the user name and password for authentication</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt id="Db.connect">
<tt class="descclassname">Db.</tt><tt class="descname">connect</tt><big>(</big><em>url</em>, <em>options</em>, <em>callback</em><big>)</big><a class="headerlink" href="#Db.connect" title="Permalink to this definition"></a></dt>
<tt class="descclassname">Db.</tt><tt class="descname">connect</tt><big>(</big><em>url</em><span class="optional">[</span>, <em>options</em><span class="optional">]</span>, <em>callback</em><big>)</big><a class="headerlink" href="#Db.connect" 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>url</strong> (<em>string</em>) &#8211; connection url for MongoDB.</li>
<li><strong>options</strong> (<em>object</em>) &#8211; additional options not covered by the url.</li>
<li><strong>[options]</strong> (<em>object</em>) &#8211; optional options for insert command</li>
<li><strong>callback</strong> (<em>function</em>) &#8211; callback returns the initialized db.</li>
</ul>
</td>
Expand Down

0 comments on commit 5b5cae3

Please sign in to comment.