Native interface to sqlite in a Cordova/PhoneGap plugin for Android, iOS, WP(8/8.1), and Windows (8.1), with API similar to HTML5/Web SQL API.
License for Android, WP(8), and Windows (8.1) versions: MIT or Apache 2.0
License for iOS version: MIT only
simple-test-windows
. Cannot be tested by existing QUnit test suite in test-www
since QUnit cannot be run on Windows (8.1+).openDatabase
and deleteDatabase
location
option to select database location (iOS only) and disable iCloud backupwindow.openDatabase()
--> sqlitePlugin.openDatabase()
\u2028
) is currently not supported and known to be broken in iOS version.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:
var db = window.sqlitePlugin.openDatabase({name: "my.db", location: 1});
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 iCloudIMPORTANT: 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:
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:
www
subdirectory. This should work well with using the Cordova CLI to support both Android & iOS versions.openDatabase
. The automatic extension has been completely eliminated.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:
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.
npm update -g cordova cordova-windows
cordova create MyProjectFolder com.my.project MyProject
(and then cd
into your project directory)cordova plugin add https://github.com/brodysoft/Cordova-SQLitePlugin
cordova platform add windows
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:
windows
target;SQLite3-Windows8.1.vcxproj
project (located in path.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/brodysoft/Cordova-SQLitePlugin
where 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/brodysoft/Cordova-SQLitePlugin
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.js
now platform-independentsrc
: Java plugin code for Android; Objective-C plugin code for iOS; C-sharp code & DLLs for WP(8)simple-test-windows
: simple test suite for Windows version using Jasmine (1.3.1)test-www
: simple testing in index.html
using qunit 1.5.0 (does not work on Windows target platform)Lawnchair-adapter
: Lawnchair adaptor, based on the version from the Lawnchair repository, with the basic Lawnchair test suite in test-www
subdirectoryThese 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.
<plugin name="SQLitePlugin" value="org.pgsqlite.SQLitePlugin"/>
to res/xml/config.xmlSample 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">
sqlitePlugin
object name starts with "sql" in small letters.If you have an issue with the plugin please check the following first:
config.xml
.If you still cannot get something to work:
Then you can raise the new issue.
If you have any questions about the plugin please post it to the Cordova-SQLitePlugin forum.
NOTE: Please report all bugs at brodysoft / Cordova-SQLitePlugin / issues so they can be tracked properly.
Unit testing is done in test-www/
.
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 Phone 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 after SQLitePlugin.js
in 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.
git mv
to move files & directories;common-src
- source for Android & iOS versionsnew-src
- source for Android, iOS, and Windows (8.1) versionsnew-rc
- pre-release version for Windows (8.1), including source for SQLite-WinRT C++ librarymaster-src
- source for Android, iOS, & WP(8) versionsmaster-rc
- pre-release version, including source for CSharp-SQLite library classesmaster
- version for release, will be included in PhoneGap build.此处可能存在不合适展示的内容,页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容,可点击提交进行申诉,我们将尽快为您处理。
1. 开源生态
2. 协作、人、软件
3. 评估模型