You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@couchdb.apache.org by ga...@apache.org on 2017/01/11 11:45:54 UTC

[07/15] couchdb-nano git commit: Add db.info doc.

Add db.info doc.


Project: http://git-wip-us.apache.org/repos/asf/couchdb-nano/repo
Commit: http://git-wip-us.apache.org/repos/asf/couchdb-nano/commit/93db52dc
Tree: http://git-wip-us.apache.org/repos/asf/couchdb-nano/tree/93db52dc
Diff: http://git-wip-us.apache.org/repos/asf/couchdb-nano/diff/93db52dc

Branch: refs/heads/master
Commit: 93db52dc167c2a36d53f8fa2057189dc6a486bb6
Parents: 4aac563
Author: Andr� Cruz <an...@msn.com>
Authored: Fri Feb 26 23:48:52 2016 +0000
Committer: Glynn Bird <gl...@gmail.com>
Committed: Wed Oct 26 14:32:13 2016 +0100

----------------------------------------------------------------------
 README.md | 11 +++++++++++
 1 file changed, 11 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/couchdb-nano/blob/93db52dc/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index 90c10bb..3bfbe57 100644
--- a/README.md
+++ b/README.md
@@ -31,6 +31,7 @@ minimalistic couchdb driver for node.js
   - [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.db.info([callback])](#nanodbinfocallback)
   - [nano.use(name)](#nanousename)
   - [nano.request(opts, [callback])](#nanorequestopts-callback)
   - [nano.config](#nanoconfig)
@@ -300,6 +301,16 @@ process.nextTick(function () {
 });
 ```
 
+### nano.db.info([callback])
+
+gets database information.
+
+nano.db.info(function(err, body) {
+  if (!err) {
+    console.log('got database info'', body);
+  }
+});
+
 ### nano.use(name)
 
 creates a scope where you operate inside `name`.