CKTIS / JavaScript
IndexedDB: създаване на хранилища за обекти и отваряне на транзакции
Използвай `createObjectStore()` за промени по схемата при повишаване на версията, а `transaction()` — за четене и запис в съществуващи хранилища.
Версия: ECMAScript 2024 and the current web platform; runtime support varies
Синтаксис
db.createObjectStore(name) → IDBObjectStore
db.createObjectStore(name, options) → IDBObjectStore
db.transaction(storeNames) → IDBTransaction
db.transaction(storeNames, mode) → IDBTransaction
db.transaction(storeNames, mode, options) → IDBTransactionIDBDatabase представлява отворена връзка към база данни в IndexedDB. db.createObjectStore(name, options) веднага връща нов IDBObjectStore, но работи само в активна транзакция versionchange. IndexedDB започва тази транзакция, когато indexedDB.open() създава базата или я отваря с по-висока версия. Променяй схемата в обработчика на upgradeneeded. Отворена връзка в друг раздел може да блокира обновяването: заявката за отваряне задейства blocked, а старата връзка може да извика close() в отговор на versionchange.
Незадължителният keyPath указва откъде в стойността да се извлече ключът, например от id. Масив от пътища определя съставен ключ; ако няма път, ключът се съхранява отделно. Стойността по подразбиране на autoIncrement е false; true включва генератор на ключове, но не може да се комбинира с празен низ или масив като keyPath (InvalidAccessError). Повторено име на хранилище води до ConstraintError, невалиден път — до SyntaxError, а извикване без транзакция за обновяване — до InvalidStateError.
db.transaction(storeNames, mode, options) веднага връща IDBTransaction, чийто обхват се определя от едно име на хранилище, подадено като низ, или от непразен итерируем обект с имена на съществуващи хранилища, например масив или Set. Достъпът до хранилище в този обхват става чрез tx.objectStore(name). Режимът по подразбиране "readonly" позволява само четене, а "readwrite" — и запис. Тук не можеш да избереш "versionchange" (TypeError). Неизвестно хранилище води до NotFoundError, празен списък — до InvalidAccessError, а затваряща се или затворена връзка — до InvalidStateError. Незадължителната настройка options.durability ("default", "strict", "relaxed") задава предпочитание за трайността на записа при потвърждаване; провери поддръжката в целевите браузъри.
Добавяй заявки само докато транзакцията е активна: в задачата, която я е създала, или в обработчик на success или error за някоя от нейните заявки. След await fetch(...) транзакцията може вече да е потвърдена автоматично и по-късна заявка може да предизвика TransactionInactiveError. Успешната заявка не означава успешна транзакция. complete потвърждава успешното приключване, а abort означава, че промените са отменени.
IndexedDB е уеб API, а не част от ECMAScript 2024. Достъпът е ограничен до същия произход (origin); настройките на браузъра могат да ограничат достъпа до хранилището или срока на съхранение на данните.
Примери
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>IndexedDB example</title>
</head>
<body>
<script>
(async () => {
const idb = window.indexedDB;
const name = `cktis-notes-${crypto.randomUUID()}`;
const requestResult = (request) => new Promise((resolve, reject) => {
request.onsuccess = () => resolve(request.result);
request.onerror = () => reject(request.error);
});
const finished = (tx) => new Promise((resolve, reject) => {
tx.oncomplete = () => resolve();
tx.onabort = () => reject(tx.error ?? new Error("Transaction aborted"));
});
const open = idb.open(name, 1);
open.onupgradeneeded = () => {
open.result.createObjectStore("notes", { keyPath: "id" });
};
const db = await requestResult(open);
db.onversionchange = () => db.close();
let title;
try {
const write = db.transaction("notes", "readwrite");
write.objectStore("notes").put({ id: 1, title: "IndexedDB" });
await finished(write);
const read = db.transaction("notes");
const get = read.objectStore("notes").get(1);
await finished(read);
title = get.result.title;
} finally {
db.close();
await requestResult(idb.deleteDatabase(name));
}
console.log(title);
})().catch((error) => console.error(error));
</script>
</body>
</html>Резултат
IndexedDB
Предостави HTML файла през HTTPS и го отвори в браузър, в който съхранението е разрешено. Примерът създава база със случайно име, прочита записа след потвърждаване на записа в базата, затваря и изтрива базата и накрая извежда `IndexedDB` в конзолата на браузъра.
Свързани уроци
- JavaScript · Урок 31 · Напреднало · Версия: 4
Източници
- IDBDatabase: createObjectStore() method
- IDBDatabase: transaction() method
- IDBFactory: open() method
- Using IndexedDB
- IDBTransaction
- IDBTransaction: durability property
- IndexedDB key characteristics and basic terminology
- IDBObjectStore: put() method
- IDBObjectStore: get() method
- IDBFactory: deleteDatabase() method
- Crypto: randomUUID() method
- ECMAScript® 2024 Language Specification — Overview