IDBFactory

{{APIRef("IndexedDB")}} {{AvailableInWorkers}}

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

• {{domxref("IDBFactory.open()")}}
  • : Requests opening a connection to a database.
• {{domxref("IDBFactory.deleteDatabase()")}}
  • : Requests the deletion of a database.
• {{domxref("IDBFactory.cmp()")}}
  • : Compares two keys and returns a result indicating which one is greater in value.
• {{domxref("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

{{Specifications}}

Browser compatibility

{{Compat}}

See also

• Using IndexedDB
• Starting transactions: {{domxref("IDBDatabase")}}
• Using transactions: {{domxref("IDBTransaction")}}
• Setting a range of keys: {{domxref("IDBKeyRange")}}
• Retrieving and making changes to your data: {{domxref("IDBObjectStore")}}
• Using cursors: {{domxref("IDBCursor")}}
• Reference example: To-do Notifications (View the example live).