IndexedDb Class

Module: Services
Defined In: addon/services/indexed-db.js:14

This service allows interacting with an IndexedDB database.

Show:
_addToPromiseQueue
(
  • promise
)
Promise private

Defined in addon/services/indexed-db.js:688

Add a promise to the promise queue. When the promise resolves or rejects, it will be removed from the promise queue.

Parameters:

Returns:

Promise
_buildQuery
(
  • type
  • query
)
Dexie.Collection private

Defined in addon/services/indexed-db.js:565

Build a query for Dexie.

This will try to find a matching index, and use it if possible. It can also handle multi-indecies, if they have been specified and are supported. If no matching index is found, it will fetch everything and try to filter it via JS. Note that this is much slower than querying by actual indecies, so you should definitely use that if possible! If you are using multiple query arguments, and only one of them is found as index, it will query the database by this index and then do the other queries via JS filter.

Note that this will also auto-convert boolean query arguments to 1/0.

Parameters:

  • type String

    The model type to query

  • query Object

    The actual query

Returns:

Dexie.Collection
_bulkSave () private

Defined in addon/services/indexed-db.js:540

Get the queue and save everything in it in bulk.

add
(
  • type
  • items
)
Promise public

Defined in addon/services/indexed-db.js:239

Add one or multiple items to the database.

Parameters:

Returns:

Promise
clear
(
  • type
)
Promise public

Defined in addon/services/indexed-db.js:332

Clear a database table.

Parameters:

  • type String

    The model type to clear.

Returns:

Promise
delete
(
  • type
  • id
)
Promise public

Defined in addon/services/indexed-db.js:352

Delete one item.

Parameters:

  • type String

    The model type to delete

  • id String

    The id of the entry to delete

Returns:

Promise
dropDatabase () Promise public

Defined in addon/services/indexed-db.js:373

Drop the entire database.

Also available as a task: indexedDb.dropDatabaseTask.perform()

Returns:

Promise
exportDatabase () Promise public

Defined in addon/services/indexed-db.js:408

Export a complete dump of the current database. The output of this can be used to recreate the exact database state via this.importDatabase(config);

Also available as a task: indexedDb.exportDatabaseTask.perform()

Returns:

Promise
find
(
  • type
  • id
)
Promise public

Defined in addon/services/indexed-db.js:191

Find one or multiple items by id. If id is an array, this will try to fetch all of these objects and resolve with an array. Otherwise, it will resolve with an object.

Parameters:

Returns:

Promise
findAll
(
  • type
)
Promise public

Defined in addon/services/indexed-db.js:219

Find all of a given type.

Parameters:

  • type String

    The model type to find.

Returns:

Promise
importDatabase
(
  • config
)
Promise public

Defined in addon/services/indexed-db.js:473

Import a complete database dump as created by this.exportDatabase()

Also available as a task: indexedDb.importDatabaseTask.perform()

Parameters:

  • config Object

    A configuration object as created by this.exportDatabase()

Returns:

Promise
query
(
  • type
  • query
)
Promise[][] public

Defined in addon/services/indexed-db.js:146

Query indexedDB. This uses _buildQuery under the hood. This resolved to an array.

Parameters:

  • type String

    The model type to query

  • query Object

    The query data

Returns:

Promise[][]
queryRecord
(
  • type
  • query
)
Promise public

Defined in addon/services/indexed-db.js:168

Query indexedDB. This uses _buildQuery under the hood. This resolved to an object.

Parameters:

  • type String

    The model type to query

  • query Object

    The query data

Returns:

Promise
save
(
  • type
  • id
  • item
)
Promise public

Defined in addon/services/indexed-db.js:269

Save/update an item.

Parameters:

  • type String

    The model type of the object

  • id String

    The id of the object

  • item Object

    The serialized object to save.

Returns:

Promise
saveBulk
(
  • type
  • item
)
Promise public

Defined in addon/services/indexed-db.js:292

This will wait for 10ms and try to build a queue, and save everything at once if possible.

Parameters:

  • type String

    The model type to save

  • item Object

    The data to save

Returns:

Promise
setup () Promise public

Defined in addon/services/indexed-db.js:109

Call this and wait until it resolves before doing anything with IndexedDB! This should be done in beforeModel() on the application route. It will reject if IndexedDB is not available.

Also available as a task: indexedDb.setupTask.perform()

Returns:

Promise
waitForQueue () Promise public

Defined in addon/services/indexed-db.js:519

Wait for all queued objects ot be resolved. This will resolve when there are no open processes anymore.

Also available as a task: indexedDb.waitForQueueTask.perform()

Returns:

Promise

_promiseQueue

Promise[] private

Defined in addon/services/indexed-db.js:88

All currently running promises are temporarily saved here. This is used to check if there are running transactions.

_savePromise

Promise private

Defined in addon/services/indexed-db.js:78

This is a promise that is used for bulk saving. All bulkSave() operations use and return the same promise, which is cached here.

_saveQueue

Object private

Defined in addon/services/indexed-db.js:57

This is an object with an array per model type. It holds all the objects per model type that should be bulk saved. After actually saving, this will be cleared.

_shouldLogQuery

Boolean private

Defined in addon/services/indexed-db.js:46

If set to true, it will output which indecies are used for queries. This can be used to debug your indecies.


Default: false

_supportsCompoundIndicies

Boolean private

Defined in addon/services/indexed-db.js:98

e.g. MS Edge doesn't support compound indices. For these cases, querying shouldn't try to use them.

_testWaiter

Function private

Defined in addon/services/indexed-db.js:68

This is the test waiter used to ensure all promises are resolved in tests. This is set by the this._registerTestWaiter() method.

databaseName

String public

Defined in addon/services/indexed-db.js:35

The database name to use. Overwrite this if you want to use something different.


Default: 'ember-indexeddb'

db

Dexie public

Defined in addon/services/indexed-db.js:26

The actual Dexie database.