IDBRequest

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

The IDBRequest interface of the IndexedDB API provides access to results of asynchronous requests to databases and database objects using event handler attributes. Each reading and writing operation on a database is done using a request.

The request object does not initially contain any information about the result of the operation, but once information becomes available, an event is fired on the request, and the information becomes available through the properties of the IDBRequest instance.

All asynchronous operations immediately return an IDBRequest instance. Each request has a readyState that is set to the 'pending' state; this changes to 'done' when the request is completed or fails. When the state is set to done, every request returns a result and an error, and an event is fired on the request. When the state is still pending, any attempt to access the result or error raises an InvalidStateError exception.

In plain words, all asynchronous methods return a request object. If the request has been completed successfully, the result is made available through the result property and an event indicating success is fired at the request ({{domxref("IDBRequest.success_event", "success")}} ). If an error occurs while performing the operation, the exception is made available through the error property and an error event is fired ({{domxref("IDBRequest.error_event", "error")}} ).

The interface {{domxref("IDBOpenDBRequest")}} is derived from IDBRequest.

{{InheritanceDiagram}}

Instance properties

Also inherits properties from {{domxref("EventTarget")}} .

{{domxref("IDBRequest.error")}} {{ReadOnlyInline}}
- : Returns a {{domxref("DOMException")}} in the event of an unsuccessful request, indicating what went wrong.
{{domxref("IDBRequest.result")}} {{ReadOnlyInline}}
- : Returns the result of the request. If the request is not completed, the result is not available and an InvalidStateError exception is thrown.
{{domxref("IDBRequest.source")}} {{ReadOnlyInline}}
- : The source of the request, such as an {{domxref("IDBIndex")}} or an {{domxref("IDBObjectStore")}} . If no source exists (such as when calling {{domxref("IDBFactory.open")}} ), it returns null.
{{domxref("IDBRequest.readyState")}} {{ReadOnlyInline}}
- : The state of the request. Every request starts in the pending state. The state changes to done when the request completes successfully or when an error occurs.
{{domxref("IDBRequest.transaction")}} {{ReadOnlyInline}}
- : The transaction for the request. This property can be null for certain requests, for example those returned from {{domxref("IDBFactory.open")}} unless an upgrade is needed. (You’re just connecting to a database, so there is no transaction to return).

Instance methods

No methods, but inherits methods from {{domxref("EventTarget")}} .

Events

Listen to these events using addEventListener() or by assigning an event listener to the oneventname property of this interface.

error
- : Fired when an error caused a request to fail.
success
- : Fired when an IDBRequest succeeds.

Example

In the following code snippet, we open a database asynchronously and make a request; onerror and onsuccess functions are included to handle the success and error cases. For a full working example, see our To-do Notifications app (view example live.)

let db;

// Let us open 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) => {
  note.appendChild(document.createElement("li")).textContent =
    "Error loading database.";
};

DBOpenRequest.onsuccess = (event) => {
  note.appendChild(document.createElement("li")).textContent =
    "Database initialized.";

  // store the result of opening the database.
  db = DBOpenRequest.result;
};

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}

docs.rodeo

MDN Web Docs mirror