W3cubDocs

IDBFactory

The IDBFactory interface of the IndexedDB API lets applications asynchronously access the indexed databases. The object that implements the interface is window.indexedDB. You open — that is, create and access — and delete a database with this object, and not directly with IDBFactory.

Note: This feature is available in Web Workers.

Methods

IDBFactory.open: The current method to request opening a connection to a database.
IDBFactory.deleteDatabase: A method to request the deletion of a database.
IDBFactory.cmp: A method that compares two keys and returns a result indicating which one is greater in value.

Example

In the following code snippet, we make a request to open a database, and include handlers for the success and error cases. For a full working example, see our To-do Notifications app (view example live.)

var note = document.querySelector("ul");

// In the following line, you should include the prefixes of implementations you want to test.
window.indexedDB = window.indexedDB || window.mozIndexedDB || window.webkitIndexedDB || window.msIndexedDB;
// DON'T use "var indexedDB = ..." if you're not in a function.
// Moreover, you may need references to some window.IDB* objects:
window.IDBTransaction = window.IDBTransaction || window.webkitIDBTransaction || window.msIDBTransaction;
window.IDBKeyRange = window.IDBKeyRange || window.webkitIDBKeyRange || window.msIDBKeyRange;
// (Mozilla has never prefixed these objects, so we don't need window.mozIDB*)

// Let us open version 4 of our database
var DBOpenRequest = window.indexedDB.open("toDoList", 4);

// these two event handlers act on the database being opened successfully, or not
DBOpenRequest.onerror = function(event) {
  note.innerHTML += '<li>Error loading database.</li>';
};
 
DBOpenRequest.onsuccess = function(event) {
  note.innerHTML += '<li>Database initialised.</li>';
    
  // store the result of opening the database in the db variable. This is used a lot later on, for opening transactions and suchlike.
  db = DBOpenRequest.result;
};

Specifications

Specification	Status	Comment
Indexed Database API The definition of 'IDBFactory' in that specification.	Recommendation
Indexed Database API 2.0 The definition of 'IDBFactory' in that specification.	Recommendation

Browser compatibilityUpdate compatibility data on GitHub

	Desktop
	Chrome	Edge	Firefox	Internet Explorer	Opera	Safari
Basic support	24 24 23 — 57 Prefixed Prefixed Requires the vendor prefix: webkit	Yes	16 16 10 — 16 Prefixed Prefixed Requires the vendor prefix: moz	10 10 partial	15	7
Available in workers	Yes	Yes	37	?	Yes	?
`cmp`	24 24 23 — 24 Prefixed Prefixed Requires the vendor prefix: webkit	12	16 16 10 — 16 Prefixed Prefixed Requires the vendor prefix: moz	10 10 partial	15	7
`deleteDatabase`	24 24 23 — 24 Prefixed Prefixed Requires the vendor prefix: webkit	12	16 16 10 — 16 Prefixed Prefixed Requires the vendor prefix: moz	10 10 partial	15	7
`open`	24 24 23 — 24 Prefixed Prefixed Requires the vendor prefix: webkit	12	16 16 10 — 16 Prefixed Prefixed Requires the vendor prefix: moz	10 10 partial	15	7

	Mobile
	Android webview	Chrome for Android	Edge Mobile	Firefox for Android	Opera for Android	iOS Safari	Samsung Internet
Basic support	Yes Yes ? — 57 Prefixed Prefixed Requires the vendor prefix: webkit	25 25 25 — 57 Prefixed Prefixed Requires the vendor prefix: webkit	?	22	22	8	Yes Yes ? — 7.0 Prefixed Prefixed Requires the vendor prefix: webkit
Available in workers	Yes	Yes	Yes	37	Yes	?	Yes
`cmp`	Yes Yes ? — ? Prefixed Prefixed Requires the vendor prefix: webkit	25	Yes	22	22	8	Yes
`deleteDatabase`	Yes Yes ? — ? Prefixed Prefixed Requires the vendor prefix: webkit	25	Yes	22	22	8	Yes
`open`	Yes Yes ? — ? Prefixed Prefixed Requires the vendor prefix: webkit	25	Yes	22	22	8	Yes

IDBFactory

Methods

Example

Specifications

Browser compatibilityUpdate compatibility data on GitHub

See also