Baza znanjaIzpitno središče
SLSlovenščina
Izberi jezik13

CKTIS / JavaScript

IndexedDB: onupgradeneeded in transakcija nadgradnje

Spremeni shemo IndexedDB v `onupgradeneeded`, pridobi transakcijo prek `request.transaction` in začni uporabljati novo shemo po dogodku `success`.

Različica: 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) takoj vrne IDBOpenDBRequest; odpiranje zbirke podatkov je asinhrono. onupgradeneeded je lastnost za nastavitev obravnavalnika dogodka upgradeneeded. Dogodek se sproži ob ustvarjanju zbirke podatkov ali odpiranju z višjo različico. Pri isti različici se ne sproži; zahteva z nižjo različico spodleti z napako VersionError. IndexedDB je spletni API in ni del ECMAScripta 2024.

V obravnavalniku request.result vsebuje povezavo IDBDatabase. Lastnost request.transaction, podedovana iz IDBRequest, je samo za branje in vsebuje transakcijo IDBTransaction, ki jo IndexedDB samodejno ustvari v načinu "versionchange". Takoj po open() in znova pri success je njena vrednost null. db.transaction() odpre ločeno transakcijo v načinu "readonly" ali "readwrite", ne transakcije nadgradnje.

Z event.oldVersion in event.newVersion izberi korake migracije. Pri novi zbirki je oldVersion enaka 0; ločena preverjanja različic omogočajo več korakov, kadar preskočiš vmesne različice. Z db.createObjectStore() ustvari shrambo objektov, v obstoječo shrambo pa dodaj indeks z tx.objectStore(name).createIndex(). V isti transakciji lahko preseliš tudi zapise.

Operacije dodajaj v čakalno vrsto, dokler je transakcija dejavna: neposredno v obravnavalniku upgradeneeded ali v obravnavalnikih dogodkov njenih zahtev. Ne računaj, da bo še dejavna po await fetch() ali ob izvajanju povratnega klica časovnika. tx.abort() razveljavi spremembe sheme, podatkov in različice; zahteva za odpiranje nato sproži error namesto success. Če se transakcija potrdi, se njen complete sproži pred dogodkom success zahteve za odpiranje.

Obstoječa povezava, na primer v drugem zavihku, lahko zadrži nadgradnjo. Obravnavaj blocked na zahtevi za odpiranje, obstoječe povezave pa zapri z db.close() v njihovih obravnavalnikih versionchange.

Primeri

<!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

Odpri stran HTML v brskalniku v varnem kontekstu z dostopom do IndexedDB in `crypto.randomUUID()`. Izpis si oglej v razvijalski konzoli. Primer ustvari zbirko z naključnim imenom v različici 1, zapre povezavo, v različici 2 doda `by_title` in po preverjanju indeksa zahteva izbris preskusne zbirke.

Povezane lekcije

  • JavaScript · Lekcija 31 · Napredna · Različica: 4

Viri