IDBFactory: Methode deleteDatabase()

Syntax

deleteDatabase(name)
// Non-standard
deleteDatabase(name, options)

Parameter

name

Der Name der Datenbank, die Sie löschen möchten. Beachten Sie, dass der Versuch, eine nicht vorhandene Datenbank zu löschen, keine Ausnahme auslöst. Im Gegensatz dazu löst IDBDatabase.deleteObjectStore() eine Ausnahme aus, wenn der angegebene Object Store nicht vorhanden ist.

options Optional

In Gecko können Sie seit Version 26 einen optionalen, nicht standardisierten Speicherparameter angeben. Damit legen Sie fest, ob Sie eine IndexedDB im Speicherbereich permanent (dem Standardwert) oder im Speicherbereich temporary (auch „shared pool“ genannt) löschen möchten.

Rückgabewert

Ein IDBOpenDBRequest, auf dem nachfolgende Ereignisse im Zusammenhang mit dieser Anfrage ausgelöst werden.

Wenn der Vorgang erfolgreich ist, hat die Eigenschaft result der Anfrage den Wert undefined.

Beschreibung

Wenn die Datenbank erfolgreich gelöscht wurde, wird auf dem von deleteDatabase() zurückgegebenen Anfrageobjekt ein success-Ereignis ausgelöst. Dessen result ist auf undefined gesetzt. Tritt bei der Löschung ein Fehler auf, wird auf dem von dieser Methode zurückgegebenen Anfrageobjekt ein error-Ereignis ausgelöst.

Wenn deleteDatabase() aufgerufen wird, erhalten alle anderen offenen Verbindungen zu dieser Datenbank ein versionchange-Ereignis. Dadurch können sie geschlossen werden, damit die Löschung fortgesetzt werden kann.

Wird eine Verbindung als Reaktion auf das versionchange-Ereignis nicht geschlossen, wird die Löschung blockiert: Das success-Ereignis der Anfrage wird nicht ausgelöst. Stattdessen wird auf der Anfrage ein blocked-Ereignis ausgelöst. Die Löschung bleibt ausstehend, bis alle Verbindungen zur Datenbank geschlossen sind. In der Zwischenzeit funktionieren noch offene Verbindungen wie gewohnt: Sie können weiterhin Transaktionen ausführen, bis sie geschlossen werden. Jede spätere open()- oder deleteDatabase()-Anfrage für dieselbe Datenbank wird hinter der ausstehenden Löschung eingereiht und erst fortgesetzt, wenn die Löschung abgeschlossen ist.

Beispiele

Grundlegende Verwendung

const dbDeleteRequest = indexedDB.deleteDatabase("toDoList");

dbDeleteRequest.onerror = (event) => {
  console.error("Error deleting database.");
};

dbDeleteRequest.onsuccess = (event) => {
  console.log("Database deleted successfully");

  console.log(dbDeleteRequest.result); // undefined
};

Umgang mit einer blockierten Löschung

Stellen Sie sich zwei Browser-Tabs vor, die auf dieselbe Datenbank zugreifen. Der erste Tab fordert die Löschung an, aber der zweite schließt die Datenbank nicht. Auf der Anfrage im ersten Tab wird ein blocked-Ereignis ausgelöst. In diesem Fall können Sie den Benutzern eine Warnung anzeigen und sie bitten, die anderen Tabs zu schließen.

const dbDeleteRequest = indexedDB.deleteDatabase("toDoList");

dbDeleteRequest.onblocked = (event) => {
  console.warn(
    "Deletion is blocked: close other tabs that have this app open to continue.",
  );
};

dbDeleteRequest.onsuccess = (event) => {
  console.log("Database deleted successfully");
};

Normalerweise sollten Sie dies automatisch handhaben, indem Sie IDBDatabase.close() im versionchange-Ereignishandler des zweiten Tabs aufrufen:

// db is an open connection (e.g. from a previous indexedDB.open() success)
db.addEventListener("versionchange", () => {
  db.close();
});

Spezifikationen

Browser-Kompatibilität

Siehe auch

• IndexedDB verwenden
• Transaktionen starten: IDBDatabase
• Transaktionen verwenden: IDBTransaction
• Einen Schlüsselbereich festlegen: IDBKeyRange
• Daten abrufen und ändern: IDBObjectStore
• Cursor verwenden: IDBCursor
• Referenzbeispiel: To-do-Benachrichtigungen (Beispiel live ansehen).