commit | 9fc57cc645061c8d33a198cbf9976dfaefee7980 | [log] [tgz] |
---|---|---|
author | Nuno Job <nunojobpinto@gmail.com> | Mon Aug 15 02:44:09 2011 +0200 |
committer | Nuno Job <nunojobpinto@gmail.com> | Mon Aug 15 02:44:09 2011 +0200 |
tree | d8949dd48cf2c02ea30245b1c6a130d46555c07a | |
parent | a925f90d02494f71b04464a109f107187f09f0e4 [diff] |
Documentation Added first sketch of documentation Changed Replication and Insert Tests
Nano (short for NanoCouch) is a minimalistic CouchDB driver for Node.js.
npm install nano
A quick example on using nano
. You can follow it by npm install nano
and entering node
in the console.
In nano
callback always return three arguments:
err: The error, if any. Check error.js for more info. headers: The HTTP response headers from CouchDB, if no error. response: The HTTP response body from CouchDB, if no error.
Because in nano
you can do database operations you are not bound to one and only one database. The first thing you do is load the module pointing either providing a JSON configuration object or a string that represents the relative file path of that config, e.g. ‘cfg/tests.js’. Do refer to ‘cfg/tests.js’ for a sample.
var nano = require('nano')('./cfg/tests.js');
Now you can do your database operations using nano. These include things like create, delete or list databases. Let's create a database to store some documents:
nano.db.create("alice");
Where is my callback? Well in nano you have the option of not having a callback and say “I don't care”.
Of course now you want to insert some documents and you wish you had the callback, so let's add it:
// Clean up the database we created previously nano.db.destroy("alice", function(err,headers,response) { nano.db.create("alice", function(){ // Specify the database we are going to use var alicedb = nano.use("alice"); alicedb.insert("rabbit", {crazy: true}, function(e,h,r){ if(e) { throw e; } console.log("You have inserted the rabbit.") }); }); });
The alicedb.use
method creates a scope
where you operate inside a single database. This is just a convenience so you don't have to specify the database name every single time you do an update or delete.
Don't forget to delete the database you create:
nano.db.destroy("alice");
Assuming var db = nano.use("somedb");
:
db.insert(doc_name,doc,callback) db.destroy(doc_name,rev,callback) db.get(doc_name,callback) db.list(callback)
nano.db.create(db_name,callback) nano.db.destroy(db_name,callback) nano.db.get(db_name,callback) nano.db.list(callback) nano.db.compact(db_name,callback) nano.db.replicate(source,target,continuous,callback) // Continuous is optional
nano.use(db_name) nano.request(opts,callback)
You can use nano.scope
instead of nano.use
. They are both also available inside db, e.g. nano.db.scope
.
When using a database with nano.use
you can still replicate
, compact
, and list
the database you are using. e.g. to list you can use db.info
(because db.list
is for listing documents). Other methods remain the same, e.g. db.replicate
.
Some future plans are mostly:
_changes
feedGreat segway to contribute.
Everyone is welcome to contribute.
git checkout -b my_branch
git push origin my_branch
To run the tests simply browse to test/
and ./run
. Don't forget to install the packages referred as dev dependencies in package.json
.
Always make sure all the tests pass before sending in your pull request! OR I'll tell Santa!
_ / _) ROAR! I'm a vegan! .-^^^-/ / __/ / /__.|_|-|_|
git clone git://github.com/dscape/nano.git
(oO)--',- in caos