Native interface to sqlite in a Cordova/PhoneGap plugin for Android, iOS, Windows (8.1), and WP(7/8) with API similar to HTML5/Web SQL API.
License for Android, Windows (8.1), and WP(7/8) versions: MIT or Apache 2.0
License for iOS version: MIT only
- Stable version available at PhoneGap build
- Windows (8.1) version is in experimental state:
- No background processing
- Database close and delete operations not yet implemented
- insertId and rowsAffected are missing in the results for INSERT/UPDATE/DELETE statements
- Visual C++ build file is provided for Windows 8.1 only. Visual C++ build support for Windows Phone 8.1 will be added later.
- Not all Windows CPU targets are supported by automatic installation
- Status for the other target platforms:
- Android: #193: possible database locking/closing issue, workaround option described here
- iOS: issues reported with iOS 8, to be investigated
- WP7: possible to build from C#, as specified by
plugin.xml, NOT TESTED - WP8: performance/stability issues have been reported with the CSharp-SQLite library. Windows (universal) platform is recommended for the future.
- API to open the database is expected to be changed slightly to be more streamlined. Transaction and single-statement query API will NOT be changed.
- Project has been renamed to prevent confusion with davibe / Phonegap-SQLitePlugin (original version for iOS, with a different API)
- New project location (should redirect)
- Discussion forum at Ost.io / @litehelpers / Cordova-sqlite-storage
- Windows (8.1) version is added, using the C++ SQLite-WinRT library
- The test suite is completely ported to Jasmine (2.2.0) and was used to verify the functionality of the new Windows version
- SQLCipher for Android & iOS is now supported by litehelpers / Cordova-sqlcipher-adapter
- New
openDatabaseanddeleteDatabaselocationoption to select database location (iOS only) and disable iCloud backup - Pre-populated databases support for Android & iOS is now integrated, usage described below
- Fixes to work with PouchDB by @nolanlawson
- Works with Cordova 3.x tooling and stable version available at PhoneGap build
- Drop-in replacement for HTML5 SQL API, the only change should be
window.openDatabase()-->sqlitePlugin.openDatabase() - Failure-safe nested transactions with batch processing optimizations
- As described in this posting:
- Keeps sqlite database in a user data location that is known, can be reconfigured, and iOS will be backed up by iCloud.
- No 5MB maximum, more information at: http://www.sqlite.org/limits.html
- Android is supported back to SDK 10 (a.k.a. Gingerbread, Android 2.3.3); Support for older versions is available upon request.
- Pre-populated database option (usage described below)
- Get It Done app by marcucio.com
- KAAHE Health Encyclopedia: Official health app of the Kingdom of Saudi Arabia.
- Larkwire (iOS version): Learn bird songs the fun way
- Tangorin (Android) Japanese Dictionary at tangorin.com
- Issue reported with PhoneGap Build Hydration.
- Multi-page apps are not supported and known to be broken on Android.
- Using web workers is currently not supported and known to be broken on Android.
- Triggers are only supported for iOS, known to be broken on Android.
- INSERT statement that affects multiple rows (due to SELECT cause or using triggers, for example) does not report proper rowsAffected on Android.
- The db version, display name, and size parameter values are not supported and will be ignored.
- The sqlite storage plugin will not work before the callback for the "deviceready" event has been fired, as described in Usage.
- The Android version cannot work with more than 100 open db files due to its threading model.
- UNICODE line separator (
\u2028) is currently not supported and known to be broken in iOS version. - UNICODE characters not working in WP(7/8) version
- DB Triggers (as described above - known to be broken for Android)
- UNICODE characters not fully tested with Windows (8.1) version
- litehelpers / Cordova-sqlcipher-adapter - supports SQLCipher for Android & iOS
- Original version for iOS (with a different API): davibe / Phonegap-SQLitePlugin
- EionRobb / phonegap-win8-sqlite - WebSQL add-on for Win8/Metro apps (perhaps with a different API), using an old version of the C++ library from SQLite3-WinRT Component (as referenced by 01org / cordova-win8)
- SQLite3-WinRT Component - C++ component that provides a nice SQLite API with promises for WinJS
- 01org / cordova-win8 - old, unofficial version of Cordova API support for Windows 8 Metro that includes an old version of the C++ SQLite3-WinRT Component
- MSOpenTech / cordova-plugin-websql - Windows 8(+) and Windows Phone 8(+) WebSQL plugin versions in C#
- MetaMemoryT / websql-client - provides the same API and connects to websql-server through WebSockets.
The idea is to emulate the HTML5/Web SQL API as closely as possible. The only major change is to use window.sqlitePlugin.openDatabase() (or sqlitePlugin.openDatabase()) instead of window.openDatabase(). If you see any other major change please report it, it is probably a bug.
There are two options to open a database:
- Recommended:
var db = window.sqlitePlugin.openDatabase({name: "my.db", location: 1}); - Classical:
var db = window.sqlitePlugin.openDatabase("myDatabase.db", "1.0", "Demo", -1);
The new location option is used to select the database subdirectory location (iOS only) with the following choices:
0(default):Documents- will be visible to iTunes and backed up by iCloud1:Library- backed up by iCloud, NOT visible to iTunes2:Library/LocalDatabase- NOT visible to iTunes and NOT backed up by iCloud
IMPORTANT: Please wait for the "deviceready" event, as in the following example:
// Wait for Cordova to load
document.addEventListener("deviceready", onDeviceReady, false);
// Cordova is ready
function onDeviceReady() {
var db = window.sqlitePlugin.openDatabase({name: "my.db"});
// ...
}NOTE: The database file name should include the extension, if desired.
An issue was reported, as observed by several people that on some newer versions of the Android, if the app is stopped or aborted without closing the db then:
- (sometimes) there is an unexpected db lock
- the data that was inserted before is lost.
It is suspected that this issue is caused by this Android sqlite commit, which references and includes the sqlite commit at: http://www.sqlite.org/src/info/6c4c2b7dba
There is an optional workaround that simply closes and reopens the database file at the end of every transaction that is committed. The workaround is enabled by opening the database like:
var db = window.sqlitePlugin.openDatabase({name: "my.db", androidLockWorkaround: 1});NOTE: This workaround is only applied when using db.transaction() or db.readTransaction(), not applied when running executeSql() on the database object.
For Android & iOS (only): put the database file in the www directory and open the database like:
var db = window.sqlitePlugin.openDatabase({name: "my.db", createFromLocation: 1});or to disable iCloud backup:
db = sqlitePlugin.openDatabase({name: "my.db", location: 2, createFromLocation: 1});IMPORTANT NOTES:
- Put the pre-populated database file in the
wwwsubdirectory. This should work well with using the Cordova CLI to support both Android & iOS versions. - The pre-populated database file name must match exactly the file name given in
openDatabase. The automatic extension has been completely eliminated. - The pre-populated database file is ignored if the database file with the same name already exists in your database file location.
TIP: If you don't see the data from the pre-populated database file, completely remove your app and try it again!
The threading model depends on which version is used:
- For Android and WP(7/8), one background thread per db;
- for iOS, background processing using a thread pool;
- for Windows, no background processing (will be added).
This is a pretty strong test: first we create a table and add a single entry, then query the count to check if the item was inserted as expected. Note that a new transaction is created in the middle of the first callback.
// Wait for Cordova to load
document.addEventListener("deviceready", onDeviceReady, false);
// Cordova is ready
function onDeviceReady() {
var db = window.sqlitePlugin.openDatabase({name: "my.db"});
db.transaction(function(tx) {
tx.executeSql('DROP TABLE IF EXISTS test_table');
tx.executeSql('CREATE TABLE IF NOT EXISTS test_table (id integer primary key, data text, data_num integer)');
// demonstrate PRAGMA:
db.executeSql("pragma table_info (test_table);", [], function(res) {
console.log("PRAGMA res: " + JSON.stringify(res));
});
tx.executeSql("INSERT INTO test_table (data, data_num) VALUES (?,?)", ["test", 100], function(tx, res) {
console.log("insertId: " + res.insertId + " -- probably 1");
console.log("rowsAffected: " + res.rowsAffected + " -- should be 1");
db.transaction(function(tx) {
tx.executeSql("select count(id) as cnt from test_table;", [], function(tx, res) {
console.log("res.rows.length: " + res.rows.length + " -- should be 1");
console.log("res.rows.item(0).cnt: " + res.rows.item(0).cnt + " -- should be 1");
});
});
}, function(e) {
console.log("ERROR: " + e.message);
});
});
}In this case, the same transaction in the first executeSql() callback is being reused to run executeSql() again.
// Wait for Cordova to load
document.addEventListener("deviceready", onDeviceReady, false);
// Cordova is ready
function onDeviceReady() {
var db = window.sqlitePlugin.openDatabase("Database", "1.0", "Demo", -1);
db.transaction(function(tx) {
tx.executeSql('DROP TABLE IF EXISTS test_table');
tx.executeSql('CREATE TABLE IF NOT EXISTS test_table (id integer primary key, data text, data_num integer)');
tx.executeSql("INSERT INTO test_table (data, data_num) VALUES (?,?)", ["test", 100], function(tx, res) {
console.log("insertId: " + res.insertId + " -- probably 1");
console.log("rowsAffected: " + res.rowsAffected + " -- should be 1");
tx.executeSql("select count(id) as cnt from test_table;", [], function(tx, res) {
console.log("res.rows.length: " + res.rows.length + " -- should be 1");
console.log("res.rows.item(0).cnt: " + res.rows.item(0).cnt + " -- should be 1");
});
}, function(e) {
console.log("ERROR: " + e.message);
});
});
}This case will also works with Safari (WebKit), assuming you replace window.sqlitePlugin.openDatabase with window.openDatabase.
window.sqlitePlugin.deleteDatabase({name: "my.db", location: 1}, successcb, errorcb);location as described above for openDatabase (iOS only)
NOTE: not yet implemented for Windows (8.1) version.
WARNING: This is still in experimental state. Please read and follow these items very carefully.
- Please make sure your Cordova tooling is updated:
npm update -g cordova cordova-windows - To create a new project:
cordova create MyProjectFolder com.my.project MyProject(and thencdinto your project directory) - To add the plugin:
cordova plugin add https://github.com/litehelpers/Cordova-sqlite-storage - To add the Windows target platform (if it does not exist):
cordova platform add windows - If you are using Visual Studio Express (2013), you may have to remove the Windows 8.0 build from the Visual Studio solution.
- If you use Cordova CLI for fully-automatic installation (as described here), you cannot run the project for "Any CPU". Please specify a CPU type (such as x86 or x64).
To target all CPUs: make a clone of this project and in your clone, remove (or comment out) the item that includes the SQLite3-Windows8.1.vcxproj framework project:
--- a/plugin.xml
+++ b/plugin.xml
@@ -79,8 +79,6 @@
<js-module src="src/windows/SQLite3-WinRT/SQLite3JS/js/SQLite3.js" name="SQLite3">
<merges target="" />
</js-module>
- <!-- Thanks to AllJoyn-Cordova / cordova-plugin-alljoyn: -->
- <framework src="src/windows/SQLite3-WinRT/SQLite3/SQLite3-Windows8.1.vcxproj" custom="true" type="projectReference" target="windows" />
</platform>Then:
- install the plugin from the location of your clone (can be in your filesystem);
- add the Cordova
windowstarget; - open the Windows target solution, and add the
SQLite3-Windows8.1.vcxprojproject (located inpath.to.plugin/src/windows/SQLite3-WinRT/SQLite3) to your app solution project.
plugman install --platform MYPLATFORM --project path.to.my.project.folder --plugin https://github.com/litehelpers/Cordova-sqlite-storagewhere MYPLATFORM is android, ios, or wp8.
A posting how to get started developing on Windows host without the Cordova CLI tool (for Android target only) is available here.
NOTE: Automatic installation for the Windows target platform is not properly supported by the plugman tool.
npm install -g cordova # if you don't have cordova
cordova create MyProjectFolder com.my.project MyProject && cd MyProjectFolder # if you are just starting
cordova plugin add https://github.com/litehelpers/Cordova-sqlite-storage
You can find more details at this writeup.
WARNING: for Windows target platform please read the section above.
IMPORTANT: sometimes you have to update the version for a platform before you can build, like: cordova prepare ios
NOTE: If you cannot build for a platform after cordova prepare, you may have to remove the platform and add it again, such as:
cordova platform rm ios
cordova platform add ios
SQLitePlugin.coffee.md: platform-independent (Literate coffee-script, can be read by recent coffee-script compiler)www:SQLitePlugin.jsplatform-independent Javascript as generated fromSQLitePlugin.coffee.md(and checked in!)src: Java plugin code for Android; Objective-C plugin code for iOS; Javascript proxy code for Windows (8.1); C-sharp code for WP(7/8)spec: test suite using Jasmine (2.2.0), ported from QUnittest-wwwtest suite, working on all platformsLawnchair-adapter: Lawnchair adaptor, based on the version from the Lawnchair repository, with the basic Lawnchair test suite intest-wwwsubdirectory
These installation instructions are based on the Android example project from Cordova/PhoneGap 2.7.0. For your first time please unzip the PhoneGap 2.7 zipball and use the lib/android/example subdirectory.
- Install www/SQLitePlugin.js from this repository into assets/www subdirectory
- Install src/android/org/pgsqlite/SQLitePlugin.java from this repository into src/org/pgsqlite subdirectory
- Add the plugin element
<plugin name="SQLitePlugin" value="org.pgsqlite.SQLitePlugin"/>to res/xml/config.xml
Sample change to res/xml/config.xml for Cordova/PhoneGap 2.x:
--- config.xml.orig 2013-07-23 13:48:09.000000000 +0200
+++ res/xml/config.xml 2013-07-23 13:48:26.000000000 +0200
@@ -36,6 +36,7 @@
<preference name="useBrowserHistory" value="true" />
<preference name="exit-on-suspend" value="false" />
<plugins>
+ <plugin name="SQLitePlugin" value="org.pgsqlite.SQLitePlugin"/>
<plugin name="App" value="org.apache.cordova.App"/>
<plugin name="Geolocation" value="org.apache.cordova.GeoBroker"/>
<plugin name="Device" value="org.apache.cordova.Device"/>Before building for the first time, you have to update the project with the desired version of the Android SDK with a command like:
android update project --path $(pwd) --target android-17
(assume Android SDK 17, use the correct desired Android SDK number here)
NOTE: using this plugin on Cordova pre-3.0 requires the following change to SQLitePlugin.java:
--- src/android/org/pgsqlite/SQLitePlugin.java 2013-09-10 21:36:20.000000000 +0200
+++ SQLitePlugin.java.old 2013-09-10 21:35:14.000000000 +0200
@@ -17,8 +17,8 @@
import java.util.HashMap;
-import org.apache.cordova.CordovaPlugin;
-import org.apache.cordova.CallbackContext;
+import org.apache.cordova.api.CordovaPlugin;
+import org.apache.cordova.api.CallbackContext;
import android.database.Cursor;In the Project "Build Phases" tab, select the first "Link Binary with Libraries" dropdown menu and add the library libsqlite3.dylib or libsqlite3.0.dylib.
NOTE: In the "Build Phases" there can be multiple "Link Binary with Libraries" dropdown menus. Please select the first one otherwise it will not work.
Drag .h and .m files into your project's Plugins folder (in xcode) -- I always just have "Create references" as the option selected.
Take the precompiled javascript file from build/, or compile the coffeescript file in src/ to javascript WITH the top-level function wrapper option (default).
Use the resulting javascript file in your HTML.
Enable the SQLitePlugin in config.xml (Cordova/PhoneGap 2.x):
--- config.xml.old 2013-05-17 13:18:39.000000000 +0200
+++ config.xml 2013-05-17 13:18:49.000000000 +0200
@@ -39,6 +39,7 @@
<content src="index.html" />
<plugins>
+ <plugin name="SQLitePlugin" value="SQLitePlugin" />
<plugin name="Device" value="CDVDevice" />
<plugin name="Logger" value="CDVLogger" />
<plugin name="Compass" value="CDVLocation" />TODO
TODO
Make a change like this to index.html (or use the sample code) verify proper installation:
--- index.html.old 2012-08-04 14:40:07.000000000 +0200
+++ assets/www/index.html 2012-08-04 14:36:05.000000000 +0200
@@ -24,7 +24,35 @@
<title>PhoneGap</title>
<link rel="stylesheet" href="master.css" type="text/css" media="screen" title="no title">
<script type="text/javascript" charset="utf-8" src="cordova-2.0.0.js"></script>
- <script type="text/javascript" charset="utf-8" src="main.js"></script>
+ <script type="text/javascript" charset="utf-8" src="SQLitePlugin.js"></script>
+
+
+ <script type="text/javascript" charset="utf-8">
+ document.addEventListener("deviceready", onDeviceReady, false);
+ function onDeviceReady() {
+ var db = window.sqlitePlugin.openDatabase("Database", "1.0", "Demo", -1);
+
+ db.transaction(function(tx) {
+ tx.executeSql('DROP TABLE IF EXISTS test_table');
+ tx.executeSql('CREATE TABLE IF NOT EXISTS test_table (id integer primary key, data text, data_num integer)');
+
+ tx.executeSql("INSERT INTO test_table (data, data_num) VALUES (?,?)", ["test", 100], function(tx, res) {
+ console.log("insertId: " + res.insertId + " -- probably 1"); // check #18/#38 is fixed
+ alert("insertId: " + res.insertId + " -- should be valid");
+
+ db.transaction(function(tx) {
+ tx.executeSql("SELECT data_num from test_table;", [], function(tx, res) {
+ console.log("res.rows.length: " + res.rows.length + " -- should be 1");
+ alert("res.rows.item(0).data_num: " + res.rows.item(0).data_num + " -- should be 100");
+ });
+ });
+
+ }, function(e) {
+ console.log("ERROR: " + e.message);
+ });
+ });
+ }
+ </script>
</head>
<body onload="init();" id="stage" class="theme">- The plugin class name starts with "SQL" in capital letters, but in Javascript the
sqlitePluginobject name starts with "sql" in small letters. - Attempting to open a database before receiving the "deviceready" event callback.
If you have an issue with the plugin please check the following first:
- You are using the latest version of the Plugin Javascript & platform-specific Java or Objective-C source from this repository.
- You have installed the Javascript & platform-specific Java or Objective-C correctly.
- You have included the correct version of the cordova Javascript and SQLitePlugin.js and got the path right.
- You have registered the plugin properly in
config.xml.
If you still cannot get something to work:
- Make the simplest test program you can to demonstrate the issue, including the following characteristics:
- it completely self-contained, i.e. it is using no extra libraries beyond cordova & SQLitePlugin.js;
- if the issue is with adding data to a table, that the test program includes the statements you used to open the database and create the table;
- if the issue is with retrieving data from a table, that the test program includes the statements you used to open the database, create the table, and enter the data you are trying to retrieve.
Then you can raise the new issue.
If you have any questions about the plugin please post them to the new discussion forum at Ost.io / @litehelpers / Cordova-sqlite-storage
Unit testing is done in spec.
To run the tests from *nix shell, simply do either:
./bin/test.sh ios
or for Android:
./bin/test.sh android
To run then from a windows powershell do either
.\bin\test.ps1 android
or for Windows (8.1):
.\bin\test.ps1 windows
or for Windows Phone (7/8):
.\bin\test.ps1 wp8
Please look at the Lawnchair-adapter tree that contains a common adapter, which should also work with the Android version, along with a test-www directory.
Include the following Javascript files in your HTML:
cordova.js(don't forget!)lawnchair.js(you provide)SQLitePlugin.js(in case of Cordova pre-3.0)Lawnchair-sqlitePlugin.js(must come afterSQLitePlugin.jsin case of Cordova pre-3.0)
The name option will determine the sqlite database filename, with no extension automatically added. Optionally, you can change it using the db option.
In this example, you would be using/creating a database with filename kvstore:
kvstore = new Lawnchair({name: "kvstore"}, function() {
// do stuff
);Using the db option you can specify the filename with the desired extension and be able to create multiple stores in the same database file. (There will be one table per store.)
recipes = new Lawnchair({db: "cookbook", name: "recipes", ...}, myCallback());
ingredients = new Lawnchair({db: "cookbook", name: "ingredients", ...}, myCallback());KNOWN ISSUE: the new db options are not supported by the Lawnchair adapter. The workaround is to first open the database file using sqlitePlugin.openDatabase().
The adapter is now part of PouchDB thanks to @nolanlawson, see PouchDB FAQ.
WARNING: Please do NOT propose changes from your master branch. In general changes will be rebased using git rebase or git cherry-pick and not merged.
- Testimonials of apps that are using this plugin would be especially helpful.
- Reporting issues at litehelpers / Cordova-sqlite-storage / issues can help improve the quality of this plugin.
- Patches with bug fixes are helpful, especially when submitted with test code.
- Other enhancements welcome for consideration, when submitted with test code and will work for all supported platforms. Increase of complexity should be avoided.
- All contributions may be reused by @brodybits (Chris Brody) under another license in the future. Efforts will be taken to give credit for major contributions but it will not be guaranteed.
- Project restructuring, i.e. moving files and/or directories around, should be avoided if possible.
- If you see a need for restructuring, it is the most handy to first discuss it in the forum at Ost.io / @litehelpers / Cordova-sqlite-storage where alternatives can be discussed before reaching a conclusion. If you want to propose a change to the project structure:
- Make a special branch within your fork from which you can send the proposed restructuring;
- Always use
git mvto move files & directories; - Never mix a move/rename operation with any other changes in the same commit.
common-src- source for Android & iOS versionsnew-src- source for Android, iOS, and Windows (8.1) versionsnew-common-rc- pre-release version for Android/iOS/Windows (8.1), including source for SQLite-WinRT (C++ and Javascript) librarywp-src- source for Android, iOS, and WP(7/8) versionswp-master-rc- pre-release version for Android/iOS/WP(7/8), including source for CSharp-SQLite (C#) library classesfull-master-rc- pre-release version for all platforms, including source for SQLite-WinRT and CSharp-SQLite libraries- [FUTURE TBD]
master- version for release, will be included in PhoneGap build.