SQLite3 Native Plugin for React Native for both Android and iOS. 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 with react-native-sqlite-storage. It works pretty well with PouchDB on React Native app.
The reason of this plugin is that react-native-sqlite-storage
has some problems to use with PouchDB:
- It can't store string data with
\u0000
due to the react native problem.- PouchDB heavily uses the Null character in the document IDs for building index, so it won't work well.
- It's unstable for storing PouchDB's attachments: #6037.
This plugin avoids these problems.
$ npm install react-native-sqlite-2 --save
$ react-native link react-native-sqlite-2
In Xcode, add libsqlite3.tbd
to your project's Build Phases
➜ Link Binary With Libraries
.
- In XCode, in the project navigator, right click
Libraries
➜Add Files to [your project's name]
- Go to
node_modules
➜react-native-sqlite2
and addRNSqlite2.xcodeproj
- In Xcode, in the project navigator, select your project. Add
libRNSqlite2.a
to your project'sBuild Phases
➜Link Binary With Libraries
- Run your project (
Cmd+R
)<
- Open up
android/app/src/main/java/[...]/MainActivity.java
- Add
import com.reactlibrary.RNSqlite2Package;
to the imports at the top of the file - Add
new RNSqlite2Package()
to the list returned by thegetPackages()
method
- Append the following lines to
android/settings.gradle
:include ':react-native-sqlite2' project(':react-native-sqlite2').projectDir = new File(rootProject.projectDir, '../node_modules/react-native-sqlite2/android')
- Insert the following lines inside the dependencies block in
android/app/build.gradle
:compile project(':react-native-sqlite2')
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));
}
});
});
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)
PouchDB.plugin(SQLiteAdapter)
var db = new PouchDB('mydb', { adapter: 'react-native-sqlite' })
https://github.com/nolanlawson/cordova-plugin-sqlite-2
The issues and limitations for the actual SQLite can be found on this site.