IDBFactory
BaselineWidely available *
This feature is well established and works across many devices and browser versions. It’s been available across browsers since July 2015.
* Some parts of this feature may have varying levels of support.
Note: This feature is available inWeb Workers.
TheIDBFactory
interface of theIndexedDB API lets applications asynchronously access the indexed databases. The object that implements the interface iswindow.indexedDB
. You open — that is, create and access — and delete a database with this object, and not directly withIDBFactory
.
Instance methods
IDBFactory.open()
Requests opening aconnection to a database.
IDBFactory.deleteDatabase()
Requests the deletion of a database.
IDBFactory.cmp()
Compares two keys and returns a result indicating which one is greater in value.
IDBFactory.databases()
Returns a promise that fulfills with an array of all available databases, including their names and versions.
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 ourTo-do Notifications app (view example live).
// Let us open version 4 of our databaseconst DBOpenRequest = window.indexedDB.open("toDoList", 4);// these two event handlers act on the database being opened successfully, or notDBOpenRequest.onerror = (event) => { console.error("Error loading database.");};DBOpenRequest.onsuccess = (event) => { console.info("Database initialized."); // 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 |
---|
Indexed Database API 3.0 # factory-interface |
Browser compatibility
See also
- Using IndexedDB
- Starting transactions:
IDBDatabase
- Using transactions:
IDBTransaction
- Setting a range of keys:
IDBKeyRange
- Retrieving and making changes to your data:
IDBObjectStore
- Using cursors:
IDBCursor
- Reference example:To-do Notifications (View the example live).