A cross-browser/platform indexeddb-like client library
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.vscode Enable debugging of node tests via vscode (#56) Sep 7, 2018
src Enable batched upgrades in SQL providers. Aim to pull 1MB of data out… ( Sep 14, 2018
.gitignore Enable debugging of node tests via vscode (#56) Sep 7, 2018
.npmignore 0.3.5: Actually fixing npm dist Dec 23, 2016
.npmrc 0.6.0: Changing to not have all of the various getters have templated… ( Oct 11, 2017
.travis.yml
LICENSE Updating LICENSE with LCA-approved language Jan 6, 2016
README.md Add doNotBackfill to index schema (#57) Sep 12, 2018
package.json Bump NoSqlProvider to 0.6.16 for publish Sep 14, 2018
test.html
tsconfig.json
tslint.json Removing _.chain and _(..) to reduce the dependency on lodash (#33) Sep 19, 2017
webpack.config.js Add doNotBackfill to index schema (#57) Sep 12, 2018

README.md

NoSQLProvider Build Status

We developed NoSQLProvider after needing a simplified interface to NoSQL-style object storage/retrieval that worked not only across all browsers, but also for native app development (initially Cordova-based, later moving to React Native.) Across the browsers, this required unifying WebSQL and IndexedDB, with the nuances of all the different IndexedDB issues (on IE, mostly, with not properly supporting compound keys and multi-entry indexes, and Safari having basically completely broken keyspace support.) On native platforms and NodeJS, we fully wrap several different SQLite-based providers, depending on the platform. We also have built a fully in-memory database provider that has no persistence but supports fully transactional semantics, for a fallback in situations where you don't want persistence (ephemeral logins, etc.)

As part of this work, we had to develop SyncTasks as a complete promise library that spurns the A+ convention of deferring all resolutions/rejections to the event loop. This is because IndexedDB's transactional semantics are such that if control is ever returned to the event loop without a pending query, the transaction is automatically closed. As such, if you defer resolution of a query, then the transaction closes before you can issue followup queries against it. To avoid this, we required synchronous resolution of promises, and SyncTasks gives us the ability to chain commands on a single transaction. Given that IndexedDB was the most limiting transactional scenario that we needed to support, we followed that pattern with all of the other database providers, and designed them such that returning control to the event loop without issuing followup queries automatically resolves the transaction.

At this point, known feature work is complete and we are mostly just fixing bugs on the platform moving forward. If you have feature requests, feel free to file them, just make sure that you have behavior determined across all providers as part of your request, since all features need to be able to work across all the different providers.

Examples

The only current full example is available as part of the ReactXP samples, the TodoList sample app. If you pick up NoSQLProvider and use it in your open source application, please let us know so we can add more example links here!

Providers/Platforms/Support

We will soon list all of the providers available out of the box here, and list what platforms they can be used on, with any nuances of that platform.

Usage

Coming soon.

Compiling

Source

npm install
npm run build

Tests

npm install
npm run webtest

Testing

  1. Compile tests
  2. Open test.html in browser
  3. You can add ?grep=foo to the URL to run only tests containing 'foo' in the name