Repository files navigation

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

Inspired by fantastic work done byNolan Lawson.It should be a drop-in replacement forreact-native-sqlite-storage.It works pretty well withPouchDB on React Native app.

mozilla / notesInkdrop

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

• Itcan't store string data with\u0000 due tothe 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 solves these problems.

Even the latest version of Android is several versions behind the latest version of SQLite, whereas iOS has newer version.React Native SQLite 2 usessqlite-android which allows you to use the latest version of it with new SQLite features enabled:

• JSON1 extension
• Common Table expressions
• Indexes on expressions
• FTS5 extension

Add react-native-sqlite-2 to your dependencies:

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

From react-native 0.60 autolinking will take care of the link step but don't forget to runpod install.

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

If using cocoapods in theios/ directory run

$ pod install

Please make sure AndroidX is enabled in your project by editingandroid/gradle.properties and adding 2 lines:

android.useAndroidX=trueandroid.enableJetifier=true

importSQLitefrom'react-native-sqlite-2'constdb=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(leti=0;i<res.rows.length;++i){console.log('item:',res.rows.item(i))}})})

Seean example project for more detail.

It can be used withpouchdb-adapter-react-native-sqlite.

importPouchDBfrom'pouchdb-react-native'importSQLitefrom'react-native-sqlite-2'importSQLiteAdapterFactoryfrom'pouchdb-adapter-react-native-sqlite'constSQLiteAdapter=SQLiteAdapterFactory(SQLite)PouchDB.plugin(SQLiteAdapter)vardb=newPouchDB('mydb',{adapter:'react-native-sqlite'})

As part of database initialization, this library will enable foreign key support automatically on both iOS & Android. Thus, any tables that define foreign key constraints will have them enforced whether or not foreign key support is explicitly enabled/disabled by PRAGMA statements sent via SQL.

SeeCHANGELOG.md

SeeCONTRIBUTING.md

https://github.com/nolanlawson/cordova-plugin-sqlite-2

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