IDBDatabase.onversionchange

Baseline Widely available

This feature is well established and works across many devices and browser versions. It’s been available across browsers since September 2021.

IDBDatabase 中的 onversionchange 事件处理器能处理版本更新事件,此事件能在任意地方 (很可能在同一台计算机上的另一个窗口/选项卡中) 导致数据库结构更改(IDBOpenDBRequest.onupgradeneeded 事件 或 IDBFactory.deleteDatabase 事件)的时候被触发。

onversionchangeversionchange 是不相同的事件(但两者是有关联的)。

备注: 此特性在 Web Worker 中可用。

语法

在类似 addEventListener() 这样的方法中使用事件名称,或设置事件处理器属性。

js
addEventListener("versionchange", (event) => {});
onversionchange = (event) => {};

举例

本例展示了一个创建新对象仓库的 IDBOpenDBRequest.onupgradeneeded 代码块;代码中包含用于处理失败操作的 onerroronabort 函数,以及一个 onversionchange 函数用以在数据库结构被改变时通知用户。

js
request.onupgradeneeded = function(event) {
  var db = event.target.result;

  db.onerror = function(event) {
    note.innerHTML += '<li>Error opening database.</li>';
  };

  db.onabort = function(event) {
    note.innerHTML += '<li>Database opening aborted!</li>';
  };

  // 给这个数据库创建对象仓库

  var objectStore = db.createObjectStore("toDoList", { keyPath: "taskTitle" });

  // 定义对象仓库中包含的数据项

  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 });

  objectStore.createIndex("notified", "notified", { unique: false });

  note.innerHTML += '<li>Object store created.</li>';

  db.onversionchange = function(event) {
    note.innerHTML += '<li>a database change has occurred; you should refresh this
                       browser window, or close it down and use the other open version of
                       this application, wherever it exists.</li>';
  };
};

浏览器兼容性

BCD tables only load in the browser

更多参考