CKTIS / JavaScript
IndexedDB: onupgradeneeded i transakcija nadogradnje
Promijeni shemu IndexedDB-a u `onupgradeneeded`, dohvati transakciju preko `request.transaction` i koristi novu shemu tek nakon događaja `success`.
Verzija: Current web platform; runtime support varies
Sintaksa
// The upgrade lifecycle is defined by IndexedDB, not by an ECMAScript edition.
const request = indexedDB.open(name, version);
request.onupgradeneeded = (event) => {
const db = request.result;
const tx = request.transaction;
// Apply schema changes through db and tx while tx is active.
};indexedDB.open(name, version) odmah vraća IDBOpenDBRequest; baza se otvara asinkrono. onupgradeneeded je svojstvo za postavljanje funkcije za obradu događaja upgradeneeded. Taj se događaj pokreće pri stvaranju baze ili otvaranju s višom verzijom. Ne pokreće se pri istoj verziji, a zahtjev s nižom verzijom završava pogreškom VersionError. IndexedDB je web API, a ne dio ECMAScripta 2024.
U funkciji za obradu događaja request.result sadrži vezu IDBDatabase. Svojstvo request.transaction, naslijeđeno od IDBRequest, dostupno je samo za čitanje i sadrži IDBTransaction koju IndexedDB automatski stvara u načinu "versionchange". Odmah nakon open() i ponovno pri događaju success vrijednost je null. db.transaction() pokreće zasebnu transakciju u načinu "readonly" ili "readwrite", a ne transakciju nadogradnje.
Pomoću event.oldVersion i event.newVersion odaberi korake migracije. Za novu bazu oldVersion iznosi 0; zasebne provjere verzija omogućuju izvođenje više koraka kada se preskoče međuverzije. Stvori spremište objekata pomoću db.createObjectStore(), a postojećem spremištu dodaj indeks pomoću tx.objectStore(name).createIndex(). U istoj transakciji možeš migrirati i zapise.
Zadaj operacije dok je transakcija aktivna: izravno u funkciji za obradu upgradeneeded ili u funkcijama za obradu događaja njezinih zahtjeva. Nemoj pretpostaviti da ostaje aktivna nakon await fetch() ili u povratnoj funkciji mjerača vremena. tx.abort() poništava promjene sheme, podataka i verzije; zahtjev za otvaranje tada pokreće error umjesto success. Ako se transakcija potvrdi, njezin complete prethodi događaju success zahtjeva za otvaranje.
Postojeća veza, primjerice u drugoj kartici, može odgoditi nadogradnju. Obradi blocked na zahtjevu za otvaranje i zatvori postojeće veze pomoću db.close() pri obradi njihova događaja versionchange.
Primjeri
<!doctype html>
<meta charset="utf-8">
<title>IndexedDB upgrade transaction</title>
<script>
(() => {
const name = `cktis-indexeddb-${crypto.randomUUID()}`;
const reportError = (event) => console.error(event.target.error);
function openVersion(version) {
const request = indexedDB.open(name, version);
request.onerror = reportError;
request.onupgradeneeded = ({ oldVersion, newVersion }) => {
const db = request.result;
const tx = request.transaction;
if (oldVersion < 1) db.createObjectStore("books", { keyPath: "id" });
if (oldVersion < 2 && newVersion >= 2) {
console.log(`upgrade: ${oldVersion} -> ${newVersion} (${tx.mode})`);
tx.objectStore("books").createIndex("by_title", "title");
tx.oncomplete = () => console.log("complete");
}
};
return request;
}
const first = openVersion(1);
first.onsuccess = () => {
first.result.close();
const second = openVersion(2);
console.log(`before: ${second.transaction}`);
second.onsuccess = () => {
const db = second.result;
const store = db.transaction("books", "readonly").objectStore("books");
console.log(`success: ${second.transaction}; index: ${store.indexNames.contains("by_title")}`);
db.close();
indexedDB.deleteDatabase(name).onerror = reportError;
};
};
})();
</script>Rezultat
before: null upgrade: 1 -> 2 (versionchange) complete success: null; index: true
Otvori HTML stranicu u pregledniku u sigurnom kontekstu s pristupom IndexedDB-u i `crypto.randomUUID()`. Ispis pogledaj u konzoli za razvojne programere. Primjer stvara bazu nasumičnog naziva u verziji 1, zatvara vezu, dodaje `by_title` u verziji 2 i nakon provjere indeksa zahtijeva brisanje testne baze.
Povezane lekcije
- JavaScript · Lekcija 31 · Napredno · Verzija: 4
Izvori
- IDBOpenDBRequest: upgradeneeded event
- IDBRequest: transaction property
- IDBFactory: open() method
- IDBRequest: error property
- IDBTransaction
- IDBDatabase: transaction() method
- Using IndexedDB
- IDBOpenDBRequest: blocked event
- IDBDatabase: versionchange event
- IDBObjectStore: createIndex() method
- Crypto: randomUUID() method
- IDBFactory: deleteDatabase() method