PouchDB databases come in two flavors: local and remote.
{% include anchor.html title=“Local databases” hash=“local–databases” %}
To create a local database, you simply call new PouchDB and give it a name:
var db = new PouchDB('kittens');
You can see a live example of this code.
{% include alert/start.html variant=“info” %}
Protip: whenever you see a live example in this guide, you can download it to follow along at home! For example, to run this example, just enter the following commands in your command prompt:
{% include alert/end.html %}
{% include anchor.html title=“Remote databases” hash=“remote-databases” %}
To create a remote database, you call new PouchDB and give it a path to a database in CouchDB.
var db = new PouchDB('http://localhost:5984/kittens');
{% include alert/start.html variant=“info” %} note: The remote database will not be created until you do an API call, e.g.: db.info(). The reason behind that is that the PouchDB constructor is completely synchronous, for ease of error handling (i.e. no asynchronous errors). {% include alert/end.html %}
The structure of a CouchDB URL is very simple:
http:// localhost:5984 /kittens ⌞_____⌟ ⌞____________⌟ ⌞_____⌟ | | | Protocol Where CouchDB database (https if itself is name Cloudant) hosted
If the remote database doesn't exist, then PouchDB will create it for you.
You can verify that your database is working by visiting the URL http://localhost:5984/kittens. You should see something like this:
{"db_name":"kittens","doc_count":0,"doc_del_count":0,"update_seq":0,"purge_seq":0,"compact_running":false,"disk_size":79,"data_size":0,"instance_start_time":"1410722558431975","disk_format_version":6,"committed_update_seq":0}
If instead you see:
{"error":"not_found","reason":"no_db_file"}
Then check to make sure that your remote CouchDB has started up correctly. Common errors (such as CORS) are listed here.
{% include anchor.html title=“Get basic info about the database” hash=“get-basic-info-about-the–database” %}
You can see basic information about the database by using the info() method.
db.info().then(function (info) { console.log(info); })
The local database should show something like:
{"doc_count":0,"update_seq":0,"db_name":"kittens"}
The remote database may have a bit more information:
{"db_name":"kittens","doc_count":0,"doc_del_count":0,"update_seq":0,"purge_seq":0,"compact_running":false,"disk_size":79,"data_size":0,"instance_start_time":"1410722558431975","disk_format_version":6,"committed_update_seq":0}
The most important bits of information are:
doc_count: the number of undeleted documents in the databasedb_name: the name of the database{% include anchor.html title=“Debugging” hash=“debugging” %}
You can use the normal developer tools to see what your database looks like under the hood.
In Chrome, just choose Overflow icon ☰ → Tools → Developer Tools. Then click the Resources tab, then IndexedDB, and you should see the following:
{% include img.html src=“dev_tools.png” alt=“Chrome Developer Tools” %}
This is the raw IndexedDB representation of your PouchDB, so it is very fine-grained. However, you may find it useful.
In Safari, your database will be under Develop → Show Web Inspector → Resources → Databases.
{% include img.html src=“safari_inspector.png” alt=“Web Inspector in Safari” %}
You can also enable debug logging by doing:
PouchDB.debug.enable('*');
And then disable it by doing:
PouchDB.debug.disable();
{% include anchor.html title=“Deleting your local database” hash=“deleting-your-local-database” %}
During development, it's often useful to destroy the local database, so you can see what your users will experience when they visit your site for the first time. A page refresh is not enough, because the data will still be there!
In Chrome, you can use the Clear Cache extension, which will add a trashcan icon to your toolbar, which you can click to delete all local data (IndexedDB, WebSQL, LocalStorage, cookies, etc.).
In Firefox, you can use the Clear Recent History+ add-on, so when you right-click a page you can quickly clear all data.
In Safari, you can simply click Safari → Clear History and Website Data.
{% include anchor.html title=“Differences between the local and remote databases” hash=“differences-between-the-local-and-remote-databases” %}
When you create a local PouchDB database, it uses whatever underlying datastore is available - IndexedDB in most browsers, WebSQL in older browsers, and LevelDB in Node.js.
When you create a remote PouchDB database, it communicates directly with the remote database – CouchDB, Cloudant, Couchbase, etc.
The goal of PouchDB is to allow you to seamlessly communicate with one or the other. You should not notice many differences between the two, except that of course the local one is much faster!
{% include anchor.html title=“Related API documentation” hash=“related-api-documentation” %}
{% include anchor.html title=“Next” hash=“next” %}
Now that you‘ve created some databases, let’s put some documents in 'em!