Znalostná bázaCentrum skúšok
SKSlovenčina
Vybrať jazyk13

CKTIS / JavaScript

IndexedDB: onupgradeneeded a transakcia zmeny verzie

Zmeňte schému IndexedDB v `onupgradeneeded`, získajte transakciu cez `request.transaction` a novú schému používajte až po udalosti `success`.

Verzia: Current web platform; runtime support varies

Syntax

// 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) ihneď vráti IDBOpenDBRequest; databáza sa otvára asynchrónne. onupgradeneeded je vlastnosť na nastavenie obsluhy udalosti upgradeneeded. Tá nastane pri vytvorení databázy alebo pri jej otvorení s vyššou verziou. Pri rovnakej verzii nenastane; požiadavka s nižšou verziou zlyhá s chybou VersionError. IndexedDB je webové API, nie súčasť ECMAScriptu 2024.

V obsluhe udalosti obsahuje request.result pripojenie IDBDatabase. Vlastnosť request.transaction, zdedená z IDBRequest a určená len na čítanie, obsahuje IDBTransaction, ktorú IndexedDB automaticky vytvára v režime "versionchange". Ihneď po open() a opäť pri success má hodnotu null. db.transaction() spúšťa samostatnú transakciu v režime "readonly" alebo "readwrite", nie transakciu zmeny verzie.

Pomocou event.oldVersion a event.newVersion vyberte kroky migrácie. Pri novej databáze má oldVersion hodnotu 0; samostatné kontroly verzie umožňujú vykonať viac krokov pri preskočení medziverzií. Úložisko objektov vytvorte pomocou db.createObjectStore() a do existujúceho úložiska pridajte index pomocou tx.objectStore(name).createIndex(). V tej istej transakcii môžete migrovať aj záznamy.

Zadávajte operácie, kým je transakcia aktívna: priamo v obsluhe upgradeneeded alebo v obsluhe udalostí jej požiadaviek. Nespoliehajte sa na to, že zostane aktívna po await fetch() alebo v spätnej funkcii časovača. tx.abort() vráti späť zmeny schémy, údajov aj verzie; požiadavka na otvorenie vyvolá error namiesto success. Ak sa transakcia potvrdí, jej udalosť complete predchádza udalosti success požiadavky na otvorenie.

Existujúce pripojenie, napríklad na inej karte, môže zmenu verzie zdržať. Ošetrite blocked na požiadavke na otvorenie a existujúce pripojenia zatvárajte pomocou db.close() v ich obsluhe versionchange.

Príklady

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

Výsledok

before: null
upgrade: 1 -> 2 (versionchange)
complete
success: null; index: true

Otvorte stránku HTML v prehliadači v zabezpečenom kontexte s prístupom k IndexedDB a `crypto.randomUUID()`. Výstup nájdete vo vývojárskej konzole. Príklad vytvorí databázu s náhodným názvom vo verzii 1, zatvorí pripojenie, vo verzii 2 pridá `by_title` a po overení indexu požiada o odstránenie testovacej databázy.

Súvisiace lekcie

  • JavaScript · Lekcia 31 · Pokročilá · Verzia: 4

Zdroje