Node.js-Nano是一个简约CouchDB客户端

[](http://yld.io/contact?source=github-nano)[](https://gitter.im/dscape/nano)[](https://travis-ci.org/dscape/nano)[](https://david-dm.org/dscape/nano)[](http://browsenpm.org/package/nano) # nano minimalistic couchdb driver for node.js `nano` features: * **minimalistic** - there is only a minimum of abstraction between you and couchdb * **pipes** - proxy requests from couchdb directly to your end user * **errors** - errors are proxied directly from couchdb: if you know couchdb you already know `nano`. ## installation 1. install [npm][1] 2. `npm install nano` ## table of contents - [getting started](#getting-started) - [tutorials & screencasts](#tutorials-examples-in-the-wild--screencasts) - [configuration](#configuration) - [database functions](#database-functions) - [nano.db.create(name, [callback])](#nanodbcreatename-callback) - [nano.db.get(name, [callback])](#nanodbgetname-callback) - [nano.db.destroy(name, [callback])](#nanodbdestroyname-callback) - [nano.db.list([callback])](#nanodblistcallback) - [nano.db.compact(name, [designname], [callback])](#nanodbcompactname-designname-callback) - [nano.db.replicate(source, target, [opts], [callback])](#nanodbreplicatesource-target-opts-callback) - [nano.db.changes(name, [params], [callback])](#nanodbchangesname-params-callback) - [nano.db.follow(name, [params], [callback])](#nanodbfollowname-params-callback) - [nano.use(name)](#nanousename) - [nano.request(opts, [callback])](#nanorequestopts-callback) - [nano.config](#nanoconfig) - [nano.updates([params], [callback])](#nanoupdatesparams-callback) - [nano.followUpdates([params], [callback])](#nanofollowupdatesparams-callback) - [document functions](#document-functions) - [db.insert(doc, [params], [callback])](#dbinsertdoc-params-callback) - [db.destroy(docname, rev, [callback])](#dbdestroydocname-rev-callback) - [db.get(docname, [params], [callback])](#dbgetdocname-params-callback) - [db.head(docname, [callback])](#dbheaddocname-callback) - [db.copy(src_doc, dest_doc, opts, [callback])](#dbcopysrc_doc-dest_doc-opts-callback) - [db.bulk(docs, [params], [callback])](#dbbulkdocs-params-callback) - [db.list([params], [callback])](#dblistparams-callback) - [db.fetch(docnames, [params], [callback])](#dbfetchdocnames-params-callback) - [db.fetchRevs(docnames, [params], [callback])](#dbfetchRevsdocnames-params-callback) - [multipart functions](#multipart-functions) - [db.multipart.insert(doc, attachments, [params], [callback])](#dbmultipartinsertdoc-attachments-params-callback) - [db.multipart.get(docname, [params], [callback])](#dbmultipartgetdocname-params-callback) - [attachments functions](#attachments-functions) - [db.attachment.insert(docname, attname, att, contenttype, [params], [callback])](#dbattachmentinsertdocname-attname-att-contenttype-params-callback) - [db.attachment.get(docname, attname, [params], [callback])](#dbattachmentgetdocname-attname-params-callback) - [db.attachment.destroy(docname, attname, [params], [callback])](#dbattachmentdestroydocname-attname-rev-callback) - [views and design functions](#views-and-design-functions) - [db.view(designname, viewname, [params], [callback])](#dbviewdesignname-viewname-params-callback) - [db.show(designname, showname, doc_id, [params], [callback])](#dbshowdesignname-showname-doc_id-params-callback) - [db.atomic(designname, updatename, docname, [body], [callback])](#dbatomicdesignname-updatename-docname-body-callback) - [db.search(designname, viewname, [params], [callback])](#dbsearchdesignname-searchname-params-callback) - [using cookie authentication](#using-cookie-authentication) - [advanced features](#advanced-features) - [extending nano](#extending-nano) - [pipes](#pipes) - [tests](#tests) ## getting started to use `nano` you need to connect it to your couchdb install, to do that: ``` js var nano = require('nano')('http://localhost:5984'); ``` to create a new database: ``` js nano.db.create('alice'); ``` and to use it: ``` js var alice = nano.db.use('alice'); ``` in this examples we didn't specify a `callback` function, the absence of a callback means _"do this, ignore what happens"_. in `nano` the callback function receives always three arguments: * `err` - the error, if any * `body` - the http _response body_ from couchdb, if no error. json parsed body, binary for non json responses * `header` - the http _response header_ from couchdb, if no error a simple but complete example using callbacks is: ``` js var nano = require('nano')('http://localhost:5984'); // clean up the database we created previously nano.db.destroy('alice', function() { // create a new database nano.db.create('alice', function() { // specify the database we are going to use var alice = nano.use('alice'); // and insert a document in it alice.insert({ crazy: true }, 'rabbit', function(err, body, header) { if (err) { console.log('[alice.insert] ', err.message); return; } console.log('you have inserted the rabbit.') console.log(body); }); }); }); ``` if you run this example(after starting couchdb) you will see: you have inserted the rabbit. { ok: true, id: 'rabbit', rev: '1-6e4cb465d49c0368ac3946506d26335d' } you can also see your document in [futon](http://localhost:5984/_utils). ## configuration configuring nano to use your database server is as simple as: ``` js var nano = require('nano')('http://localhost:5984') , db = nano.use('foo') ; ``` however if you don't need to instrument database objects you can simply: ``` js // nano parses the url and knows this is a database var db = require('nano')('http://localhost:5984/foo'); ``` you can also pass options to the require: ``` js // nano parses the url and knows this is a database var db = require('nano')('http://localhost:5984/foo'); ``` to specify further configuration options you can pass an object literal instead: ``` js // nano parses the url and knows this is a database var db = require('nano')( { "url" : "http://localhost:5984/foo" , "requestDefaults" : { "proxy" : "http://someproxy" } , "log" : function (id, args) { console.log(id, args); } }); ``` Please check [request] for more information on the defaults. They support features like cookie jar, proxies, ssl, etc. You can tell nano to not parse the url (maybe the server is behind a proxy, is accessed through a rewrite rule or other): ```js // nano does not parse the url and return the server api // "http://localhost:5984/prefix" is the CouchDB server root var couch = require('nano')( { "url" : "http://localhost:5984/prefix" "parseUrl" : false }); var db = couch.use('foo'); ``` ### pool size and open sockets a very important configuration parameter if you have a high traffic website and are using nano is setting up the `pool.size`. by default, the node.js http global agent (client) has a certain size of active connections that can run simultaneously, while others are kept in a queue. pooling can be disabled by setting the `agent` property in `requestDefaults` to false, or adjust the global pool size using: ``` js http.globalAgent.maxSockets = 20; ``` you can also increase the size in your calling context using `requestDefaults` if this is problematic. refer to the [request] documentation and examples for further clarification. here's an example explicitly using the keep alive agent (installed using `npm install agentkeepa