IDBFactory
Baseline Widely available
This feature is well established and works across many devices and browser versions. It’s been available across browsers since September 2021.
Note: This feature is available in Web Workers.
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
.
Instance methods
IDBFactory.open()
-
Requests opening a connection 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 our To-do Notifications app (view example live).
// Let us open version 4 of our database
const DBOpenRequest = window.indexedDB.open("toDoList", 4);
// these two event handlers act on the database being opened successfully, or not
DBOpenRequest.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
BCD tables only load in the browser
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).