react-native-sqlite-storage

SQLite3 Native Plugin for React Native for both Android (Classic and Native), iOS and Windows

Foundation of this library is based on Chris Brody's Cordova SQLite plugin.

Features:

1. iOS and Android supported via identical JavaScript API.
2. Android in pure Java and Native modes
3. SQL transactions
4. JavaScript interface via plain callbacks or Promises.
5. Pre-populated SQLite database import from application bundle and sandbox
6. Windows supports callback API, identical to iOS and Android

There are sample apps provided in test directory that can be used in with the AwesomeProject generated by React Native. All you have to do is to copy one of those files into your AwesomeProject replacing index.ios.js.

Please let me know your projects that use these SQLite React Native modules. I will list them in the reference section. If there are any features that you think would benefit this library please post them.

The library has been tested with React 16.2 (and earlier) and XCode 7,8,9 - it works fine out of the box without any need for tweaks or code changes. For XCode 7,8 vs. XCode 6 the only difference is that sqlite ios library name suffix is tbd instead of dylib.

Version 3.2 is the first version compatible with RN 0.40.

Installation

  npm install --save react-native-sqlite-storage

Then follow the instructions for your platform to link react-native-sqlite-storage into your project

Promises

To enable promises, run

1SQLite.enablePromise(true);

iOS

Standard Method

** React Native 0.60 and above ** Run cd ios && pod install && cd ... Linking is not required in React Native 0.60 and above

** React Native 0.59 and below **

Step 1. Install Dependencies

With CocoaPods:

Add this to your Podfile which should be located inside the ios project subdirectory

1pod 'React', :path => '../node_modules/react-native'
2pod 'react-native-sqlite-storage', :path => '../node_modules/react-native-sqlite-storage'

Or use the sample Podfile included in the package by copying it over to ios subdirectory and replacing AwesomeProject inside of it with the name of your RN project.

Refresh the Pods installation

1pod install

OR

1pod update

Done, skip to Step 2.

Without CocoaPods:

This command should be executed in the root directory of your RN project

1react-native link

rnpm and xcode are dependencies of this project and should get installed with the module but in case there are issue running rnpm link and rnpm/xcode are not already installed you can try to install it globally as follows:

1npm -g install rnpm xcode

After linking project should like this:

Step 1a. If rnpm link does not work for you you can try manually linking according to the instructions below:

Drag the SQLite Xcode project as a dependency project into your React Native XCode project

XCode SQLite libraries dependency set up

Add libSQLite.a (from Workspace location) to the required Libraries and Frameworks. Also add sqlite3.0.tbd (XCode 7) or libsqlite3.0.dylib (XCode 6 and earlier) in the same fashion using Required Libraries view (Do not just add them manually as the build paths will not be properly set)

Step 2. Application JavaScript require

Add var SQLite = require('react-native-sqlite-storage') to your index.ios.js

Step 3. Write application JavaScript code using the SQLite plugin

Add JS application code to use SQLite API in your index.ios.js etc. Here is some sample code. For full working example see test/index.ios.callback.js. Please note that Promise based API is now supported as well with full examples in the working React Native app under test/index.ios.promise.js

1errorCB(err) {
2  console.log("SQL Error: " + err);
3},
4
5successCB() {
6  console.log("SQL executed fine");
7},
8
9openCB() {
10  console.log("Database OPENED");
11},
12
13var db = SQLite.openDatabase("test.db", "1.0", "Test Database", 200000, openCB, errorCB);
14db.transaction((tx) => {
15  tx.executeSql('SELECT * FROM Employees a, Departments b WHERE a.department = b.department_id', [], (tx, results) => {
16      console.log("Query completed");
17
18      // Get rows with Web SQL Database spec compliance.
19
20      var len = results.rows.length;
21      for (let i = 0; i < len; i++) {
22        let row = results.rows.item(i);
23        console.log(`Employee name: ${row.name}, Dept Name: ${row.deptName}`);
24      }
25
26      // Alternatively, you can use the non-standard raw method.
27
28      /*
29        let rows = results.rows.raw(); // shallow copy of rows Array
30
31        rows.map(row => console.log(`Employee name: ${row.name}, Dept Name: ${row.deptName}`));
32      */
33    });
34});

How to use (Android):

** React Native 0.60 and above ** If you would like to use the devices SQLite there are no extra steps. However, if you would like to use the SQLite bundled with this library (includes support for FTS5), add the following to your react-native.config.js

1module.exports = {
2  ...,
3  dependencies: {
4    ...,
5    "react-native-sqlite-storage": {
6      platforms: {
7        android: {
8          sourceDir:
9            "../node_modules/react-native-sqlite-storage/platforms/android-native",
10          packageImportPath: "import io.liteglue.SQLitePluginPackage;",
11          packageInstance: "new SQLitePluginPackage()"
12        }
13      }
14    }
15    ...
16  }
17  ...
18};

** React Native 0.59 and below **

Step 1 - Update Gradle Settings (located under Gradle Settings in Project Panel)

1// file: android/settings.gradle
2...
3
4include ':react-native-sqlite-storage'
5project(':react-native-sqlite-storage').projectDir = new File(rootProject.projectDir, '../node_modules/react-native-sqlite-storage/platforms/android') // react-native-sqlite-storage >= 4.0.0
6// IMPORTANT: if you are working with a version less than 4.0.0 the project directory is '../node_modules/react-native-sqlite-storage/src/android'

Step 2 - Update app module Gradle Build script (located under Gradle Settings in Project Panel)

1// file: android/app/build.gradle
2...
3
4dependencies {
5    ...
6    implementation project(':react-native-sqlite-storage')
7}

Step 3 - Register React Package (this should work on React version but if it does not , try the ReactActivity based approach. Note: for version 3.0.0 and below you would have to pass in the instance of your Activity to the SQLitePluginPackage constructor

1...
2import org.pgsqlite.SQLitePluginPackage;
3
4public class MainActivity extends Activity implements DefaultHardwareBackBtnHandler {
5
6    private ReactInstanceManager mReactInstanceManager;
7    private ReactRootView mReactRootView;
8
9    @Override
10    protected void onCreate(Bundle savedInstanceState) {
11        super.onCreate(savedInstanceState);
12        mReactRootView = new ReactRootView(this);
13        mReactInstanceManager = ReactInstanceManager.builder()
14                .setApplication(getApplication())
15                .setBundleAssetName("index.android.bundle")  // this is dependant on how you name you JS files, example assumes index.android.js
16                .setJSMainModuleName("index.android")        // this is dependant on how you name you JS files, example assumes index.android.js
17                .addPackage(new MainReactPackage())
18                .addPackage(new SQLitePluginPackage())       // register SQLite Plugin here
19                .setUseDeveloperSupport(BuildConfig.DEBUG)
20                .setInitialLifecycleState(LifecycleState.RESUMED)
21                .build();
22        mReactRootView.startReactApplication(mReactInstanceManager, "AwesomeProject", null); //change "AwesomeProject" to name of your app
23        setContentView(mReactRootView);
24    }
25...
26

Alternative approach on newer versions of React Native (0.18+). Note: for version 3.0.0 and below you would have to pass in the instance of your Activity to the SQLitePluginPackage constructor

1import org.pgsqlite.SQLitePluginPackage;
2
3public class MainApplication extends Application implements ReactApplication {
4  ......
5
6  /**
7   * A list of packages used by the app. If the app uses additional views
8   * or modules besides the default ones, add more packages here.
9   */
10    @Override
11    protected List<ReactPackage> getPackages() {
12      return Arrays.<ReactPackage>asList(
13        new SQLitePluginPackage(),   // register SQLite Plugin here
14        new MainReactPackage());
15    }
16}

Step 4 - Require and use in Javascript - see full examples (callbacks and Promise) in test directory.

1// file: index.android.js
2
3var React = require('react-native');
4var SQLite = require('react-native-sqlite-storage')
5...

Windows

** RNW 0.63 with Autolinking and above **

No manual steps required

** React Native 0.62 **

Step 1: Update the solution file

Add the SQLitePlugin project to your solution.

1. Open the solution in Visual Studio 2019
2. Right-click Solution icon in Solution Explorer > Add > Existing Project
3. Select node_modules\react-native-sqlite-storage\platforms\windows\SQLitePlugin\SQLitePlugin.vcxproj

Step 2: Update the .vcxproj file

Add a reference to SQLitePlugin to your main application project. From Visual Studio 2019:

1. Right-click main application project > Add > Reference...
2. Check SQLitePlugin from Solution Projects

Step 3: Update the pch.h file

Add #include "winrt/SQLitePlugin.h".

Step 4: Register the package in App.cpp

Add PackageProviders().Append(winrt::SQLitePlugin::ReactPackageProvider()); before InitializeComponent();.

Refer to this guide for more details: https://microsoft.github.io/react-native-windows/docs/next/native-modules-using

Setting up your project to import a pre-populated SQLite database from application for iOS

Step 1 - Create 'www' folder.

Create a folder called 'www' (yes must be called precisely that else things won't work) in the project folder via Finder

Step 2 - Create the database file

Copy/paste your pre-populated database file into the 'www' folder. Give it the same name you are going to use in openDatabase call in your application

Step 3 - Add file to project

in XCode, right click on the main folder and select Add Files to 'your project name'

Step 4 - Choose files to add

In the Add Files dialog, navigate to the 'www' directory you created in Step 1, select it, make sure you check the option to Create Folder Reference

Step 5 - Verify project structure

Ensure your project structure after previous steps are executed looks like this

Step 6 - Adjust openDatabase call

Modify you openDatabase call in your application adding createFromLocation param. If you named your database file in step 2 'testDB' the openDatabase call should look like something like this:

1
2  ...
3  1.SQLite.openDatabase({name : "testDB", createFromLocation : 1}, okCallback,errorCallback);
4  // default - if your folder is called www and data file is named the same as the dbName - testDB in this example
5  2.SQLite.openDatabase({name : "testDB", createFromLocation : "~data/mydbfile.sqlite"}, okCallback,errorCallback);
6  // if your folder is called data rather than www or your filename does not match the name of the db
7  3.SQLite.openDatabase({name : "testDB", createFromLocation : "/data/mydbfile.sqlite"}, okCallback,errorCallback);
8  // if your folder is not in app bundle but in app sandbox i.e. downloaded from some remote location.
9  ...
10

For Android, the www directory is always relative to the assets directory for the app: src/main/assets

Enjoy!

Opening a database

Opening a database is slightly different between iOS and Android. Where as on Android the location of the database file is fixed, there are three choices of where the database file can be located on iOS. The 'location' parameter you provide to openDatabase call indicated where you would like the file to be created. This parameter is neglected on Android.

WARNING: the default location on iOS has changed in version 3.0.0 - it is now a no-sync location as mandated by Apple so the release is backward incompatible.

To open a database in default no-sync location (affects iOS only)::

1SQLite.openDatabase({name: 'my.db', location: 'default'}, successcb, errorcb);

To specify a different location (affects iOS only):

1SQLite.openDatabase({name: 'my.db', location: 'Library'}, successcb, errorcb);

where the location option may be set to one of the following choices:

• default: Library/LocalDatabase subdirectory - NOT visible to iTunes and NOT backed up by iCloud
• Library: Library subdirectory - backed up by iCloud, NOT visible to iTunes
• Documents: Documents subdirectory - visible to iTunes and backed up by iCloud
• Shared: app group's shared container - see next section

The original webSql style openDatabase still works and the location will implicitly default to 'default' option:

1SQLite.openDatabase("myDatabase.db", "1.0", "Demo", -1);

Opening a database in an App Group's Shared Container (iOS)

If you have an iOS app extension which needs to share access to the same DB instance as your main app, you must use the shared container of a registered app group.

Assuming you have already set up an app group and turned on the "App Groups" entitlement of both the main app and app extension, setting them to the same app group name, the following extra steps must be taken:

Step 1 - supply your app group name in all needed Info.plists

In both ios/MY_APP_NAME/Info.plist and ios/MY_APP_EXT_NAME/Info.plist (along with any other app extensions you may have), you simply need to add the AppGroupName key to the main dictionary with your app group name as the string value:

1<plist version="1.0">
2<dict>
3  <!-- ... -->
4  <key>AppGroupName</key>
5  <string>MY_APP_GROUP_NAME</string>
6  <!-- ... -->
7</dict>
8</plist>

Step 2 - set shared database location

When calling SQLite.openDatabase in your React Native code, you need to set the location param to 'Shared':

1SQLite.openDatabase({name: 'my.db', location: 'Shared'}, successcb, errorcb);

Importing a pre-populated database.

You can import an existing - prepopulated database file into your application. Depending on your instructions in openDatabase call, the sqlite-storage will look at different places to locate you pre-populated database file.

Use this flavor of openDatabase call, if your folder is called www and data file is named the same as the dbName - testDB in this example

1SQLite.openDatabase({name : "testDB", createFromLocation : 1}, okCallback,errorCallback);

Use this flavor of openDatabase call if your folder is called data rather than www or your filename does not match the name of the db. In this case db is named testDB but the file is mydbfile.sqlite which is located in a data subdirectory of www

1SQLite.openDatabase({name : "testDB", createFromLocation : "~data/mydbfile.sqlite"}, okCallback,errorCallback);

Use this flavor of openDatabase call if your folder is not in application bundle but in app sandbox i.e. downloaded from some remote location. In this case the source file is located in data subdirectory of Documents location (iOS) or FilesDir (Android).

1SQLite.openDatabase({name : "testDB", createFromLocation : "/data/mydbfile.sqlite"}, okCallback,errorCallback);

Additional options for pre-populated database file

You can provide additional instructions to sqlite-storage to tell it how to handle your pre-populated database file. By default, the source file is copied over to the internal location which works in most cases but sometimes this is not really an option particularly when the source db file is large. In such situations you can tell sqlite-storage you do not want to copy the file but rather use it in read-only fashion via direct access. You accomplish this by providing an additional optional readOnly parameter to openDatabase call

1SQLite.openDatabase({name : "testDB", readOnly: true, createFromLocation : "/data/mydbfile.sqlite"}, okCallback,errorCallback);

Note that in this case, the source db file will be open in read-only mode and no updates will be allowed. You cannot delete a database that was open with readOnly option. For Android, the read only option works with pre-populated db files located in FilesDir directory because all other assets are never physically located on the file system but rather read directly from the app bundle.

Attaching another database

Sqlite3 offers the capability to attach another database to an existing database-instance, i.e. for making cross database JOINs available. This feature allows to SELECT and JOIN tables over multiple databases with only one statement and only one database connection. To archieve this, you need to open both databases and to call the attach()-method of the destination (or master) -database to the other ones.

1let dbMaster, dbSecond;
2
3dbSecond = SQLite.openDatabase({name: 'second'},
4  (db) => {
5    dbMaster = SQLite.openDatabase({name: 'master'},
6      (db) => {
7        dbMaster.attach( "second", "second", () => console.log("Database attached successfully"), () => console.log("ERROR"))
8      },
9      (err) => console.log("Error on opening database 'master'", err)
10    );
11  },
12  (err) => console.log("Error on opening database 'second'", err)
13);

The first argument of attach() is the name of the database, which is used in SQLite.openDatabase(). The second argument is the alias, that is used to query on tables of the attached database.

The following statement would select data from the master database and include the "second"-database within a simple SELECT/JOIN-statement:

1SELECT * FROM user INNER JOIN second.subscriptions s ON s.user_id = user.id

To detach a database, just use the detach()-method:

1dbMaster.detach( 'second', successCallback, errorCallback );

For sure, their is also Promise-support available for attach() and detach(), as shown in the example-application under the directory "examples".

Original Cordova SQLite Bindings from Chris Brody and Davide Bertola

https://github.com/litehelpers/Cordova-sqlite-storage

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

Issues

1. Android binds all numeric SQL input values to double. This is due to the underlying React Native limitation where only a Numeric type is available on the interface point making it ambiguous to distinguish integers from doubles. Once I figure out the proper way to do this I will update the codebase [(Issue #4141)] (https://github.com/facebook/react-native/issues/4141).