CKTIS / JavaScript
IndexedDB: добавяне, четене, изтриване и замяна на записи
Използвай `add()`, `getAll()`, `delete()` и `put()`, за да работиш със записи по първичен ключ. Разграничавай успешната заявка от потвърдената транзакция.
Версия: ECMAScript 2024 and the current web platform; runtime support varies
Синтаксис
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)Методите add(), getAll(), delete() и put() са част от интерфейса IDBObjectStore на IndexedDB, а не от ECMAScript. Хранилището за обекти се получава от транзакция. Достъпът до данните следва правилото за един и същ произход (схема, хост и порт); поддръжката зависи от средата за изпълнение.
add(value) само вмъква: ако първичният ключ вече съществува, заявката завършва с грешка ConstraintError. put(value) вмъква или заменя цялата стойност за този ключ; не обединява полета. Ако ключът е в самата стойност, не подавай втори аргумент: keyPath посочва къде е ключът. При външен ключ подай key като втори аргумент, освен ако включен генератор на ключове трябва да го зададе. И двата метода съхраняват структурирано копие на стойността и при успех записват ключа в request.result. Стойност, която не може да се клонира, например функция, предизвиква синхронна грешка DataCloneError.
getAll() записва в request.result масив от клонирани стойности без отделно приложени ключове; ако няма съвпадения, резултатът е []. Подредбата по подразбиране е възходяща по първичен ключ, а не по реда на вмъкване. С getAll(query, count) можеш да избереш ключ или IDBKeyRange и да ограничиш броя на резултатите с положително count. Формата getAll({ query, count, direction }) позволява да зададеш и посоката, например "prev" за низходящ ред; провери дали целевите браузъри я поддържат.
delete(keyOrRange) изтрива запис по първичен ключ или всички записи в диапазон IDBKeyRange. Резултатът от успешна заявка е undefined, дори да няма съвпадения. Методът не е операторът delete на JavaScript; използвай clear(), за да изпразниш хранилището.
И четирите метода връщат веднага IDBRequest, а не Promise. За четене е достатъчен режим readonly; обичайните операции за запис изискват readwrite. Добавяй заявки, докато транзакцията е активна, например при създаването ѝ или в обработчик на събитие на заявка, а не след изчакване на отговор от мрежата. По подразбиране грешка в заявка прекратява транзакцията и отменя промените ѝ. success се отнася за една заявка; complete означава, че транзакцията е потвърдена.
Примери
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));Резултат
[{"id":1,"title":"Remove me"},{"id":2,"title":"Draft","tag":"temporary"}]
[{"id":2,"title":"Published"}]Изпълни кода в конзолата за разработчици на HTTPS страница, където IndexedDB и `crypto.randomUUID()` са достъпни и съхранението е разрешено. След потвърждаването на транзакцията първият ред показва двата записа в реда на ключовете им. Вторият показва, че `put()` не е запазил полето `tag`, а `delete()` е изтрил записа с ключ `1`. Кодът затваря връзката и заявява изтриване на временната база данни.
Свързани уроци
- JavaScript · Урок 20 · Средно · Версия: 3
Източници
- IDBObjectStore: add() method
- IDBObjectStore: getAll() method
- IDBObjectStore: delete() method
- IDBObjectStore: put() method
- IDBTransaction
- IDBTransaction: complete event
- IndexedDB key characteristics and basic terminology
- IDBDatabase: createObjectStore() method
- HTML Standard — Safe passing of structured data
- IDBFactory: open() method
- IDBFactory: deleteDatabase() method
- Crypto: randomUUID() method