IDBTransaction: commit() method
BaselineWidely available
This feature is well established and works across many devices and browser versions. It’s been available across browsers since September 2021.
Note: This feature is available inWeb Workers.
Thecommit()
method of theIDBTransaction
interface commits the transaction if it is called on an active transaction.
Note thatcommit()
doesn't normallyhave to be called — a transaction will automatically commit when all outstanding requests have been satisfied and no new requests have been made.commit()
can be used to start the commit process without waiting for events from outstanding requests to be dispatched.
If it is called on a transaction that is not active, it throws anInvalidStateError
DOMException
.
Syntax
commit()
Parameters
None.
Return value
None (undefined
).
Exceptions
InvalidStateError
DOMException
Thrown if the transaction state is not active.
Examples
const note = document.getElementById("notifications");// open a read/write db transaction, ready for adding the dataconst transaction = db.transaction(["myDB"], "readwrite");// report on the success of opening the transactiontransaction.oncomplete = (event) => { note.appendChild(document.createElement("li")).textContent = "Transaction completed: database modification finished.";};transaction.onerror = (event) => { note.appendChild(document.createElement("li")).textContent = "Transaction not opened due to error. Duplicate items not allowed.";};// create an object store on the transactionconst objectStore = transaction.objectStore("myObjStore");// add our newItem object to the object storeconst objectStoreRequest = objectStore.add(newItem[0]);objectStoreRequest.onsuccess = (event) => { // report the success of the request (this does not mean the item // has been stored successfully in the DB - for that you need transaction.onsuccess) note.appendChild(document.createElement("li")).textContent = "Request successful.";};// Force the changes to be committed to the database asaptransaction.commit();
Specifications
Specification |
---|
Indexed Database API 3.0 # ref-for-dom-idbtransaction-commit② |
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 the example live).