ObjectStore

package js.html.idb

Доступно в js

В этом примере показано множество различных способов использования хранилищ объектов, от обновления структуры данных с IDBObjectStore.createIndex внутри функции onupgradeneeded, до добавления нового элемента в наше хранилище объектов с IDBObjectStore.add. Для ознакомления с полным рабочим примером, обратитесь к нашему приложению Уведомлений о задачах (посмотреть пример онлайн).

Документация IDBObjectStore от Mozilla Contributors, лицензирована по CC-BY-SA 2.5.

См. также:

• https://developer.mozilla.org/en-US/docs/Web/API/IDBObjectStore

Переменные

read onlyautoIncrement:Bool

Значение флага автоинкремента для этого хранилища объектов.

read onlyindexNames:DOMStringList

Список имён индексов объектов в этом хранилище объектов.

read onlykeyPath:Dynamic

Путь ключа этого хранилища объектов. Если этот атрибут null, приложение должно предоставить ключ для каждой операции модификации.

name:String

Имя этого хранилища объектов.

read onlytransaction:Transaction

Объект IDBTransaction, которому принадлежит это хранилище объектов.

Методы

add(value:Dynamic, ?key:Dynamic):Request

Возвращает объект IDBRequest, и в отдельном потоке создаёт структурированную копию value, сохраняя скопированное значение в хранилище объектов. Это для добавления новых записей в хранилище объектов.

Выбрасывает:

clear():Request

Создаёт и немедленно возвращает объект IDBRequest, и очищает это хранилище объектов в отдельном потоке. Это для удаления всех текущих записей из хранилища объектов.

Выбрасывает:

count(?key:Dynamic):Request

Возвращает объект IDBRequest, и в отдельном потоке возвращает общее количество записей, соответствующих предоставленному ключу или IDBKeyRange. Если аргументы не указаны, возвращается общее количество записей в хранилище.

Выбрасывает:

createIndex(name:String, keyPath:String, ?optionalParameters:Null<IndexParameters>):Index

createIndex(name:String, keyPath:Array<String>, ?optionalParameters:Null<IndexParameters>):Index

Создаёт новый индекс во время обновления версии, возвращая новый объект IDBIndex в подключенной базе данных.

Выбрасывает:

delete(key:Dynamic):Request

Возвращает объект IDBRequest, и в отдельном потоке удаляет объект хранилища, выбранный указанным ключом. Это для удаления отдельных записей из хранилища объектов.

Выбрасывает:

deleteIndex(indexName:String):Void

Удаляет указанный индекс в подключенной базе данных, используется во время обновления версии.

Выбрасывает:

get(key:Dynamic):Request

Возвращает объект IDBRequest, и в отдельном потоке возвращает объект хранилища, выбранный указанным ключом. Это для извлечения конкретных записей из хранилища объектов.

Выбрасывает:

getAll(?key:Dynamic, ?limit:Int):Request

Возвращает объект IDBRequest, извлекает все объекты в хранилище объектов, соответствующие указанному параметру, или все объекты в хранилище, если параметры не заданы.

Выбрасывает:

getAllKeys(?key:Dynamic, ?limit:Int):Request

Возвращает объект IDBRequest, извлекает ключи записей для всех объектов в хранилище объектов, соответствующих указанному параметру, или все объекты в хранилище, если параметры не заданы.

Выбрасывает:

getKey(key:Dynamic):Request

Возвращает объект IDBRequest, и в отдельном потоке извлекает и возвращает ключ записи для объекта в хранилище объектов, соответствующего указанному параметру.

Выбрасывает:

index(name:String):Index

Открывает индекс из этого хранилища объектов, после чего его можно, например, использовать для возвращения последовательности записей, отсортированных по этому индексу, с помощью курсора.

Выбрасывает:

openCursor(?range:Dynamic, direction:CursorDirection = NEXT):Request

Возвращает объект IDBRequest, и в отдельном потоке возвращает новый объект IDBCursorWithValue. Используется для итерирования через хранилище объектов по первичному ключу с помощью курсора.

Выбрасывает:

openKeyCursor(?range:Dynamic, direction:CursorDirection = NEXT):Request

Возвращает объект IDBRequest, и в отдельном потоке возвращает новый IDBCursor. Используется для итерирования через хранилище объектов с ключом.

Выбрасывает:

put(value:Dynamic, ?key:Dynamic):Request

Возвращает объект IDBRequest, и в отдельном потоке создаёт структурированную копию value, и сохраняет скопированное значение в хранилище объектов. Это для обновления существующих записей в хранилище объектов, когда режим транзакции readwrite.

Выбрасывает: