pouchdb-adapter-react-native-sqlite

PouchDB adapter using op-sqlite as its backing store on React Native. It's much faster than AsyncStorage.

As of v4.0.0, it no longer requires @craftzdog/pouchdb-adapter-websql-core. It now directly uses op-sqlite, so it's more efficient.

How to use

Installation

yarn add @op-engineering/op-sqlite react-native-quick-crypto @craftzdog/react-native-buffer @craftzdog/pouchdb-errors

Polyfill NodeJS APIs

Create a shim.ts file like so:

import { install } from 'react-native-quick-crypto'

install()

Configure babel to use the shim modules. First, you need to install babel-plugin-module-resolver.

yarn add --dev babel-plugin-module-resolver

Then, in your babel.config.js, add the plugin to swap the crypto, stream and buffer dependencies:

    plugins: [
      [
        'module-resolver',
        {
          extensions: ['.tsx', '.ts', '.js', '.json'],
          alias: {
            crypto: 'react-native-quick-crypto',
            stream: 'readable-stream',
            buffer: '@craftzdog/react-native-buffer',
            'pouchdb-errors': '@craftzdog/pouchdb-errors'
          },
        },
      ],
    ],

Then restart your bundler using yarn start --reset-cache.

Configure Metro (required for attachments)

pouchdb-adapter-utils (used internally for attachment processing) pulls in pouchdb-binary-utils and pouchdb-md5, which ship a browser build that Metro picks by default. That build breaks under React Native — binaryMd5 reads input via FileReader and data.size (undefined for a Buffer → NaN chunking), so the callback never fires and every putAttachment of a binary blob hangs. Force their Node builds in your metro.config.js:

const FORCE_NODE_BUILD = {
  'pouchdb-binary-utils': 'pouchdb-binary-utils/lib/index.js',
  'pouchdb-md5': 'pouchdb-md5/lib/index.js',
}

const defaultResolveRequest = config.resolver.resolveRequest
config.resolver.resolveRequest = (context, moduleName, platform) => {
  const nodeEntry = FORCE_NODE_BUILD[moduleName]
  if (nodeEntry) {
    return { type: 'sourceFile', filePath: require.resolve(nodeEntry) }
  }
  const resolve = defaultResolveRequest || context.resolveRequest
  return resolve(context, moduleName, platform)
}

module.exports = config

(config is your Metro config object, e.g. from getDefaultConfig(__dirname).)

Install PouchDB and adapter

Now it's ready to use PouchDB!

yarn add pouchdb-core pouchdb-mapreduce pouchdb-replication pouchdb-adapter-http pouchdb-adapter-react-native-sqlite

Create pouchdb.ts:

import PouchDB from 'pouchdb-core'
import HttpPouch from 'pouchdb-adapter-http'
import replication from 'pouchdb-replication'
import mapreduce from 'pouchdb-mapreduce'
import sqliteAdapter from 'pouchdb-adapter-react-native-sqlite'

export default PouchDB.plugin(HttpPouch)
  .plugin(replication)
  .plugin(mapreduce)
  .plugin(sqliteAdapter)

How to use PouchDB

import PouchDB from './pouchdb'

const pouch = new PouchDB('mydb', {
  adapter: 'react-native-sqlite',
  // Other options
})

Options

You can specify the following options in the PouchDB options:

• location: The location of the SQLite database file. See op-sqlite's docs for more details.
• encryptionKey: The encryption key for SQLCipher. See op-sqlite's docs for more details.

Design-doc views and filters

React Native's Hermes engine strips function source, so fn.toString() returns "function () { [bytecode] }" instead of the function body. PouchDB compiles design-doc map/filter functions by serializing them with .toString() and re-evaluating the result, so a view or filter built from a live function fails under Hermes with Property 'bytecode' doesn't exist.

Write design-doc map/filter functions as string literals so the source is preserved as-is:

// ❌ Hermes strips the source — `.toString()` becomes "[bytecode]"
await db.put({
  _id: '_design/by_name',
  views: {
    by_name: {
      map: function (doc) {
        emit(doc.name)
      }.toString(),
    },
  },
})

// ✅ Works — the source is a real string
await db.put({
  _id: '_design/by_name',
  views: { by_name: { map: 'function (doc) { emit(doc.name) }' } },
})

db.find (pouchdb-find / Mango), allDocs, and inline filter functions passed directly to replicate/sync are unaffected — they don't serialize a function.

Troubleshootings

Fails to install crypto shim with install() on launch

You amy get the following error when new arch is enabled:

 (NOBRIDGE) ERROR  Error: Failed to install react-native-quick-crypto: React Native is not running on-device. QuickCrypto can only be used when synchronous method invocations (JSI) are possible. If you are using a remote debugger (e.g. Chrome), switch to an on-device debugger (e.g. Flipper) instead.
 (NOBRIDGE) ERROR  TypeError: Cannot read property 'install' of undefined

• This is a know issue: Error: Failed to install react-native-quick-crypto: React Native is not running on-device. · Issue #333 · margelo/react-native-quick-crypto · GitHub

For now, you have to edit:

• lib/module/NativeQuickCrypto/NativeQuickCrypto.js

And comment them out:

  // Check if we are running on-device (JSI)
  // if (global.nativeCallSyncHook == null || QuickCryptoModule.install == null) {
  //   throw new Error('Failed to install react-native-quick-crypto: React Native is not running on-device. QuickCrypto can only be used when synchronous method invocations (JSI) are possible. If you are using a remote debugger (e.g. Chrome), switch to an on-device debugger (e.g. Flipper) instead.');
  // }

Contributing

See the contributing guide to learn how to contribute to the repository and the development workflow.

License

MIT © Takuya Matsuyama