Baza wiedzyCentrum egzaminacyjne
PLPolski
Wybierz język13

CKTIS / JavaScript

IndexedDB: dodawanie, odczyt, usuwanie i zastępowanie rekordów

Używaj metod `add()`, `getAll()`, `delete()` i `put()` do pracy z rekordami według klucza głównego. Odróżniaj powodzenie żądania od zatwierdzenia transakcji.

Wersja: ECMAScript 2024 and the current web platform; runtime support varies

Składnia

store.add(value)
store.add(value, key)
store.getAll()
store.getAll(query)
store.getAll(query, count)
store.getAll(options)
store.delete(keyOrRange)
store.put(value)
store.put(value, key)

Metody add(), getAll(), delete() i put() należą do interfejsu IDBObjectStore w IndexedDB, a nie do ECMAScript. Magazyn obiektów pobierasz z transakcji. Dostęp do danych podlega zasadzie tego samego pochodzenia (protokół, host i port); obsługa zależy od środowiska.

add(value) tylko wstawia: jeśli klucz główny już istnieje, żądanie kończy się błędem ConstraintError. put(value) wstawia lub zastępuje całą wartość pod tym kluczem; nie scala pól. Przy kluczu wewnątrz wartości nie podawaj drugiego argumentu: klucz wskazuje keyPath. Przy kluczu zewnętrznym podaj key jako drugi argument, chyba że klucz ma nadać włączony generator. Obie metody zapisują klon strukturalny wartości i przy powodzeniu zwracają klucz w request.result. Wartość, której nie można sklonować, np. funkcja, powoduje synchroniczny DataCloneError.

getAll() zwraca w request.result tablicę sklonowanych wartości, bez osobno dołączonych kluczy; brak dopasowań daje []. Domyślna kolejność jest rosnąca według klucza głównego, nie według kolejności wstawiania. getAll(query, count) pozwala wybrać klucz lub IDBKeyRange i ograniczyć liczbę wyników dodatnim count. Wariant getAll({ query, count, direction }) udostępnia też kierunek, np. "prev" dla kolejności malejącej; sprawdź jego obsługę w docelowych przeglądarkach.

delete(keyOrRange) usuwa rekord według klucza głównego lub wszystkie rekordy w zadanym IDBKeyRange. Wynik udanego żądania to undefined, także gdy nic nie pasowało. To nie operator JavaScript delete; do opróżnienia magazynu służy clear().

Wszystkie cztery metody zwracają od razu IDBRequest, nie Promise. Do odczytu wystarczy readonly; zwykłe zapisy wymagają readwrite. Zlecaj operacje, gdy transakcja jest aktywna, np. zaraz po jej utworzeniu lub w obsłudze zdarzenia żądania, a nie po oczekiwaniu na odpowiedź sieciową. Błąd żądania domyślnie przerywa transakcję i wycofuje jej zmiany. success dotyczy jednego żądania; o zatwierdzeniu całej transakcji informuje complete.

Przykłady

void (async () => {
  const { indexedDB, crypto } = globalThis;
  if (!indexedDB || typeof crypto?.randomUUID !== 'function') {
    throw new Error('Run this example on an HTTPS page in a browser with IndexedDB and crypto.randomUUID() available.');
  }

  const name = `cktis-idb-${crypto.randomUUID()}`;
  const open = indexedDB.open(name, 1);
  open.onupgradeneeded = () => {
    open.result.createObjectStore('tasks', { keyPath: 'id' });
  };
  const db = await new Promise((resolve, reject) => {
    open.onsuccess = () => resolve(open.result);
    open.onerror = () => reject(open.error);
  });

  try {
    const tx = db.transaction('tasks', 'readwrite');
    const store = tx.objectStore('tasks');
    store.add({ id: 2, title: 'Draft', tag: 'temporary' });
    store.add({ id: 1, title: 'Remove me' });
    const before = store.getAll();
    store.put({ id: 2, title: 'Published' });
    store.delete(1);
    const after = store.getAll();

    await new Promise((resolve, reject) => {
      tx.oncomplete = () => resolve();
      tx.onabort = () => reject(tx.error ?? new Error('Transaction aborted'));
    });
    console.log(JSON.stringify(before.result));
    console.log(JSON.stringify(after.result));
  } finally {
    db.close();
    const cleanup = indexedDB.deleteDatabase(name);
    await new Promise((resolve, reject) => {
      cleanup.onsuccess = () => resolve();
      cleanup.onerror = () => reject(cleanup.error);
    });
  }
})().catch((error) => console.error(error));

Wynik

[{"id":1,"title":"Remove me"},{"id":2,"title":"Draft","tag":"temporary"}]
[{"id":2,"title":"Published"}]

Uruchom kod w konsoli deweloperskiej strony HTTPS, na której dostępne są IndexedDB i `crypto.randomUUID()` oraz dozwolony jest zapis danych. Po zatwierdzeniu transakcji pierwsza linia pokazuje oba rekordy w kolejności kluczy. Druga pokazuje, że `put()` nie zachował pola `tag`, a `delete()` usunął rekord z kluczem `1`. Kod zamyka połączenie i zleca usunięcie tymczasowej bazy.

Powiązane lekcje

  • JavaScript · Lekcja 20 · Średniozaawansowany · Wersja: 3

Źródła