Skip to content
SQLite3 Native Plugin for React Native for iOS, Android and Windows.
Branch: master
Clone or download
Latest commit b7e7820 May 12, 2019

React Native SQLite 2

SQLite3 Native Plugin for React Native for Android/iOS/Windows. This plugin provides a WebSQL-compatible API to store data in a react native app, by using a SQLite database on the native side.

Inspired by fantastic work done by Nolan Lawson. It should be a drop-in replacement for react-native-sqlite-storage. It works pretty well with PouchDB on React Native app.

The reason for this plugin is that react-native-sqlite-storage has some problems when used with PouchDB:

This plugin avoids these problems.

Getting started

$ npm install react-native-sqlite-2 --save

Mostly automatic installation

$ react-native link react-native-sqlite-2


In Xcode, add libsqlite3.tbd to your project's Build PhasesLink Binary With Libraries.

Manual installation


  1. In XCode, in the project navigator, right click LibrariesAdd Files to [your project's name]
  2. Go to node_modulesreact-native-sqlite-2 and add RNSqlite2.xcodeproj
  3. In Xcode, in the project navigator, select your project. Add libRNSqlite2.a to your project's Build PhasesLink Binary With Libraries
  4. Run your project (Cmd+R)<


  1. Open up android/app/src/main/java/[...]/
  • Add import dog.craftz.sqlite_2.RNSqlite2Package; to the imports at the top of the file
  • Add new RNSqlite2Package() to the list returned by the getPackages() method
  1. Append the following lines to android/settings.gradle:
    include ':react-native-sqlite-2'
    project(':react-native-sqlite-2').projectDir = new File(rootProject.projectDir, '../node_modules/react-native-sqlite-2/android')
  2. Insert the following lines inside the dependencies block in android/app/build.gradle:
    compile project(':react-native-sqlite-2')


  1. Open the solution in Visual Studio for your Windows apps.
  • Right click your solution file in the Explorer and click Add > Existing Project....

  • [UWP] Navigate to ./<app-name>/windows/RNSqlite2/ and add RNSqlite2.csproj.

    [WPF] Navigate to ./<app-name>/windows/RNSqlite2.Net46/ and add RNSqlite2.Net46.csproj.

  • Right click on your React Native Windows app under your solutions directory and click Add > Reference....

  • [UWP] Check the RNSqlite2 you just added and press Ok.

    [WPF] Check the RNSqlite2.Net46 you just added and press Ok.

  1. Open MainPage.cs in your app
  • Edit it like below:
using RNSqlite2;

      return new List<IReactPackage>
          new MainReactPackage(),
          new RNSqlite2Package(),


import SQLite from 'react-native-sqlite-2';

const db = SQLite.openDatabase('test.db', '1.0', '', 1);
db.transaction(function (txn) {
  txn.executeSql('DROP TABLE IF EXISTS Users', []);
  txn.executeSql('CREATE TABLE IF NOT EXISTS Users(user_id INTEGER PRIMARY KEY NOT NULL, name VARCHAR(30))', []);
  txn.executeSql('INSERT INTO Users (name) VALUES (:name)', ['nora']);
  txn.executeSql('INSERT INTO Users (name) VALUES (:name)', ['takuya']);
  txn.executeSql('SELECT * FROM `users`', [], function (tx, res) {
    for (let i = 0; i < res.rows.length; ++i) {
      console.log('item:', res.rows.item(i));

There is a test app in the test directory.

Using with PouchDB

It can be used with pouchdb-adapter-react-native-sqlite.

import PouchDB from 'pouchdb-react-native'
import SQLite from 'react-native-sqlite-2'
import SQLiteAdapterFactory from 'pouchdb-adapter-react-native-sqlite'

const SQLiteAdapter = SQLiteAdapterFactory(SQLite)
var db = new PouchDB('mydb', { adapter: 'react-native-sqlite' })


Row too big to fit into CursorWindow (Android)

You can set a limited windowSizeBytes for CursorWindow and try-catch the exception by adding following code to your MainApplication.onCreate in

try {
  Field field = CursorWindow.class.getDeclaredField("sCursorWindowSize");
  field.set(null, 100 * 1024 * 1024); //the 100MB is the new size
} catch (Exception e) {
  if (DEBUG_MODE) {

Note that it requires Android 9 (API level 28).

Original Cordova SQLite Bindings from Nolan Lawson

The issues and limitations for the actual SQLite can be found on this site.

You can’t perform that action at this time.