The add()
method of the IDBObjectStore
interface 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 to an object store.
To determine if the add operation has completed successfully, listen for the transaction’s complete
event in addition to the IDBObjectStore.add
request’s success
event, because the transaction may still fail after the success event fires. In other words, the success event is only triggered when the transaction has been successfully queued.
The add method is an insert only method. If a record already exists in the object store with the key
parameter as its key, then an error ConstrainError
event is fired on the returned request object. For updating existing records, you should use the IDBObjectStore.put
method instead.
Note: This feature is available in Web Workers.
Syntax
var request = objectStore.add(value); var request = objectStore.add(value, key);
Parameters
- value
- The value to be stored.
- key Optional
- The key to use to identify the record. If unspecified, it results to null.
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:
|
InvalidStateError
|
The IDBObjectStore has been deleted or removed.
|
DataCloneError
|
The data being stored could not be cloned by the internal structured cloning algorithm.
|
ConstraintError
|
An insert operation failed because the primary key constraint was violated (due to an already existing record with the same primary key value). |
Example
In the following code snippet, we open a read/write transaction on our database and add some data to an object store using add()
. 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. For a full working example, see our To-do Notifications app ([[../../../../../../../mdn.github.io/to-do-notifications/index|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 to insert 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 the transaction completing, when everything is done
transaction.oncomplete = function(event) {
note.innerHTML += '<li>Transaction completed.</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");
// Make a request to add our newItem object to the object store
var objectStoreRequest = objectStore.add(newItem[0]);
objectStoreRequest.onsuccess = function(event) {
// report the success of our request
note.innerHTML += '<li>Request successful.</li>';
};
};
Specification
Specification | Status | Comment |
Indexed Database API 2.0The definition of 'add()' in that specification. | Recommendation | |
Indexed Database API DraftThe definition of 'add()' in that specification. | Recommendation |
Browser compatibility
The compatibility table on this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.
Update compatibility data on GitHub
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
add
|
Chrome Full support 24 Full support 24 No support 23 — 57 Prefixed' Implemented with the vendor prefix: webkit |
Edge
Full support 12 |
Firefox Full support 16 Full support 16 No support 10 — 16 Prefixed' Implemented with the vendor prefix: moz |
IE
Partial support 10 |
Opera
Full support 15 |
Safari
Full support 7 |
WebView Android Full support Yes Full support Yes No support ? — 57 Prefixed' Implemented with the vendor prefix: webkit |
Chrome Android Full support 25 Full support 25 No support 25 — 57 Prefixed' Implemented with the vendor prefix: webkit |
Firefox Android
Full support 22 |
Opera Android
Full support 14 |
Safari iOS
Full support 8 |
Samsung Internet Android Full support 1.5 Full support 1.5 No support 1.5 — 7.0 Prefixed' Implemented with the vendor prefix: webkit |
Legend
- Full support
- Full support
- Partial support
- Partial support
- Requires a vendor prefix or different name for use.'
- Requires a vendor prefix or different name for use.
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 ([[../../../../../../../mdn.github.io/to-do-notifications/index|view example live]].)
IDBObjectStore.add() by Mozilla Contributors is licensed under CC-BY-SA 2.5.