IDBObjectStore

Instanz-Eigenschaften

IDBObjectStore.indexNames Schreibgeschützt

Eine Liste der Namen von Indexen auf Objekten in diesem Objektspeicher.

IDBObjectStore.keyPath Schreibgeschützt

Der Schlüsselpfad dieses Objektspeichers. Wenn dieses Attribut null ist, muss die Anwendung für jede Änderungsoperation einen Schlüssel bereitstellen.

IDBObjectStore.name

Der Name dieses Objektspeichers.

IDBObjectStore.transaction Schreibgeschützt

Das IDBTransaction-Objekt, zu dem dieser Objektspeicher gehört.

IDBObjectStore.autoIncrement Schreibgeschützt

Der Wert der Autoinkrement-Flagge für diesen Objektspeicher.

Instanz-Methoden

IDBObjectStore.add()

Gibt ein IDBRequest-Objekt zurück und erstellt in einem separaten Thread einen strukturierter Klon des value, und speichert den geklonten Wert im Objektspeicher. Dies dient dem Hinzufügen neuer Datensätze zu einem Objektspeicher.

IDBObjectStore.clear()

Erstellt und gibt sofort ein IDBRequest-Objekt zurück und leert diesen Objektspeicher in einem separaten Thread. Dies dient dem Löschen aller aktuellen Datensätze aus einem Objektspeicher.

IDBObjectStore.count()

Gibt ein IDBRequest-Objekt zurück und gibt in einem separaten Thread die Gesamtanzahl der Datensätze zurück, die mit dem bereitgestellten Schlüssel oder IDBKeyRange übereinstimmen. Wenn keine Argumente angegeben sind, wird die Gesamtanzahl der Datensätze im Speicher zurückgegeben.

IDBObjectStore.createIndex()

Erstellt einen neuen Index während eines Versions-Upgrades und gibt ein neues IDBIndex-Objekt in der verbundenen Datenbank zurück.

IDBObjectStore.delete()

Gibt ein IDBRequest-Objekt zurück und löscht in einem separaten Thread das im Speicher ausgewählte Objekt anhand des angegebenen Schlüssels. Dies dient dem Löschen einzelner Datensätze aus einem Objektspeicher.

IDBObjectStore.deleteIndex()

Zerstört den angegebenen Index in der verbundenen Datenbank, verwendet während eines Versions-Upgrades.

IDBObjectStore.get()

Gibt ein IDBRequest-Objekt zurück und gibt in einem separaten Thread das im Speicher ausgewählte Objekt anhand des angegebenen Schlüssels zurück. Dies dient dem Abrufen spezifischer Datensätze aus einem Objektspeicher.

IDBObjectStore.getKey()

Gibt ein IDBRequest-Objekt zurück und ruft in einem separaten Thread den Datensatzschlüssel für das Objekt im Objektspeicher ab, das dem angegebenen Parameter entspricht.

IDBObjectStore.getAll()

Gibt ein IDBRequest-Objekt zurück und ruft in einem separaten Thread alle Objekte im Objektspeicher ab, die dem angegebenen Parameter entsprechen, oder alle Objekte im Speicher, wenn keine Parameter gegeben sind.

IDBObjectStore.getAllKeys()

Gibt ein IDBRequest-Objekt zurück und ruft in einem separaten Thread Datensatzschlüssel für alle Objekte im Objektspeicher ab, die dem angegebenen Parameter entsprechen, oder alle Objekte im Speicher, wenn keine Parameter gegeben sind.

IDBObjectStore.getAllRecords()

Gibt ein IDBRequest-Objekt zurück und findet in einem separaten Thread alle übereinstimmenden Datensätze im Objektspeicher (einschließlich Hauptschlüsseln und Werten), die dem angegebenen Schlüssel entsprechen oder sich im Bereich befinden, wenn key eine IDBKeyRange ist.

IDBObjectStore.index()

Öffnet einen Index aus diesem Objektspeicher, nach dem dann z.B. eine Sequenz von Datensätzen sortiert nach diesem Index unter Verwendung eines Cursors zurückgegeben werden kann.

IDBObjectStore.openCursor()

Gibt ein IDBRequest-Objekt zurück und gibt in einem separaten Thread ein neues IDBCursorWithValue-Objekt zurück. Verwendet zum Durchlaufen eines Objektspeichers nach Hauptschlüssel mit einem Cursor.

IDBObjectStore.openKeyCursor()

Gibt ein IDBRequest-Objekt zurück und gibt in einem separaten Thread ein neues IDBCursor-Objekt zurück. Verwendet zum Durchlaufen eines Objektspeichers mit einem Schlüssel.

IDBObjectStore.put()

Gibt ein IDBRequest-Objekt zurück und erstellt in einem separaten Thread einen strukturierter Klon des value, und speichert den geklonten Wert im Objektspeicher. Dies dient dem Aktualisieren bestehender Datensätze in einem Objektspeicher, wenn der Modus der Transaktion readwrite ist.

Beispiel

Dieses Beispiel zeigt eine Vielzahl unterschiedlicher Verwendungen von Objektspeichern, von der Aktualisierung der Datenstruktur mit IDBObjectStore.createIndex innerhalb einer onupgradeneeded-Funktion bis zum Hinzufügen eines neuen Elements zu unserem Objektspeicher mit IDBObjectStore.add. Für ein vollständiges funktionierendes Beispiel siehe unsere To-do Notifications App (Beispiel live ansehen).

// Let us open our database
const DBOpenRequest = window.indexedDB.open("toDoList", 4);

DBOpenRequest.onsuccess = (event) => {
  note.appendChild(document.createElement("li")).textContent =
    "Database initialized.";

  // store the result of opening the database in db.
  db = DBOpenRequest.result;
};

// This event handles the event whereby a new version of
// the database needs to be created Either one has not
// been created before, or a new version number has been
// submitted via the window.indexedDB.open line above
DBOpenRequest.onupgradeneeded = (event) => {
  const db = event.target.result;

  db.onerror = (event) => {
    note.appendChild(document.createElement("li")).textContent =
      "Error loading database.";
  };

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

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

  note.appendChild(document.createElement("li")).textContent =
    "Object store created.";
};

// Create a new item to add in to the object store
const newItem = [
  {
    taskTitle: "Walk dog",
    hours: 19,
    minutes: 30,
    day: 24,
    month: "December",
    year: 2013,
    notified: "no",
  },
];

// open a read/write db transaction, ready for adding the data
const transaction = db.transaction(["toDoList"], "readwrite");

// report on the success of the transaction completing, when everything is done
transaction.oncomplete = (event) => {
  note.appendChild(document.createElement("li")).textContent =
    "Transaction completed.";
};

transaction.onerror = (event) => {
  note.appendChild(document.createElement("li")).textContent =
    "Transaction not opened due to error. Duplicate items not allowed.";
};

// create an object store on the transaction
const objectStore = transaction.objectStore("toDoList");
// make a request to add our newItem object to the object store
const objectStoreRequest = objectStore.add(newItem[0]);

objectStoreRequest.onsuccess = (event) => {
  note.appendChild(document.createElement("li")).textContent =
    "Request successful.";
};

Spezifikationen

Browser-Kompatibilität

Siehe auch

• Verwendung von IndexedDB
• Starten von Transaktionen: IDBDatabase
• Verwendung von Transaktionen: IDBTransaction
• Festlegen eines Schlüsselbereichs: IDBKeyRange
• Verwendung von Cursors: IDBCursor
• Referenzbeispiel: To-do Notifications (Beispiel live ansehen).