IDBOpenDBRequest:upgradeneeded 事件

Baseline 已广泛支持

此特性已相当成熟,可在许多设备和浏览器版本上使用。自 ⁨2015 年 7 月⁩以来,各浏览器均已提供此特性。

当尝试打开数据库时,如果指定的版本号高于当前版本号,则会触发 upgradeneeded 事件。

此事件不可取消,也不会冒泡。

语法

在诸如 addEventListener() 之类的方法中使用事件名称,或设置事件处理程序属性。

js
addEventListener("upgradeneeded", (event) => { })

onupgradeneeded = (event) => { }

事件类型

一个 IDBVersionChangeEvent。继承自 Event

Event IDBVersionChangeEvent

事件属性

也继承自其父接口 Event 的属性。

IDBVersionChangeEvent.oldVersion 只读

返回数据库的旧版本。

IDBVersionChangeEvent.newVersion 只读

返回数据库的新版本。

示例

此示例打开一个数据库,并通过对对象存储进行必要的更新来处理 upgradeneeded 事件。

js
// Open the database
const dBOpenRequest = window.indexedDB.open("toDoList", 4);

dBOpenRequest.addEventListener("upgradeneeded", (event) => {
  const db = event.target.result;
  console.log(`Upgrading to version ${db.version}`);

  // Create an objectStore for this database
  const objectStore = db.createObjectStore("toDoList", {
    keyPath: "taskTitle",
  });

  // define what data items the objectStore will contain
  objectStore.createIndex("hours", "hours", { unique: false });
  objectStore.createIndex("minutes", "minutes", { unique: false });
  objectStore.createIndex("day", "day", { unique: false });
  objectStore.createIndex("month", "month", { unique: false });
  objectStore.createIndex("year", "year", { unique: false });
});

这是同一个示例,但使用了 onupgradeneeded 事件处理程序属性。

js
// Open the database
const dBOpenRequest = window.indexedDB.open("toDoList", 4);

dBOpenRequest.onupgradeneeded = (event) => {
  const db = event.target.result;
  console.log(`Upgrading to version ${db.version}`);

  // Create an objectStore for this database
  const objectStore = db.createObjectStore("toDoList", {
    keyPath: "taskTitle",
  });

  // define what data items the objectStore will contain
  objectStore.createIndex("hours", "hours", { unique: false });
  objectStore.createIndex("minutes", "minutes", { unique: false });
  objectStore.createIndex("day", "day", { unique: false });
  objectStore.createIndex("month", "month", { unique: false });
  objectStore.createIndex("year", "year", { unique: false });
};

规范

规范
Indexed Database API 3.0
# eventdef-idbopendbrequest-upgradeneeded

浏览器兼容性

另见