IDBObjectStore: openCursor() Methode - Web-APIs | MDN

Seitenleiste umschalten

Farbschema

Systemeinstellung
Hell
Dunkel

Deutsch

Sprache merken Mehr erfahren

IDBObjectStore: openCursor() Methode

Baseline Weitgehend verfügbar

Diese Funktion ist gut etabliert und funktioniert auf vielen Geräten und in vielen Browserversionen. Sie ist seit Juli 2015 browserübergreifend verfügbar.

Hinweis: Diese Funktion ist in Web Workers verfügbar.

Die openCursor() Methode des IDBObjectStore-Interfaces gibt ein IDBRequest-Objekt zurück und in einem separaten Thread ein neues IDBCursorWithValue-Objekt. Sie wird verwendet, um mit einem Cursor durch einen Object Store zu iterieren.

In diesem Artikel

Syntax

js
openCursor()
openCursor(query)
openCursor(query, direction)

Parameter

query Optional

Ein Schlüssel oder IDBKeyRange, der abgefragt werden soll. Wenn ein einzelner gültiger Schlüssel übergeben wird, entspricht dies standardmäßig einem Bereich, der nur diesen Schlüssel enthält. Wird nichts übergeben, entspricht dies standardmäßig einem Schlüsselbereich, der alle Datensätze in diesem Object Store auswählt.

direction Optional

Ein String, der dem Cursor mitteilt, in welche Richtung er sich bewegen soll. Der Standardwert ist next. Gültige Werte sind:

Der Cursor wird am Anfang des Stores geöffnet; dann gibt der Cursor alle Datensätze, auch Duplikate, in aufsteigender Reihenfolge der Schlüssel zurück.

nextunique

Der Cursor wird am Anfang des Stores geöffnet; dann gibt der Cursor alle Datensätze, die keine Duplikate sind, in aufsteigender Reihenfolge der Schlüssel zurück.

Der Cursor wird am Ende des Stores geöffnet; dann gibt der Cursor alle Datensätze, auch Duplikate, in absteigender Reihenfolge der Schlüssel zurück.

prevunique

Der Cursor wird am Ende des Stores geöffnet; dann gibt der Cursor alle Datensätze, die keine Duplikate sind, in absteigender Reihenfolge der Schlüssel zurück.

Rückgabewert

Ein IDBRequest-Objekt, auf dem nachfolgende Ereignisse in Bezug auf diese Operation ausgelöst werden.

Wenn die Operation erfolgreich ist, ist der Wert der result-Eigenschaft der Anfrage:

ein IDBCursorWithValue-Objekt, das auf den ersten Datensatz zeigt, der der angegebenen Abfrage entspricht
null, wenn keine passenden Datensätze gefunden wurden.

Ausnahmen

Diese Methode kann ein DOMException der folgenden Typen auslösen:

InvalidStateError DOMException

Wird ausgelöst, wenn dieses IDBObjectStore oder IDBIndex gelöscht wurde.

TransactionInactiveError DOMException

Wird ausgelöst, wenn die Transaktion dieses IDBObjectStore inaktiv ist.

DataError DOMException

Wird ausgelöst, wenn der angegebene Schlüssel oder Schlüsselbereich ungültig ist.

Beispiele

In diesem einfachen Fragment erstellen wir eine Transaktion, rufen einen Object Store ab und verwenden dann einen Cursor, um alle Datensätze im Object Store zu durchlaufen:

js
const transaction = db.transaction("name", "readonly");
const objectStore = transaction.objectStore("name");
const request = objectStore.openCursor();
request.onsuccess = (event) => {
  const cursor = event.target.result;
  if (cursor) {
    // cursor.value contains the current record being iterated through
    // this is where you'd do something with the result
    cursor.continue();
  } else {
    // no more results
  }
};

Verwendung von IndexedDB
Starten von Transaktionen: IDBDatabase
Verwendung von Transaktionen: IDBTransaction
Festlegen eines Schlüsselbereichs: IDBKeyRange
Abrufen und Ändern Ihrer Daten: IDBObjectStore
Verwendung von Cursoren: IDBCursor
Referenzbeispiel: To-do Notifications (Beispiel live ansehen).

Help improve MDN

War diese Übersetzung hilfreich?

Ja Nein

Erfahren Sie, wie Sie beitragen können Diese Seite wurde automatisch aus dem Englischen übersetzt.

Übersetzung auf GitHub anzeigen • Fehler mit dieser Übersetzung melden

IndexedDB API
IDBObjectStore
Instanzeigenschaften
Instanzmethoden
Verwandte Seiten für IndexedDB
Anleitungen
1. Verwenden von IndexedDB
2. IndexedDB Schlüsselmerkmale und grundlegende Terminologie
3. Speicherquoten und Löschkriterien
4. Überprüfung, wann eine Frist fällig ist