IDBObjectStore.put

If the record is successfully stored, then a success event is fired on the returned request object with the result set to the key for the stored record, and the transaction set to the transaction in which this object store is opened.

The put method is an update or insert method. See the IDBObjectStore.add method for an insert only method.

Syntax

var request = objectStore.put(myItem, optionalKey);

Returns

An IDBRequest object on which subsequent events related to this operation are fired.

Exceptions

This method may raise a DOMException of one of the following types:

Exception	Description
ReadOnlyError	The transaction associated with this operation is in read-only mode.
TransactionInactiveError	This IDBObjectStore's transaction is inactive.
DataError	Any of the following conditions apply: The object store uses in-line keys or has a key generator, and a key parameter was provided. The object store uses out-of-line keys and has no key generator, and no key parameter was provided. The object store uses in-line keys but no key generator, and the object store's key path does not yield a valid key. The key parameter was provided but does not contain a valid key.
InvalidStateError	The IDBObjectStore has been deleted or removed.
DataCloneError	The data being stored could not be cloned by the internal structured cloning algorithm.

Example

The following example requests a given record title; when that request is successful the onsuccess function 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 with put(). 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();
  };
};

Parameters

value

The value to be stored.

key

The key to use to identify the record. If unspecified, it results to null.

Specification

Specification	Status	Comment
Indexed Database API The definition of 'put()' in that specification.	Recommendation

Browser compatibility

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 example live.)