Skip to content

Commit 41d6334

Browse files
author
Chris Brody
committed
Document some known issues in README.md including: PG Build iOS issue with app name (ref: #243); possible stability issue with SockJS client (ref: #196); retrieve of large data set can be too slow due to JSON (ref: #127); memory issue when adding large numbers of records (ref: #18)
1 parent 550f2e6 commit 41d6334

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

README.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -57,11 +57,14 @@ License for iOS version: MIT only
5757
## Known issues
5858

5959
- Issue reported with PhoneGap Build Hydration.
60+
- For some reason, PhoneGap Build may fail to build the iOS version unless the name of the app starts with an uppercase and contains no spaces (see [#243](https://github.com/litehelpers/Cordova-sqlite-storage/issues/243); [Wizcorp/phonegap-facebook-plugin#830](https://github.com/Wizcorp/phonegap-facebook-plugin/issues/830); [phonegap/build#431](https://github.com/phonegap/build/issues/431)).
6061
- Multi-page apps are not supported and known to be broken on Android and Amazon Fire-OS.
6162
- Using web workers is currently not supported and known to be broken on Android and Amazon Fire-OS.
6263
- Triggers have only been tested on iOS, known to be broken on Android (in case [sqlite4java](https://code.google.com/p/sqlite4java/) is disabled) and Amazon Fire-OS.
6364
- INSERT statement that affects multiple rows (due to SELECT cause or using triggers, for example) does not report proper rowsAffected on Android (in case [sqlite4java](https://code.google.com/p/sqlite4java/) is disabled) or Amazon Fire-OS.
6465
- On Windows (8.1), rowsAffected can be wrong when there are multiple levels of nesting of INSERT statements.
66+
- Memory issue observed when adding a large number of records on Android and Amazon Fire-OS, due to JSON implementation
67+
- A stability issue was reported on the iOS version when in use together with [SockJS](http://sockjs.org/) client such as [pusher-js](https://github.com/pusher/pusher-js) at the same time (see [#196](https://github.com/litehelpers/Cordova-sqlite-storage/issues/196)). The workaround is to call sqlite functions and [SockJS](http://sockjs.org/) client functions in separate ticks (using setTimeout with 0 timeout).
6568

6669
## Other limitations
6770

@@ -74,6 +77,7 @@ License for iOS version: MIT only
7477
- UNICODE `\u0000` (same as `\0`) character not working in Windows (8.1) or WP(7/8) versions
7578
- Case-insensitive matching and other string manipulations on Unicode characters, which is provided by optional ICU integration in the sqlite source and working with recent versions of Android, is not supported for any target platforms.
7679
- iOS version uses a thread pool but with only one thread working at a time due to "synchronized" database access
80+
- Large query result can be slow, also due to JSON implementation
7781

7882
## Limited support (testing needed)
7983

@@ -267,7 +271,7 @@ window.sqlitePlugin.deleteDatabase({name: "my.db", location: 1}, successcb, erro
267271

268272
## Windows Universal target platform
269273

270-
**WARNING:** This is still in pre/alpha state. Please read and follow these items very carefully.
274+
**WARNING:** This is still in ~~pre-alpha~~ experimental state. Please read and follow these items very carefully.
271275
- Please make sure your Cordova tooling is updated: `npm update -g cordova cordova-windows`
272276
- To create a new project: `cordova create MyProjectFolder com.my.project MyProject` (and then `cd` into your project directory)
273277
- To add the plugin: `cordova plugin add io.litehelpers.cordova.sqlite`

0 commit comments

Comments
 (0)