IDBTransaction.abort()

The abort() method of the IDBTransaction interface rolls back all the changes to objects in the database associated with this transaction.

All pending IDBRequest objects created during this transaction have their IDBRequest.error attribute set to AbortError.

Note: This feature is available in Web Workers.

Syntax

transaction.abort();

Returns

Void.

Exceptions

This method may raise a DOMException of the following type:

Exception Description
InvalidStateError The transaction has already been committed or aborted.
 

Example

In the following code snippet, we open a read/write transaction on our database and add some data to an object store. Note also the functions attached to transaction event handlers to report on the outcome of the transaction opening in the event of success or failure. At the end, we simply abort any activity done under the current transaction using abort(). For a full working example, see our To-do Notifications app (view example live.)

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

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 below
  db = DBOpenRequest.result;
    
  // Run the addData() function to add the data to the database
  addData();
};

function addData() {
  // Create a new object ready for being inserted into the IDB
  var newItem = [ { taskTitle: "Walk dog", hours: 19, minutes: 30, day: 24, month: "December", year: 2013, notified: "no" } ];

  // open a read/write db transaction, ready for adding the data
  var transaction = db.transaction(["toDoList"], "readwrite");

  // report on the success of opening the transaction
  transaction.oncomplete = function(event) {
    note.innerHTML += '<li>Transaction completed: database modification finished.</li>';
  };


  transaction.onerror = function(event) {
    note.innerHTML += '<li>Transaction not opened due to error. Duplicate items not allowed.</li>';
  };

  // create an object store on the transaction
  var objectStore = transaction.objectStore("toDoList");

  // add our newItem object to the object store
  var objectStoreRequest = objectStore.add(newItem[0]);

  objectStoreRequest.onsuccess = function(event) {
    // report the success of our new item going into the database
    note.innerHTML += '<li>New item added to database.</li>';
  };

 // Abort the transaction we just did
 transaction.abort();
};

Specification

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

Browser compatibility

Feature Chrome Firefox (Gecko) Internet Explorer Opera Safari (WebKit)
Basic support 23webkit
24 (unprefix)
10 moz
16.0 (16.0)
10, partial 15 7.1
Available in workers (Yes) 37.0 (37.0) ? (Yes) ?
Feature Android Android Webview Firefox Mobile (Gecko) Firefox OS IE Phone Opera Mobile Safari Mobile Chrome for Android
Basic support 4.4 (Yes) 22.0 (22.0) 1.0.1 10 22 8 (Yes)
Available in workers (Yes) (Yes) 37.0 (37.0) (Yes) ? (Yes) ? (Yes)

See also

Document Tags and Contributors

 Contributors to this page: jpmedley, inexorabletash, chrisdavidmills, fscholz
 Last updated by: jpmedley,