Apache PouchDB™ is an open-source JavaScript database inspired by Apache CouchDB that is designed to run well within the browser.
{% include anchor.html class=“h3” title=“Quick Start” hash=“file” %}
<script src="https://cdn.jsdelivr.net/npm/pouchdb@{{site.version}}/dist/pouchdb.min.js"></script> <script> const db = new PouchDB('my_database'); </script>
PouchDB can also be directly downloaded:
If you are using PouchDB in Internet Explorer a Promise and Fetch polyfill will be needed.
{% include anchor.html class=“h3” title=“npm” hash=“npm” %}
PouchDB can be installed through npm:
{% highlight bash %}npm install --save pouchdb{% endhighlight %}
After installing, call require() to use it:
{% highlight javascript %} const PouchDB = require(‘pouchdb’); const db = new PouchDB(‘my_database’); {% endhighlight %}
PouchDB can be used either in Node or in the browser. A bundler such as Browserify, Webpack, or Rollup is needed for browser usage.
If you're only using PouchDB in the browser, you can use pouchdb-browser for faster install times:
{% highlight bash %}npm install --save pouchdb-browser{% endhighlight %}
{% highlight javascript %} const PouchDB = require(‘pouchdb-browser’); const db = new PouchDB(‘my_database’); {% endhighlight %}
See [custom builds]({{ site.baseurl }}/custom.html) for more options.
{% include anchor.html class=“h3” title=“CDNs” hash=“cdn” %}
PouchDB is hosted at these CDNs:
{% highlight bash %}bower install --save pouchdb{% endhighlight %}
{% include anchor.html class=“h3” title=“Past releases” hash=“past-releases” %}
For past releases and changelog, check out the Github releases page.
{% include anchor.html class=“h3” title=“Plugins” hash=“plugins” %}
For third-party plugins, see the plugins page.
{% include anchor.html class=“h3” title=“Custom builds” hash=“custom” %}
For custom builds and first-party plugins, see the [custom builds]({{ site.baseurl }}/custom.html) page.
[latest]: https://github.com/apache/pouchdb/releases/download/{{ site.version }}/pouchdb-{{ site.version }}.js [latest-min]: https://github.com/apache/pouchdb/releases/download/{{ site.version }}/pouchdb-{{ site.version }}.min.js