Skip to content

Latest commit

 

History

History
293 lines (221 loc) · 11.3 KB

adapters.md

File metadata and controls

293 lines (221 loc) · 11.3 KB
layout title sidebar
2ColLeft
Adapters
nav.html

PouchDB is not a self-contained database; it is a CouchDB-style abstraction layer over other databases. By default, PouchDB ships with IndexedDB and WebSQL adapters in the browser, and a LevelDB adapter in Node.js.

PouchDB attempts to provide a consistent API that "just works" across every browser and JavaScript environment, and in most cases, you can just use the defaults. However, if you're trying to reach the widest possible audience, or if you want the best performance, then you will sometimes want to tinker with the adapter settings.

Topics:

{% include anchor.html title="PouchDB in the browser" hash="pouchdb_in_the_browser"%}

In the browser, PouchDB prefers IndexedDB, and falls back to WebSQL if IndexedDB is not available. As of 2014, the browser support looks like this:

Desktop

IE Firefox Chrome Safari Opera
Adapter IE Firefox Chrome Safari Opera
IndexedDB ✓ (10+) ✓ ✓ ✓ (8+) ✓
WebSQL ✓ ✓ ✓

Mobile

Safari iOS Opera Android BlackBerry Opera Chrome for Android Firefox for Android IE
Adapter iOS Safari Opera Mini Android Browser BlackBerry Browser Opera Mobile Chrome for Android Firefox for Android IE Mobile
IndexedDB ✓ (8+) ✓ (4.4+) ✓ (10+) ✓ (21+) ✓ ✓ ✓
WebSQL ✓ ✓ ✓ ✓ ✓

If you're ever curious which adapter is being used in a particular browser, you can use the following method:

var pouch = new PouchDB('myDB');
console.log(pouch.adapter); // prints either 'idb' or 'websql'

SQLite plugin for Cordova/PhoneGap

On Cordova/PhoneGap, it is often more performant to use the native SQLite database rather than the WebSQL database. This is also a good way to avoid HTML5 storage quotas.

Luckily, there is a SQLite Plugin that accomplishes exactly this. If you include this plugin in your project, then PouchDB will automatically pick it up based on the window.sqlitePlugin object.

However, this only occurs if the adapter is 'websql', not 'idb' (e.g. on Android 4.4+). To force PouchDB to use the WebSQL adapter, you can do:

var websqlPouch = new PouchDB('myDB', {adapter: 'websql'});

The SQLite plugin is known to pass the PouchDB test suite on both iOS and Android. You may run into issues on Windows Phone 8.

Experimental adapter plugins

As of PouchDB 2.2.3, we are building some experimental browser plugins that use backends other than IndexedDB and WebSQL. You are free to use them, but they are not yet part of the official release (although they pass our unit test suite at 100%).

Downloads:

LocalStorage plugin

If you need to support even older browsers, such as IE ≤ 9.0 and Opera Mini, you can use the pouchdb.localstorage.js plugin, which allows PouchDB to fall back to LocalStorage on browsers that don't support either IndexedDB or WebSQL. The es5-shims will also be necessary.

<script src="pouchdb.js"></script>
<script src="pouchdb.localstorage.js"></script>
<script>
  // this pouch is backed by LocalStorage
  var pouch = new PouchDB('mydb', {adapter: 'localstorage'});
</script>

{% include alert_start.html variant="warning"%} The LocalStorage plugin should be considered highly experimental, and the underlying structure may change in the future. Currently it stores all document IDs in memory, which works fine on small databases but may crash on larger databases. You can follow localstorage-down to track our progress. {% include alert_end.html %}

Memory plugin

If you want a quick database for your unit tests, you can use the pouchdb.memory.js plugin, which offers a pure in-memory PouchDB:

<script src="pouchdb.js"></script>
<script src="pouchdb.memory.js"></script>
<script>
  // this pouch is ephemeral; it only exists in memory
  var pouch = new PouchDB('mydb', {adapter: 'memory'});
</script>

This pouch will act exactly like a normal one – replicating, storing attachments, pagination, etc. – but it will be deleted as soon as the user closes their browser. However, multiple PouchDB objects with the same database name will share the same data:

// pouch1 and pouch2 will share the same data
var pouch1 = new PouchDB('myDB', {adapter: 'memory'});
var pouch2 = new PouchDB('myDB', {adapter: 'memory'});

// pouch3 will have its own data
var pouch3 = new PouchDB('myOtherDB', {adapter: 'memory'});

Alternative IndexedDB adapter

We are currently experimenting with a LevelDown-based IndexedDB adapter (using level-js) which may eventually replace the current IndexedDB adapter. If you would like to experiment with this, you may use the pouchdb.idb-alt.js plugin:

<script src="pouchdb.js"></script>
<script src="pouchdb.idb-alt.js"></script>
<script>
  // this pouch is backed by IndexedDB but uses
  // a different structure than the main one
  var pouch = new PouchDB('mydb', {adapter: 'idb-alt'});
</script>

This adapter does not currently offer any advantages over the 'idb' adapter, but PouchDB developers will be interested in testing it.

{% include anchor.html title="PouchDB in Node.js" hash="pouchdb_in_node_js"%}

In Node.js, the adapter situation is much simpler than in browsers. By default, if you create a PouchDB like this one:

var pouch = new PouchDB('./path/to/db');

then a LevelDB-based database will be created in the directory ./path/to/db.

Plus, since the LevelDB adapter is based on LevelDOWN, you also benefit from the rich ecosystem of LevelDOWN-based adapters. They may be installed using plain old npm install and require(). Below are a few examples.

In-memory

Just as in the browser, you can create a pure in-memory pouch based on MemDOWN:

$ npm install memdown

then:

var pouch = new PouchDB('myDB', {db: require('memdown')});

Notice that in Node.js, we use the key 'db' instead of 'adapter'. In Node.js the adapter is always called 'leveldb' for historical reasons.

Riak-based adapter

This pouch is backed by RiakDOWN:

$ npm install riakdown

then:

var pouch = new PouchDB('riak://localhost:8087/somebucket', {db: require('riakdown')});

More LevelDOWN adapters

There are many other LevelDOWN-based plugins – far too many to list here. You can find a mostly-complete list on Github that includes implementations on top of MySQL, Windows Azure Table Storage, and SQLite.

{% include alert_start.html variant="warning"%} We do not currently test against any LevelDOWN adapters other than LevelDB, so these backends should be considered very experimental. {% include alert_end.html%}

{% include anchor.html title="PouchDB over HTTP" hash="pouchdb_over_http"%}

In both the browser and in Node.js, PouchDB can also function as a straightforward API on top of any CouchDB-compliant database, such as IrisCouch, Cloudant, and Couchbase Sync Gateway:

var pouch = new PouchDB('http://my-site.com:5984/my-db');
var securePouch = new PouchDB('https://my-secure-site.com:5984/my-secure-db');

However, we do not currently claim to support any database at 100% fidelity except for CouchDB, so your mileage may vary when syncing with the others. We will add databases to our supported list as we increase our test coverage.

If you are ever unsure what to do, consider replicating from PouchDB to a CouchDB, then from that CouchDB to one of the other servers.

PouchDB Server

PouchDB Server is a standalone REST server that implements the CouchDB API, while using a LevelDB-based PouchDB under the hood. Again, this is not an officially supported server yet.

PouchDB Express

The underlying module for PouchDB Server, Express PouchDB is an Express submodule that mimics most of the CouchDB API within your Express application.

{% include anchor.html title="More resources" hash="more_resources"%}

The best place to look for information on which browsers support which databases is caniuse.com. You can consult their tables on browser support for various backends: