CKTIS / JavaScript
IndexedDB: създаване на индекс, добавяне на запис и търсене по индекс
Създайте вторичен индекс при промяна на версията на базата, добавете запис без презаписване и го намерете по индексен, а не по първичен ключ.
Версия: Current web platform; runtime support varies
Синтаксис
store.createIndex(name, keyPath)
store.createIndex(name, keyPath, { unique, multiEntry })
store.add(value)
store.add(value, key)
store.index(name)createIndex(), add() и index() са методи на екземпляр на IDBObjectStore в уеб API-то IndexedDB, а не част от ECMAScript. IndexedDB спазва политиката за еднакъв произход; достъпността зависи от средата за изпълнение и настройките за съхранение на браузъра.
store.createIndex(name, keyPath, options) връща IDBIndex веднага, но промяната на схемата става трайна само ако транзакцията бъде потвърдена. Извикайте метода в активна транзакция versionchange, обикновено при обработка на upgradeneeded при създаване на базата или повишаване на версията ѝ. Името обозначава индекса, а пътят до ключа определя откъде в записа да се извлече индексният ключ, без да се добавя поле. IndexedDB индексира съществуващите записи и автоматично обновява индекса.
Стойността по подразбиране на unique и multiEntry е false. unique: true забранява еднакви индексни ключове в различни записи; съществуващи дубликати могат да прекратят обновяването. multiEntry: true индексира поотделно валидните елементи на масив, вместо целия масив като един ключ. Опцията не може да се комбинира с масив от пътища за съставен ключ (InvalidAccessError). Повторно използвано име на индекс предизвиква незабавно ConstraintError.
store.add(value[, key]) добавя структурирано копие без презаписване. Нужна е активна транзакция readwrite или versionchange. Пропуснете key, ако първичният ключ е в стойността; подайте го, ако е извън нея и няма генератор. При успех IDBRequest.result съдържа първичния ключ, но едва събитието complete потвърждава успешното приключване на транзакцията. Дублиран първичен ключ или ключ в уникален индекс води до неуспешна заявка с ConstraintError. put() може да замени запис, но също трябва да спазва уникалността на индекса.
store.index(name) връща съществуващия IDBIndex, обвързан със същата транзакция. Не създава индекс и не чете запис. Несъществуващо име предизвиква NotFoundError; главните и малките букви се различават. В активна транзакция index.get(key) заявява първия съвпадащ запис по индексен, а не по първичен ключ. Не използвайте обекта за четене след края на транзакцията.
Примери
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>IndexedDB: insert and look up a contact</title>
</head>
<body>
<script>
(async () => {
const { indexedDB, crypto } = window;
const name = `cktis-index-${crypto.randomUUID()}`;
const resultOf = (request) => new Promise((resolve, reject) => {
request.onsuccess = () => resolve(request.result);
request.onerror = () => reject(request.error);
});
const committed = (tx) => new Promise((resolve, reject) => {
tx.oncomplete = () => resolve();
tx.onabort = () => reject(tx.error ?? new Error('Transaction aborted'));
});
const open = indexedDB.open(name, 1);
open.onupgradeneeded = () => {
const store = open.result.createObjectStore('contacts', { keyPath: 'id' });
store.createIndex('byEmail', 'email', { unique: true });
};
const db = await resultOf(open);
let contact;
try {
const write = db.transaction('contacts', 'readwrite');
write.objectStore('contacts').add({ id: 7, email: 'ada@example.test' });
await committed(write);
const read = db.transaction('contacts', 'readonly');
const lookup = read.objectStore('contacts').index('byEmail').get('ada@example.test');
await committed(read);
contact = lookup.result;
} finally {
db.close();
await resultOf(indexedDB.deleteDatabase(name));
}
console.log(JSON.stringify(contact));
})().catch((error) => console.error(error));
</script>
</body>
</html>Резултат
{"id":7,"email":"ada@example.test"}Предоставете HTML файла на доверен HTTPS адрес и го отворете в браузър с достъп до IndexedDB и `crypto.randomUUID()`. Примерът създава отделна база, търси по `email` след потвърждаване на записа, а после затваря и изтрива базата, преди да изведе резултата в конзолата на браузъра.
Свързани уроци
- JavaScript · Урок 31 · Напреднало · Версия: 4