IDBIndex: метод getAllKeys()

Базовая поддержка Широко поддерживается

Эта функция хорошо зарекомендовала себя и работает на многих устройствах и версиях браузеров. Она доступна в браузерах с сентября 2021 года.

Метод getAllKeys() интерфейса IDBIndex асинхронно получает первичные ключи всех объектов внутри индекса, устанавливая их в качестве result объекта запроса.

Синтаксис

getAllKeys()
getAllKeys(query)
getAllKeys(query, count)

Параметры

query Необязательно: Ключ или IDBKeyRange, определяющий ключи для извлечения. Если это значение равно null или отсутствует, браузер будет использовать неограниченный диапазон ключей.
count Необязательно: Количество записей для возврата. Если это значение превышает количество записей в запросе, браузер извлечёт только первые записи. Если оно меньше 0 или больше 2^32 - 1, будет выброшено исключение TypeError.

Возвращаемое значение

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

Если операция выполнена успешно, значение свойства result объекта запроса — это Array ключей для всех записей, соответствующих заданному запросу, до значения count, если count было предоставлено.

Исключения

Этот метод может вызвать исключение DOMException следующих типов:

TransactionInactiveError DOMException: Вызывается, если транзакция данного IDBIndex неактивна.
InvalidStateError DOMException: Вызывается, если IDBIndex был удалён или удалён.

Исключение TypeError вызывается, если параметр count не находится между значениями 0 и 2^32 - 1 включительно.

Примеры

const myIndex = objectStore.index("index");
const getAllKeysRequest = myIndex.getAllKeys();
getAllKeysRequest.onsuccess = () => {
  console.log(getAllKeysRequest.result);
};

Спецификации

Спецификация
Indexed Database API 3.0 # ref-for-dom-idbindex-getallkeys①

Совместимость с браузерами

	Рабочие столы					Мобильные устройства
	Chrome	Edge	Firefox	Opera	Safari	Chrome Android	Firefox для Android	Opera Android	Safari на iOS	Samsung Internet	WebView Android
`getAllKeys`	48	79	44	35	10.1	48	44	35	10.3	5.0	48

См. также

Использование IndexedDB
Запуск транзакций: IDBDatabase
Использование транзакций: IDBTransaction
Установление диапазона ключей: IDBKeyRange
Извлечение и изменение данных: IDBObjectStore
Использование курсоров: IDBCursor
Пример ссылки: Уведомления о задачах (Просмотреть пример онлайн).

© 2005–2024 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/IDBIndex/getAllKeys