Join MDN and developers like you at Mozilla's View Source conference, 12-14 September in Berlin, Germany. Learn more at https://viewsourceconf.org

IDBRequest.transaction

The transaction property of the IDBRequest interface returns the transaction for the request, that is, the transaction the request is being made inside.

This property can be null for requests not made within transactions, such as for requests returned from IDBFactory.open — in this case you're just connecting to a database, so there is no transaction to return. If a version upgrade is needed when opening a database then during the upgradeneeded event handler the transaction property will be an IDBTransaction with mode equal to "versionchange", and can be used to access existing object stores and indexes, or abort the the upgrade. Following the upgrade, the transaction ​property will again be null.

Note: This feature is available in Web Workers.

Syntax

var myTransaction = request.transaction;

Value

An IDBTransaction.

Example

The following example requests a given record title, onsuccess gets the associated record from the IDBObjectStore (made available as objectStoreTitleRequest.result), updates one property of the record, and then puts the updated record back into the object store in another request. The source of the requests is logged to the developer console — both originate from the same transaction. For a full working example, see our To-do Notifications app (view example live.)

var title = "Walk dog";

// Open up a transaction as usual
var objectStore = db.transaction(['toDoList'], "readwrite").objectStore('toDoList');

// Get the to-do list object that has this title as it's title
var objectStoreTitleRequest = objectStore.get(title);

objectStoreTitleRequest.onsuccess = function() {
  // Grab the data object returned as the result
  var data = objectStoreTitleRequest.result;

  // Update the notified value in the object to "yes"
  data.notified = "yes";

  // Create another request that inserts the item back into the database
  var updateTitleRequest = objectStore.put(data);

  // Log the transaction that originated this request
  console.log("The transaction that originated this request is " + updateTitleRequest.transaction);

  // When this new request succeeds, run the displayData() function again to update the display
  updateTitleRequest.onsuccess = function() {
    displayData();
  };
};

This example shows how a the transaction property can be used during a version upgrade to access existing object stores:​

var openRequest = indexedDB.open('db', 2);
console.log(openRequest.transaction); // Will log "null".

openRequest.onupgradeneeded = function(event) {
  console.log(openRequest.transaction.mode); // Will log "versionchange".
  var db = openRequest.result;
  if (event.oldVersion < 1) {
    // New database, create "books" object store.
    db.createObjectStore('books');
  }
  if (event.oldVersion < 2) {
    // Upgrading from v1 database: add index on "title" to "books" store.
    var bookStore = openRequest.transaction.objectStore('books');
    bookStore.createIndex('by_title', 'title');
  }
};

openRequest.onsuccess = function() {
  console.log(openRequest.transaction); // Will log "null".
};

Specifications

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

Browser compatibility

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

See also

Document Tags and Contributors

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