CKTIS / JavaScript
IndexedDB: crear almacenes de objetos y abrir transacciones
Cambia el esquema al actualizar la base con `createObjectStore()` y usa `transaction()` para leer o escribir registros en almacenes ya existentes.
Versión: ECMAScript 2024 and the current web platform; runtime support varies
Sintaxis
db.createObjectStore(name) → IDBObjectStore
db.createObjectStore(name, options) → IDBObjectStore
db.transaction(storeNames) → IDBTransaction
db.transaction(storeNames, mode) → IDBTransaction
db.transaction(storeNames, mode, options) → IDBTransactionIDBDatabase representa una conexión abierta a IndexedDB. db.createObjectStore(name, options) devuelve de inmediato un nuevo IDBObjectStore, pero solo funciona en una transacción versionchange activa. IndexedDB inicia esa transacción cuando indexedDB.open() crea la base o la abre con una versión superior. Cambia el esquema en upgradeneeded. Una conexión abierta en otra pestaña puede bloquear la actualización: la solicitud de apertura emite blocked y la conexión anterior puede llamar a close() al recibir versionchange.
El keyPath opcional indica de dónde extraer la clave del valor, por ejemplo, de id. Un array de rutas define una clave compuesta; sin ruta, la clave se guarda por separado. autoIncrement vale false por defecto; true activa un generador de claves, pero no se puede combinar con una cadena vacía ni con un array como keyPath (InvalidAccessError). Un nombre de almacén duplicado da ConstraintError, una ruta no válida da SyntaxError y una llamada sin transacción de actualización da InvalidStateError.
db.transaction(storeNames, mode, options) devuelve de inmediato una IDBTransaction cuyo ámbito se define con un único nombre de almacén pasado como cadena o con un iterable no vacío de nombres de almacenes existentes, como un array o un Set. Usa tx.objectStore(name) para acceder a un almacén de ese ámbito. El modo predeterminado "readonly" solo permite leer; "readwrite" también permite escribir. Aquí no puedes elegir "versionchange" (TypeError). Un almacén desconocido da NotFoundError, una lista vacía da InvalidAccessError y una conexión cerrada o en proceso de cierre da InvalidStateError. options.durability es opcional ("default", "strict", "relaxed") e indica la preferencia de durabilidad al confirmar; comprueba la compatibilidad del navegador de destino.
Encola solicitudes solo mientras la transacción esté activa: en la tarea que la creó o en un manejador success o error de una de sus solicitudes. No des por hecho que seguirá activa tras await fetch(...): puede confirmarse automáticamente y una solicitud posterior puede lanzar TransactionInactiveError. El éxito de una solicitud no implica el de toda la transacción. complete confirma que se aplicaron los cambios y abort indica que se revirtieron.
IndexedDB es una API web, no parte de ECMAScript 2024. El acceso se limita al mismo origen; la configuración del navegador puede restringir el acceso al almacenamiento o el tiempo de conservación de los datos.
Ejemplos
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>IndexedDB example</title>
</head>
<body>
<script>
(async () => {
const idb = window.indexedDB;
const name = `cktis-notes-${crypto.randomUUID()}`;
const requestResult = (request) => new Promise((resolve, reject) => {
request.onsuccess = () => resolve(request.result);
request.onerror = () => reject(request.error);
});
const finished = (tx) => new Promise((resolve, reject) => {
tx.oncomplete = () => resolve();
tx.onabort = () => reject(tx.error ?? new Error("Transaction aborted"));
});
const open = idb.open(name, 1);
open.onupgradeneeded = () => {
open.result.createObjectStore("notes", { keyPath: "id" });
};
const db = await requestResult(open);
db.onversionchange = () => db.close();
let title;
try {
const write = db.transaction("notes", "readwrite");
write.objectStore("notes").put({ id: 1, title: "IndexedDB" });
await finished(write);
const read = db.transaction("notes");
const get = read.objectStore("notes").get(1);
await finished(read);
title = get.result.title;
} finally {
db.close();
await requestResult(idb.deleteDatabase(name));
}
console.log(title);
})().catch((error) => console.error(error));
</script>
</body>
</html>Resultado
IndexedDB
Sirve el archivo HTML a través de HTTPS y ábrelo en un navegador donde se permita el almacenamiento. El ejemplo crea una base con un nombre aleatorio, lee el registro tras confirmarse la escritura, cierra y elimina la base y después muestra `IndexedDB` en la consola del navegador.
Lecciones relacionadas
- JavaScript · Lección 31 · Avanzado · Versión: 4
Fuentes
- IDBDatabase: createObjectStore() method
- IDBDatabase: transaction() method
- IDBFactory: open() method
- Using IndexedDB
- IDBTransaction
- IDBTransaction: durability property
- IndexedDB key characteristics and basic terminology
- IDBObjectStore: put() method
- IDBObjectStore: get() method
- IDBFactory: deleteDatabase() method
- Crypto: randomUUID() method
- ECMAScript® 2024 Language Specification — Overview