IDBИндекс

IDBIndex интерфейс API IndexedDB API обеспечивает асинхронный доступ к индексу в базе данных. Индекс — это своего рода хранилище для поиска записей в другом хранилище объектов, которое называется хранилищем-ссылкой. Вы используете этот интерфейс для извлечения данных.

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

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

Вы можете получить набор ключей в определенном диапазоне. Дополнительную информацию см. в IDBKeyRange.

IDBIndex.isAutoLocale Только для чтения Нестандартный Устаревший

Возвращает логическое значение, указывающее, имел ли индекс locale значение auto при его создании (см. параметр options для IDBObjectStore.createIndex().)

IDBIndex.locale Только для чтения Нестандартный Устаревший

Возвращает локаль индекса (например, en-US, или pl) если при его создании было задано значение locale (см. параметр options для IDBObjectStore.createIndex().)

IDBIndex.name

Имя этого индекса.

IDBIndex.objectStore Только для чтения

Имя хранилища объектов, на которое ссылается этот индекс.

IDBIndex.keyPath Только для чтения

Путь к ключу этого индекса. Если null, этот индекс не заполняется автоматически.

IDBIndex.multiEntry Только для чтения

Влияет на поведение индекса, когда результат вычисления пути ключа индекса — массив. Если true, в индексе имеется по одной записи для каждого элемента массива ключей. Если false, тогда имеется по одной записи для каждого ключа, который является массивом.

IDBIndex.unique Только для чтения

Если true, этот индекс не допускает дубликатов значений для ключа.

Наследуется от: EventTarget

IDBIndex.count()

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

IDBIndex.get()

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

IDBIndex.getKey()

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

IDBIndex.getAll()

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

IDBIndex.getAllKeys()

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

IDBIndex.openCursor()

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

IDBIndex.openKeyCursor()

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

В следующем примере мы открываем транзакцию и хранилище объектов, а затем получаем индекс lName из простой базы данных контактов. Затем мы открываем базовый курсор на индексе с помощью IDBIndex.openCursor — это работает так же, как открытие курсора непосредственно на ObjectStore с помощью IDBObjectStore.openCursor, за исключением того, что возвращаемые записи сортируются по индексу, а не по первичному ключу.

Наконец, мы итерируем по каждой записи и вставляем данные в таблицу HTML. Для получения полного рабочего примера см. наш примеры IndexedDB (Просмотреть пример.)

function displayDataByIndex() {
  tableEntry.textContent = "";
  const transaction = db.transaction(["contactsList"], "readonly");
  const objectStore = transaction.objectStore("contactsList");

  const myIndex = objectStore.index("lName");
  myIndex.openCursor().onsuccess = (event) => {
    const cursor = event.target.result;
    if (cursor) {
      const tableRow = document.createElement("tr");
      for (const cell of [
        cursor.value.id,
        cursor.value.lName,
        cursor.value.fName,
        cursor.value.jTitle,
        cursor.value.company,
        cursor.value.eMail,
        cursor.value.phone,
        cursor.value.age,
      ]) {
        const tableCell = document.createElement("td");
        tableCell.textContent = cell;
        tableRow.appendChild(tableCell);
      }
      tableEntry.appendChild(tableRow);

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

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