CKTIS / JavaScript
IndexedDB: creare un indice, inserire, contare e leggere record
Crea un indice secondario, inserisci record senza sovrascriverli e cerca per chiave primaria o per chiave dell’indice.
Versione: ECMAScript 2024 and the current web platform; runtime support varies
Sintassi
store.createIndex(name, keyPath)
store.createIndex(name, keyPath, options)
store.count()
store.count(query)
store.add(value)
store.add(value, key)
store.getAll()
store.getAll(query)
store.getAll(query, count)
store.getAll(options)
store.index(name)Un IDBObjectStore rappresenta un archivio di oggetti associato a una transazione. Ogni record ha una chiave primaria e un valore. IndexedDB è un’API del Web, non fa parte di ECMAScript e segue la politica della stessa origine.
createIndex(name, keyPath, options) restituisce subito un IDBIndex, ma si può chiamare solo in una transazione versionchange attiva, di solito in upgradeneeded. Il percorso della chiave indica da dove estrarre la chiave dell’indice; non aggiunge campi al record. unique: true vieta le chiavi duplicate nell’indice, mentre multiEntry: true indicizza separatamente gli elementi validi di un array. Entrambe le opzioni valgono false per impostazione predefinita. multiEntry: true non si può usare con un percorso composto espresso come array di percorsi.
add(value, key) memorizza una copia strutturata e fornisce la nuova chiave in request.result. Ometti il secondo argomento se la chiave è nel valore; specificalo se la chiave è separata e non c’è un generatore. Una chiave primaria duplicata o la violazione dell’unicità di un indice fa fallire la richiesta con ConstraintError. Usa put() per inserire o sostituire in base alla chiave primaria.
count(query) dà un numero, mentre getAll(query, count) dà un array di copie dei valori, vuoto senza corrispondenze. Entrambi accettano una chiave primaria o un IDBKeyRange e, senza filtro, considerano tutto l’archivio. Un count positivo limita i valori restituiti da getAll(). L’ordine predefinito è crescente per chiave primaria. La forma più recente getAll({ query, count, direction }) permette di scegliere, ad esempio, "prev"; verifica il supporto del browser di destinazione.
index(name) restituisce subito un IDBIndex esistente della stessa transazione. Un nome sconosciuto genera NotFoundError; maiuscole e minuscole contano. store.getAll("sci-fi") cerca per chiave primaria, mentre store.index("byGenre").getAll("sci-fi") restituisce i valori corrispondenti alla chiave dell’indice.
add(), count() e getAll() restituiscono un IDBRequest, non una Promise. Leggi result dopo success e gestisci error. In una transazione ordinaria, per scrivere serve readwrite. Accoda le richieste mentre la transazione è attiva: aspettare un’altra operazione asincrona può lasciarla terminare. Il successo della richiesta non conferma il commit; attendi l’evento complete della transazione.
Esempi
<!doctype html>
<meta charset="utf-8">
<title>IndexedDB object store methods</title>
<script>
(() => {
const dbName = `cktis-books-${crypto.randomUUID()}`;
const open = indexedDB.open(dbName, 1);
open.onupgradeneeded = () => {
const store = open.result.createObjectStore('books', { keyPath: 'id' });
store.createIndex('byGenre', 'genre');
};
open.onerror = () => console.error(open.error);
open.onsuccess = () => {
const db = open.result;
const tx = db.transaction('books', 'readwrite');
const store = tx.objectStore('books');
const cleanup = () => {
db.close();
const deletion = indexedDB.deleteDatabase(dbName);
deletion.onerror = () => console.error(deletion.error);
};
tx.onabort = () => {
console.error(tx.error);
cleanup();
};
const added = store.add({ id: 3, title: 'Orbit', genre: 'sci-fi' });
store.add({ id: 1, title: 'Dunes', genre: 'sci-fi' });
store.add({ id: 2, title: 'Herbs', genre: 'guide' });
const total = store.count();
const all = store.getAll();
const matches = store.index('byGenre').getAll('sci-fi');
tx.oncomplete = () => {
const titles = (request) => request.result.map((book) => book.title).join(', ');
console.log(`Added key: ${added.result}`);
console.log(`Total: ${total.result}`);
console.log(`All: ${titles(all)}`);
console.log(`Sci-fi: ${titles(matches)}`);
cleanup();
};
};
})();
</script>Risultato
Added key: 3 Total: 3 All: Dunes, Herbs, Orbit Sci-fi: Dunes, Orbit
Servi questo documento HTML tramite HTTPS, aprilo in un browser e controlla la console di sviluppo. L’esempio crea un database temporaneo separato e poi lo elimina. Inserisce tre libri fuori dall’ordine delle chiavi primarie e, dopo il commit, mostra tutti i titoli per `id` e quelli selezionati dall’indice del genere.
Lezioni correlate
- JavaScript · Lezione 21 · Intermedio · Versione: 3
Fonti
- IDBObjectStore: createIndex() method
- IDBObjectStore: count() method
- IDBObjectStore: add() method
- IDBObjectStore: getAll() method
- IDBObjectStore: index() method
- IDBIndex: getAll() method
- IDBTransaction
- IDBTransaction: complete event
- IndexedDB key characteristics and basic terminology
- Using IndexedDB
- Crypto: randomUUID() method