CKTIS / JavaScript
IndexedDB: създаване на индекс, добавяне, броене и четене на записи
Създайте вторичен индекс, добавяйте записи без презаписване и търсете по първичен ключ или по ключ на индекса.
Версия: ECMAScript 2024 and the current web platform; runtime support varies
Синтаксис
store.createIndex(name, keyPath)
store.createIndex(name, keyPath, options)
store.count()
store.count(query)
store.add(value)
store.add(value, key)
store.getAll()
store.getAll(query)
store.getAll(query, count)
store.getAll(options)
store.index(name)IDBObjectStore представлява хранилище за обекти, свързано с транзакция. Всеки запис има първичен ключ и стойност. IndexedDB е уеб API, а не част от ECMAScript; достъпът следва политиката за един и същ произход.
createIndex(name, keyPath, options) веднага връща IDBIndex, но може да се извика само в активна транзакция versionchange, обикновено при upgradeneeded. Пътят до ключа определя откъде се извлича ключът на индекса, без да добавя поле към записа. unique: true забранява повтарящи се ключове в индекса, а multiEntry: true индексира валидните елементи на масив поотделно. И двете настройки са false по подразбиране. multiEntry: true не може да се комбинира със съставен път до ключ, зададен като масив от пътища.
add(value, key) записва структурирано копие и предоставя новия ключ в request.result. Пропуснете втория аргумент, ако ключът е в стойността; подайте го, ако ключът е отделен и няма генератор. Дублиран първичен ключ или нарушена уникалност на индекс води до грешка ConstraintError в заявката. За вмъкване или замяна по първичен ключ използвайте put().
count(query) дава брой, а getAll(query, count) — масив с копия на стойностите, празен при липса на съвпадения. И двата метода приемат първичен ключ или IDBKeyRange и без филтър обхващат цялото хранилище. Положителен count ограничава броя на стойностите от getAll(). По подразбиране редът е възходящ по първичен ключ. По-новият вариант getAll({ query, count, direction }) позволява например "prev"; проверете поддръжката в целевия браузър.
index(name) веднага връща съществуващ IDBIndex от същата транзакция. Непознато име предизвиква NotFoundError; главните и малките букви се различават. store.getAll("sci-fi") търси по първичен ключ, а store.index("byGenre").getAll("sci-fi") връща стойностите на записите, съвпадащи по ключ на индекса.
add(), count() и getAll() връщат IDBRequest, а не Promise. Четете result след success и обработвайте error. В обикновена транзакция записът изисква режим readwrite. Подайте заявките, докато транзакцията е активна: чакането на друга асинхронна операция може да ѝ позволи да приключи. Успешната заявка още не потвърждава транзакцията; изчакайте нейното събитие complete.
Примери
<!doctype html>
<meta charset="utf-8">
<title>IndexedDB object store methods</title>
<script>
(() => {
const dbName = `cktis-books-${crypto.randomUUID()}`;
const open = indexedDB.open(dbName, 1);
open.onupgradeneeded = () => {
const store = open.result.createObjectStore('books', { keyPath: 'id' });
store.createIndex('byGenre', 'genre');
};
open.onerror = () => console.error(open.error);
open.onsuccess = () => {
const db = open.result;
const tx = db.transaction('books', 'readwrite');
const store = tx.objectStore('books');
const cleanup = () => {
db.close();
const deletion = indexedDB.deleteDatabase(dbName);
deletion.onerror = () => console.error(deletion.error);
};
tx.onabort = () => {
console.error(tx.error);
cleanup();
};
const added = store.add({ id: 3, title: 'Orbit', genre: 'sci-fi' });
store.add({ id: 1, title: 'Dunes', genre: 'sci-fi' });
store.add({ id: 2, title: 'Herbs', genre: 'guide' });
const total = store.count();
const all = store.getAll();
const matches = store.index('byGenre').getAll('sci-fi');
tx.oncomplete = () => {
const titles = (request) => request.result.map((book) => book.title).join(', ');
console.log(`Added key: ${added.result}`);
console.log(`Total: ${total.result}`);
console.log(`All: ${titles(all)}`);
console.log(`Sci-fi: ${titles(matches)}`);
cleanup();
};
};
})();
</script>Резултат
Added key: 3 Total: 3 All: Dunes, Herbs, Orbit Sci-fi: Dunes, Orbit
Публикувайте този HTML документ през HTTPS, отворете го в браузър и проверете конзолата за разработчици. Примерът създава отделна временна база и после я изтрива. Добавя три книги в ред, различен от реда на първичните ключове. След потвърждаване на транзакцията извежда всички заглавия по `id` и заглавията, избрани чрез индекса по жанр.
Свързани уроци
- JavaScript · Урок 21 · Средно · Версия: 3
Източници
- IDBObjectStore: createIndex() method
- IDBObjectStore: count() method
- IDBObjectStore: add() method
- IDBObjectStore: getAll() method
- IDBObjectStore: index() method
- IDBIndex: getAll() method
- IDBTransaction
- IDBTransaction: complete event
- IndexedDB key characteristics and basic terminology
- Using IndexedDB
- Crypto: randomUUID() method