Spec-Zone.ru › Web APIs

IDBCursor: свойство key

Базовая Широко доступная

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

  • Подробнее
  • Показать полную совместимость
  • Отправить отзыв

Примечание: Эта функция доступна в Потоках Web Workers.

Только для чтения key свойство интерфейса IDBCursor возвращает ключ записи по позиции курсора. Если курсор находится за пределами своего диапазона, значение устанавливается в undefined. Ключ курсора может быть любого типа данных.

Значение

Значение любого типа.

Исключения

InvalidStateError DOMException

Выбрасывается, если курсор перемещается или завершён.

Примеры

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

Курсору не требуется выбирать данные по ключу; мы можем просто получить все данные. Обратите также внимание, что в каждой итерации цикла можно получить данные из текущей записи под объектом курсора, используя cursor.value.foo. Для получения полного работающего примера см. наш пример IDBCursor (посмотреть пример в работе).

function displayData() {
  const transaction = db.transaction(["rushAlbumList"], "readonly");
  const objectStore = transaction.objectStore("rushAlbumList");

  objectStore.openCursor().onsuccess = (event) => {
    const cursor = event.target.result;
    if (cursor) {
      const listItem = document.createElement("li");
      listItem.textContent = `${cursor.value.albumTitle}, ${cursor.value.year}`;
      list.appendChild(listItem);

      console.log(cursor.key);
      cursor.continue();
    } else {
      console.log("Entries all displayed.");
    }
  };
}

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

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

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

Рабочие столы Мобильные устройства
Chrome Edge Firefox Opera Safari Chrome Android Firefox для Android Opera Android Safari на iOS Samsung Internet WebView Android
key 23 12 10 15 8 25 22 14 8 1.5 4.4
binary_keys 58 ≤79 51 45 10.1 58 51 43 10.3 7.0 58

См. также

  • Использование 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/IDBCursor/key

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API