Baseline Widely available
Note: This feature is available in Web Workers.
The put() method of the IDBObjectStore interface updates a given record in a database, or inserts a new record if the given item does not already exist.
It returns an IDBRequest object, and, in a separate thread, creates a structured clone of the value and stores the cloned value in the object store. This is for adding new records, or updating existing records in an object store when the transaction's mode is readwrite. 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.
Bear in mind that if you have a IDBCursor to the record you want to update, updating it with IDBCursor.update() is preferable to using IDBObjectStore.put(). Doing so makes it clear that an existing record will be updated, instead of a new record being inserted.
item
The item you wish to update (or insert).
key Optional
The primary key of the record you want to update (e.g., from IDBCursor.primaryKey).
An IDBRequest object on which subsequent events related to this operation are fired.
If the operation is successful, the value of the request's result property is the key for the new or updated record.
This method may raise a DOMException of one of the following types:
ReadOnlyError DOMException
Thrown if the transaction associated with this operation is in read-only mode.
TransactionInactiveError DOMException
Thrown if this IDBObjectStore's transaction is inactive.
DataError DOMException
Thrown if any of the following conditions apply:
key parameter was provided.key parameter was provided.key generator, and the object store's key path does not yield a valid key.key parameter was provided but does not contain a valid key.InvalidStateError DOMException
Thrown if the IDBObjectStore has been deleted or removed.
DataCloneError DOMException
Thrown if the data being stored could not be cloned by the internal structured cloning algorithm.
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).
const title = "Walk dog";
// Open up a transaction as usual
const objectStore = db
.transaction(["toDoList"], "readwrite")
.objectStore("toDoList");
// Get the to-do list object that has this title as its title
const objectStoreTitleRequest = objectStore.get(title);
objectStoreTitleRequest.onsuccess = () => {
// Grab the data object returned as the result
const 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
const 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 = () => {
displayData();
};
};
IDBDatabaseIDBTransactionIDBKeyRangeIDBObjectStoreIDBCursorRetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.3