База знанияИзпитен център
BGБългарски
Избери език13

CKTIS / JavaScript

IDBOpenDBRequest — отваряне и надграждане на база данни IndexedDB

IDBOpenDBRequest представлява асинхронна заявка за отваряне или изтриване на база данни IndexedDB. Чрез събитията може да обработвате актуализации на схемата, блокиране от други връзки и приключване на операцията. Това не е нито връзка с базата данни, нито Promise.

Версия: ECMAScript and Web APIs; exact feature edition and browser support reviewed per entry; Node 24 in repository does not prove browser API support

Синтаксис

const request = indexedDB.open(name, version);
request.onupgradeneeded = (event) => { /* migrate schema */ };
request.addEventListener("blocked", handler);
request.addEventListener("success", handler);
request.addEventListener("error", handler);
// request.transaction: upgrade IDBTransaction or null

IDBOpenDBRequest се връща веднага от indexedDB.open(name, version) и indexedDB.deleteDatabase(name). Наследява IDBRequest, а след това и EventTarget; получавайте резултата чрез събития, а не с await request. Това е браузърно Web API от семейството на IndexedDB, а не функция на ECMAScript. Според MDN интерфейсът е широко достъпен от юли 2015 г. MDN отделно посочва, че интерфейсът е достъпен в Web Workers. От тази дата не може да се заключи откога поддръжката в Web Workers е широко разпространена сред браузърите. Наличието на Node 24 в хранилище не доказва поддръжка на това API.

IDBOpenDBRequest.upgradeneeded обозначава събитието upgradeneeded, а не метод. То се задейства при създаване на база данни или при отварянето ѝ с по-висока версия. IDBOpenDBRequest.onupgradeneeded е свойството, на което се задава обработчикът; алтернатива е addEventListener("upgradeneeded", handler). Тук създавайте или променяйте хранилища за обекти и индекси. Наследеното свойство IDBOpenDBRequest.transaction предоставя транзакцията за надграждане в режим versionchange; без надграждане стойността му е null. То не представлява произволна последваща транзакция с данни.

IDBOpenDBRequest.blocked обозначава събитието blocked: друга отворена връзка възпрепятства надграждането или изтриването на базата данни. Това е състояние на изчакване, а не окончателна грешка. Обработвайте versionchange на всяка връзка, като я затваряте с db.close(), и уведомявайте потребителя за блокирането. Сам по себе си обработчикът blocked не затваря други връзки.

IDBOpenDBRequest.success и IDBOpenDBRequest.error обозначават събития, наследени от IDBRequest, които могат да се обработват и чрез onsuccess и onerror. След успешно отваряне request.result съдържа IDBDatabase; след изтриване стойността е undefined. Отварянето е успешно едва след потвърждаване на необходимото надграждане; upgradeneeded все още не означава успех. При грешка проверете request.error. Не четете резултата веднага след open(); обработвайте асинхронните грешки чрез error, отделно от синхронните изключения, породени от самото извикване.

Примери

<!doctype html>
<html lang="en">
<head>
  <meta charset="utf-8">
  <title>IDBOpenDBRequest: opening and upgrading a database</title>
</head>
<body>
  <h1>Opening and upgrading an IndexedDB database</h1>
  <script>
    (() => {
      const name = 'cktis-open-' + crypto.getRandomValues(new Uint32Array(4)).join('-');
      const report = error => console.log(error.name === 'SecurityError'
        ? 'IndexedDB unavailable: SecurityError' : `IndexedDB error: ${error.name}`);
      let factory, opening;
      try {
        factory = window.indexedDB;
        if (!factory) {
          console.log('IndexedDB unavailable: API missing');
          return;
        }
        opening = factory.open(name, 1);
      } catch (error) {
        report(error);
        return;
      }
      let created = false;
      opening.onerror = () => report(opening.error);
      opening.onupgradeneeded = () => {
        created = true;
        opening.result.createObjectStore('notes', { keyPath: 'id' });
      };
      opening.onsuccess = () => {
        const first = opening.result;
        if (!created) {
          first.close();
          console.log('Fixture name already in use');
          return;
        }
        // Hold the old connection open until the new request reports that it is blocked.
        const upgrade = factory.open(name, 2);
        upgrade.onblocked = event => {
          console.log(`blocked: ${event.oldVersion} -> ${event.newVersion}`);
          first.close();
        };
        upgrade.onupgradeneeded = () => {
          upgrade.result.createObjectStore('labels');
          console.log(`upgrade: ${upgrade.transaction.mode}`);
        };
        upgrade.onerror = () => {
          first.close();
          report(upgrade.error);
          factory.deleteDatabase(name);
        };
        upgrade.onsuccess = () => {
          const db = upgrade.result;
          console.log(`open: ${db.version}, labels: ${db.objectStoreNames.contains('labels')}`);
          db.close();
          const deletion = factory.deleteDatabase(name);
          deletion.onerror = () => report(deletion.error);
          deletion.onsuccess = event => console.log(`deleted version: ${event.oldVersion}`);
        };
      };
    })();
  </script>
</body>
</html>

Резултат

Observed in the isolated run (IndexedDB access denied):
IndexedDB unavailable: SecurityError

Expected on a successful run with IndexedDB access:
blocked: 1 -> 2
upgrade: versionchange
open: 2, labels: true
deleted version: 2

Показаният код и заявеният резултат са проверени в изолирана среда по метода, записан в доказателството за проверка на тази точна версия.

Източници