PouchDB is a pocket-sized database.
Pull request Compare This branch is 3511 commits behind pouchdb:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.
qunit
testapp
README.md
fileserver.js
idb.js
perf.html
test.html
test.js

README.md

Tests are passing and this is ready for more usage/feedback. Works with Chrome 11/12 and Firefox 4.

PouchDB ( Portable CouchDB JavaScript implementation )

PouchDB is a complete implementation of the CouchDB storage and views API that supports peer-to-peer replication with other CouchDB instances. The browser version is written for IndexedDatabase (part of HTML5). An additional implementation is in progress for leveldb.

Storage and Consistency

Unlike the other current couch-like browser APIs built on WebStorage (http://dev.w3.org/html5/webstorage/) PouchDB's goal is to maintain the same kinds of consistency guarantees Apache CouchDB provides across concurrent connections across the multiple-tabs a user might be using to concurrently access an PouchDB database. This is something that just isn't possible with the BrowserStorage API previous libraries like BrowserCouch and lawnchair use.

PouchDB also keeps a by-sequence index across the entire database. This means that, just like Apache CouchDB, PouchDB can replicate with other CouchDB instances and provide the same conflict resolution system for eventual consistency across nodes.

BrowserCouch

At this time PouchDB is completely independent from BrowserCouch. The main reason is just to keep the code base concise and focused as the IndexedDatabase specification is being flushed out.

After IndexedDatabase is more solidified it's possible that BrowserCouch and PouchDB might merge to provide a simple fallback option for browsers the do not yet support IndexedDatabase.

API

createCouch(options[, callback])

This method gets an existing database if one exists or creates a new one if one does not exist.

The first argument is an options object. The only required option is name, all others are optional. The second argument an optional success callback.

  • 'name' - The name of the PouchDB you would like to get/create.
  • 'description' - A description of the database. If one is not set then PouchDB will generate one since it is required by the IndexedDatabase API.
  • 'success' - A callback function taking one argument, the PouchDB database. The second argument to createCouch will be used if passed.
  • 'error' - An error handler callback taking one argument, the error.
  createCouch({name:'test'}, function (couch) {
    // Use my CouchDB
  })

couch

The subject of the of createCouch success callback. This is primary PouchDB API.

couch.get(docid, options)

couch.remove(doc, options)

couch.post(doc, options)

couch.changes

couch.changes(options)

couch.changes.addListener(listener)

couch.changes.removeListener(listener)

couch.bulk(docs, options)