IDBObjectStore.add
El metodo add()
de la interfaz IDBObjectStore
retorna un objeto IDBRequest
(en-US), y, un hilo separado, crea un clone estructurado del valor, y almacena el valor clonado en el almacén de objetos. Esto es para agregar nevos registros a un almacén de objetos.
Para determinar si la operación de agregar fue completada satisfactoriamente, escucha el evento complete
de la transaccion en adicion al evento success
de la peticion IDBojectStore.add
, porque la transaccion y todavía puede fallar después de lanzar el evento success. En otras palabras, el eventos success sólo es lanzado cuando la transacción ha sido puesta en cola satisfactoriamente.
El método agregar es un método de sólo inserción. Si un registro ya existe en el almacén de objetos con el argumento key
como su clave, entonces un error ConstrainError
es lanzado en el objeto petición devuelto. Para actualizar registros existentes, debes usar el método IDBObjectStore.put
(en-US) en su lugar.
Sintaxis
var request = objectStore.add(myItem, optionalKey);
Retorno
Un objeto IDBRequest
(en-US) en el que los eventos subsecuentes relacionados a esta operación son lanzados.
Excepciones
Este método puede generar un DOMException
(en-US) con un DOMError
de uno de los siguiente tipos:
Excepción | Descripción |
---|---|
ReadOnlyError |
La transacción asociada con esta operación está en un modo de sólo lectura. |
TransactionInactiveError |
Esta transacción de IDBObjectStore 's está inactiva. |
DataError |
Cualquiera de los siguientes condiciones aplica:
|
InvalidStateError |
El IDBObjectStore ha sido borrado o removido. |
DataCloneError |
Los datos siendo almacenados no pueden ser clonados por el algoritmo de clonado estructurado interno. |
Ejemplo
En el siguiente código, abrimos una transacción read/write en nuestra base de datos y agregado algunos datos al almacén de datos usando add()
. También ten en cuenta que las funciones adjuntas a los manejadores de eventos de la transacción para informar en la salida de la apertura de transacciones en el evento de éxito o falla. Para un ejemplo completo funcionando, mira nuestra aplicación To-do Notifications (ver ejemplo).
// Abrimos nuestra base de datos
var DBOpenRequest = window.indexedDB.open("toDoList", 4);
DBOpenRequest.onsuccess = function(event) {
note.innerHTML += '<li>Database initialised.</li>';
// Almacenar el resultado de la apertura de la base de datos en la variable db. Esta es usada mucho después
db = DBOpenRequest.result;
// Ejecuta la función addData() para agregar los datos
addData();
};
function addData() {
// Crea un nuevo objeto listo para ser insertado en la IDB
var newItem = [ { taskTitle: "Walk dog", hours: 19, minutes: 30, day: 24, month: "December", year: 2013, notified: "no" } ];
// Inicia una transacción de lectura/escritura db transaction, lista para agregar los datos
var transaction = db.transaction(["toDoList"], "readwrite");
// Informa sobre el éxito de la inicio de la transacción
transaction.oncomplete = function(event) {
note.innerHTML += '<li>Transaction completed: database modification finished.</li>';
};
transaction.onerror = function(event) {
note.innerHTML += '<li>Transaction not opened due to error. Duplicate items not allowed.</li>';
};
// Crea una almacén de objetos en la transacción
var objectStore = transaction.objectStore("toDoList");
// Agrega nuestro objeto newItem al almacén de objetos
var objectStoreRequest = objectStore.add(newItem[0]);
objectStoreRequest.onsuccess = function(event) {
//Informa sobre el éxito de nuestro nuevo elemento en la base de datos
note.innerHTML += '<li>New item added to database.</li>';
};
};
Parámetros
- value
- El valor para ser almacenado.
- key
- La llave a usar para identificar el registro. Si no es especificada, el resultado es nulo.
Especificación
Especificación | Estado | Comentario |
---|---|---|
Indexed Database API 2.0 La definición de 'add()' en esta especificación. |
Recommendation |
Compatibilidad de navegadores
Característica | Chrome | Firefox (Gecko) | Internet Explorer | Opera | Safari (WebKit) |
---|---|---|---|---|---|
Soporte básico | 23webkit (en-US) 24 |
10 moz (en-US) 16.0 (16.0) |
10, partial | 15 | 7.1 |
Característica | Android | Firefox Mobile (Gecko) | Firefox OS | IE Phone | Opera Mobile | Safari Mobile |
---|---|---|---|---|---|---|
Soporte básico | 4.4 | 22.0 (22.0) | 1.0.1 | 10 | 22 | Sin soporte |
Ver también
- Usando IndexedDB
- Iniciando transacciones:
IDBDatabase
- Usando transacciones:
IDBTransaction
(en-US) - Estableciendo un rango de llaves:
IDBKeyRange
(en-US) - Obteniendo y haciendo cambios a tus datos:
IDBObjectStore
- Usando cursores:
IDBCursor
- Ejemplo de referencia: To-do Notifications (ver ejemplo.)