Dexie

Dexie.js is a library that makes it dead-simple to use indexedDB - the standard client-side database in browsers.

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

Hop-on, hop-off. No lock-in.

With Dexie.js, you declare your database versions and their schemas in a minimalistic fashion instead of explicitly subscribing to the 'upgradeneeded' event. But it is also possible to open existing databasess even if they weren't created via Dexie. The library will adapt to any existing indexedDB database and provide the simple api to work with your existing database. Dexie is not dependent on any proprietary meta data. Just plain indexedDB.

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.

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"
});

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

    // Let's add some data to db:
    db.friends.add({name: 'Camilla', age: 25, isCloseFriend: 1 });
    db.friends.add({name: 'Ban Ki-moon', age: 70, isCloseFriend: 0 });
    db.notes.add({title: 'Shop tomorrow', date: new Date(), items: ['milk', 'butter']});

    // Let's query the db
    db.friends.where('isCloseFriend').equals(1).each(function(friend) {
        console.log("Found close friend: " + JSON.stringify(friend));
    });
    db.notes.where('title').startsWithIgnoreCase ('shop').each (function(note) {
        console.log("Found shopping note: " + JSON.stringify(note));
    });

}).catch(function(err) {

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

});

Sample: Instanciate a Dexie with custom addon

// Define the addon
function myForEachAddon(db) {
   db.Collection.prototype.forEach = db.Collection.each;
}
// 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]});

Methods

version()

Specify the database schema (object stores and indexes) for a certain version.

on()

Subscribe to events

open()

Open database and make it start functioning.

table()

Returns an object store to operate on

transaction()

Start a database transaction

close()

Close the database

delete()

Delete the database

isOpen()

Returns true if database is open.

hasFailed()

Returns true if database failed to open.

backendDB()

Returns the native IDBDatabase instance.

vip()

Enable on('ready') subscribers to use db before open() is complete.

Properties

name

The database name.

[table]

Each object store defined in version().stores() gets a WriteableTable instance named by the object store.

tables

Javascript Array containing all Table instances.

verno

Version of current database

Static Methods

Dexie.async()

Declare an async function in today's modern browsers (2015) without the need for a transpiler.

Dexie.spawn()

Spawn an async function in today's modern browsers (2015) without the need for a transpiler.

Dexie.delete()

Delete a database.

Dexie.getDatabaseNames()

List all database names at current origin.

Dexie.exists()

Detect whether a database with the given name exists.

Dexie.getByKeyPath()

Retrieve a property from an object given a key path.

Dexie.setByKeyPath()

Modify a property in an object given a key path and value.

Dexie.delByKeyPath()

Delete a property from an object given a key path.

Dexie.shallowClone()

Shallow clones an object.

Dexie.deepClone()

Deep clones an object.

Dexie.ignoreTransaction()

Create a a new scope where current transaction is ignored.

Dexie.override()

Override existing method and be able to call the original method.

Dexie.defineClass()

Creates a function and populates its prototype with given structure.

Dexie.derive()

Fixes the prototype chain for OOP inheritance.

Dexie.extend()

Set given additional properties into given object.

Dexie.Events()

Create a set of events to subscribe to and fire.

Static Properties

addons

Array of extended constructors.

version

Contains the version number of Dexie as a numeric comparable decimal value.

semVer

Contains the semantic version string from package.json.