Dexie

Dexie.js (Official home page: dexie.org) is a library that makes it super simple to use indexedDB - the standard client-side database in browsers. Read more about dexie on it's README or at the home page.

Dexie is the main class and the default export of the library. An instance of this class represents an indexedDB database connection.

Syntax

var db = new Dexie (databaseName, options?);

Parameters

dbName : String	Database name
options: Object (optional)	Options

Options

addons: Array<DexieAddon>	Explicitly define the addons to activate for this db instance
autoOpen: boolean	Default true. Whether database will open automatically on first query.
indexedDB: IDBFactory	Supply an alternate implementation of indexedDB. If supplying this, also supply IDBKeyRange that works with that implementation.
IDBKeyRange: IDBKeyRange	An implementation of the IDBKeyRange interface that works with provided indexedDB implementation.

If the 'addons' option is omitted, it will default to the value of Dexie.addons.

Return Value

Dexie

Sample

// Declare db instance
var db = new Dexie("MyDatabase");

// Define Database Schema
db.version(1).stores({
    friends: "++id, name, age, isCloseFriend",
    notes: "++id, title, date, *items"
});

// Interact With Database
db.transaction('rw', db.friends, db.notes, function* () {

    // Let's add some data to db:
    var friend1Id = yield db.friends.add({name: 'Camilla', age: 25, isCloseFriend: 1 });
    var friend2Id = yield db.friends.add({name: 'Ban Ki-moon', age: 70, isCloseFriend: 0 });

    var noteId = yield db.notes.add({
        title: 'Shop tomorrow',
        date: new Date(),
        items: ['milk', 'butter']
    });

    // Let's query the db
    var closeFriends = yield db.friends
        .where('isCloseFriend').equals(1)
        .toArray();

    console.log("Close friends:" + closeFriends.map(f => f.name));

    var toShop = yield db.notes
        .where('title').startsWithIgnoreCase ('shop')
        .toArray();

    console.log("Shopping list: " + toShop.map(note => note.items));

}).catch(function(err) {

    // Catch any error event or exception and log it:
    console.error(err.stack || err);

});

Sample: Open existing database 'as is'

new Dexie('dbname').open().then(function (db) {
    console.log ("Found database: " + db.name);
    console.log ("Database version: " + db.verno);
    db.tables.forEach(function (table) {
        console.log ("Found table: " + table.name);
        console.log ("Table Schema: " +
            JSON.stringify(table.schema, null, 4));
    });
}).catch('NoSuchDatabaseError', function(e) {
    // Database with that name did not exist
    console.error ("Database not found");
}).catch(function (e) {
    console.error ("Oh uh: " + e);
});

Sample: Instanciate a Dexie with custom addon

// Define the addon
function myForEachAddon(db) {
    db.Collection.prototype.forEach = function (callback) {
        // Make the forEach() method just an alias of the existing
        // each() method:
        return this.each(callback);
    });
}
// Register it (optional)
Dexie.addons.push(myForEachAddon);


// Use it:
var db = new Dexie('dbname');
db.version(1).stores({friends: 'name'});
db.transaction('rw', db.friends, function () {
    db.friends.clear();
    db.friends.bulkAdd([{name: "Foo"},{name: "Bar"}]);
}).then(function() {
    db.friends
      .where('name')
      .anyOfIgnoreCase('foo','bar')
      .forEach(friend => {
          console.log(friend.name);
      });
}).catch(ex => {
    console.error(ex);
});

// Explicitely tell Dexie to not ignored any addons:
var db2 = new Dexie('dbname', {addons: []});

// Explicitely tell Dexie to use just your set of addons:
var db3 = new Dexie('dbname', {addons: [myForEachAddon]});