Base de conocimientosCentro de exámenes
ESEspañol
Elegir idioma13

CKTIS / JavaScript

IndexedDB: añadir, leer, eliminar y reemplazar registros

Usa `add()`, `getAll()`, `delete()` y `put()` para trabajar con registros por clave primaria y distinguir el éxito de una solicitud de la confirmación de la transacción.

Versión: ECMAScript 2024 and the current web platform; runtime support varies

Sintaxis

store.add(value)
store.add(value, key)
store.getAll()
store.getAll(query)
store.getAll(query, count)
store.getAll(options)
store.delete(keyOrRange)
store.put(value)
store.put(value, key)

Los métodos add(), getAll(), delete() y put() pertenecen a la interfaz IDBObjectStore de IndexedDB, no a ECMAScript. El almacén de objetos se obtiene de una transacción. El acceso a los datos sigue la política de mismo origen (esquema, host y puerto); la compatibilidad depende del entorno de ejecución.

add(value) solo inserta: si ya existe la clave primaria, la solicitud falla con ConstraintError. put(value) inserta o reemplaza todo el valor asociado a esa clave; no combina los campos. Si la clave está dentro del valor, omite el segundo argumento: keyPath indica dónde encontrarla. Si la clave es externa, pasa key como segundo argumento, salvo que deba asignarla un generador de claves habilitado. Ambos métodos almacenan un clon estructurado del valor y, si tienen éxito, dejan la clave en request.result. Un valor que no se puede clonar, como una función, provoca un DataCloneError síncrono.

getAll() deja en request.result un array de valores clonados, sin claves adjuntas por separado; si no hay coincidencias, devuelve [] como resultado de la solicitud. El orden predeterminado es ascendente por clave primaria, no por orden de inserción. getAll(query, count) permite seleccionar una clave o un IDBKeyRange y limitar los resultados con un count positivo. La forma getAll({ query, count, direction }) también permite indicar el sentido, por ejemplo "prev" para el orden descendente; comprueba si los navegadores de destino la admiten.

delete(keyOrRange) elimina un registro por clave primaria o todos los registros de un IDBKeyRange. Si la solicitud tiene éxito, el resultado es undefined, aunque no haya coincidencias. Este método no es el operador delete de JavaScript; usa clear() para vaciar el almacén.

Los cuatro métodos devuelven inmediatamente un IDBRequest, no una Promise. Para leer basta con readonly; las escrituras ordinarias requieren readwrite. Encola las solicitudes mientras la transacción esté activa, por ejemplo al crearla o en un manejador de eventos de una solicitud, no después de esperar una respuesta de red. De forma predeterminada, un error de solicitud aborta la transacción y revierte sus cambios. success corresponde a una sola solicitud; complete confirma que se ha confirmado la transacción.

Ejemplos

void (async () => {
  const { indexedDB, crypto } = globalThis;
  if (!indexedDB || typeof crypto?.randomUUID !== 'function') {
    throw new Error('Run this example on an HTTPS page in a browser with IndexedDB and crypto.randomUUID() available.');
  }

  const name = `cktis-idb-${crypto.randomUUID()}`;
  const open = indexedDB.open(name, 1);
  open.onupgradeneeded = () => {
    open.result.createObjectStore('tasks', { keyPath: 'id' });
  };
  const db = await new Promise((resolve, reject) => {
    open.onsuccess = () => resolve(open.result);
    open.onerror = () => reject(open.error);
  });

  try {
    const tx = db.transaction('tasks', 'readwrite');
    const store = tx.objectStore('tasks');
    store.add({ id: 2, title: 'Draft', tag: 'temporary' });
    store.add({ id: 1, title: 'Remove me' });
    const before = store.getAll();
    store.put({ id: 2, title: 'Published' });
    store.delete(1);
    const after = store.getAll();

    await new Promise((resolve, reject) => {
      tx.oncomplete = () => resolve();
      tx.onabort = () => reject(tx.error ?? new Error('Transaction aborted'));
    });
    console.log(JSON.stringify(before.result));
    console.log(JSON.stringify(after.result));
  } finally {
    db.close();
    const cleanup = indexedDB.deleteDatabase(name);
    await new Promise((resolve, reject) => {
      cleanup.onsuccess = () => resolve();
      cleanup.onerror = () => reject(cleanup.error);
    });
  }
})().catch((error) => console.error(error));

Resultado

[{"id":1,"title":"Remove me"},{"id":2,"title":"Draft","tag":"temporary"}]
[{"id":2,"title":"Published"}]

Ejecuta el código en la consola de desarrollo de una página HTTPS donde estén disponibles IndexedDB y `crypto.randomUUID()` y se permita el almacenamiento. Una vez confirmada la transacción, la primera línea muestra ambos registros por orden de clave. La segunda muestra que `put()` no conservó `tag` y que `delete()` eliminó el registro con la clave `1`. El código cierra la conexión y solicita eliminar la base de datos temporal.

Lecciones relacionadas

  • JavaScript · Lección 20 · Intermedio · Versión: 3

Fuentes