IDBIndex

IDBIndex interface of the IndexedDB API provides asynchronous access to an index in a database. An index is a kind of object store for looking up records in another object store, called the referenced object store. You use this interface to retrieve data.

You can retrieve records in an object store through the primary key or by using an index. An index lets you look up records in an object store using properties of the values in the object stores records other than the primary key

The index is a persistent key-value storage where the value part of its records is the key part of a record in the referenced object store. The records in an index are automatically populated whenever records in the referenced object store are inserted, updated, or deleted. Each record in an index can point to only one record in its referenced object store, but several indexes can reference the same object store. When the object store changes, all indexes that refers to the object store are automatically updated.

You can grab a set of keys within a range. To learn more, see IDBKeyRange.

Примечание: Эта возможность доступна в Web Workers.

Properties

IDBIndex.isAutoLocale Только для чтения
Returns a Boolean indicating whether the index had a locale value of auto specified upon its creation (see createIndex()'s optionalParameters.)
IDBIndex.locale Только для чтения
Returns the locale of the index (for example en-US, or pl) if it had a locale value specified upon its creation (see createIndex()'s optionalParameters.)
IDBIndex.name
The name of this index.
IDBIndex.objectStore Только для чтения
The name of the object store referenced by this index.
IDBIndex.keyPath Только для чтения
The key path of this index. If null, this index is not auto-populated.
IDBIndex.multiEntry Только для чтения
Affects how the index behaves when the result of evaluating the index's key path yields an array. If true, there is one record in the index for each item in an array of keys. If false, then there is one record for each key that is an array.
IDBIndex.unique Только для чтения
If true, this index does not allow duplicate values for a key.

Methods

Inherits from: EventTarget

IDBIndex.count()
Returns an IDBRequest object, and in a separate thread, returns the number of records within a key range.
IDBIndex.get()
Returns an IDBRequest object, and, in a separate thread, finds either the value in the referenced object store that corresponds to the given key or the first corresponding value, if key is an IDBKeyRange.
IDBIndex.getKey()
Returns an IDBRequest object, and, in a separate thread, finds either the given key or the primary key, if key is an IDBKeyRange.
IDBIndex.getAll()
Returns an IDBRequest object, in a separate thread, finds all matching values in the referenced object store that correspond to the given key or are in range, if key is an IDBKeyRange.
IDBIndex.getAllKeys()
Returns an IDBRequest object, in a separate thread, finds all matching keys in the referenced object store that correspond to the given key or are in range, if key is an IDBKeyRange.
IDBIndex.openCursor()
Returns an IDBRequest object, and, in a separate thread, creates a cursor over the specified key range.
IDBIndex.openKeyCursor()
Returns an IDBRequest object, and, in a separate thread, creates a cursor over the specified key range, as arranged by this index.

Example

In the following example we open a transaction and an object store, then get the index lName from a simple contacts database. We then open a basic cursor on the index using IDBIndex.openCursor — this works the same as opening a cursor directly on an ObjectStore using IDBObjectStore.openCursor except that the returned records are sorted based on the index, not the primary key.

Finally, we iterate through each record, and insert the data into an HTML table. For a complete working example, see our IDBIndex-example demo repo (View the example live.)

function displayDataByIndex() {
  tableEntry.innerHTML = '';
  var transaction = db.transaction(['contactsList'], 'readonly');
  var objectStore = transaction.objectStore('contactsList');

  var myIndex = objectStore.index('lName'); 
  myIndex.openCursor().onsuccess = function(event) {
    var cursor = event.target.result;
    if(cursor) {
      var tableRow = document.createElement('tr');
      tableRow.innerHTML =   '<td>' + cursor.value.id + '</td>'
                           + '<td>' + cursor.value.lName + '</td>'
                           + '<td>' + cursor.value.fName + '</td>'
                           + '<td>' + cursor.value.jTitle + '</td>'
                           + '<td>' + cursor.value.company + '</td>'
                           + '<td>' + cursor.value.eMail + '</td>'
                           + '<td>' + cursor.value.phone + '</td>'
                           + '<td>' + cursor.value.age + '</td>';
      tableEntry.appendChild(tableRow);  

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

Specification

Specification Status Comment
Indexed Database API 2.0
Определение 'IDBIndex' в этой спецификации.
Рекомендация  
Indexed Database API Draft
Определение 'IDBIndex' в этой спецификации.
Рекомендация  

Browser compatibility

Update compatibility data on GitHub
КомпьютерыМобильные
ChromeEdgeFirefoxInternet ExplorerOperaSafariAndroid webviewChrome для AndroidFirefox для AndroidOpera для AndroidSafari on iOSSamsung Internet
IDBIndexChrome Полная поддержка 24
Полная поддержка 24
Нет поддержки 23 — 57
С префиксом
С префиксом Требует вендорный префикс: webkit
Edge Полная поддержка ДаFirefox Полная поддержка 16
Полная поддержка 16
Нет поддержки 10 — 16
С префиксом
С префиксом Требует вендорный префикс: moz
IE Полная поддержка 10
Замечания
Полная поддержка 10
Замечания
Замечания partial
Opera Полная поддержка 15Safari Полная поддержка 7WebView Android Полная поддержка Да
Полная поддержка Да
Нет поддержки ? — 57
С префиксом
С префиксом Требует вендорный префикс: webkit
Chrome Android Полная поддержка 25
Полная поддержка 25
Нет поддержки 25 — 57
С префиксом
С префиксом Требует вендорный префикс: webkit
Firefox Android Полная поддержка 22Opera Android Полная поддержка 14Safari iOS Полная поддержка 8Samsung Internet Android Полная поддержка Да
Полная поддержка Да
Нет поддержки ? — 7.0
С префиксом
С префиксом Требует вендорный префикс: webkit
countChrome Полная поддержка 24
Полная поддержка 24
Нет поддержки 23 — 24
С префиксом
С префиксом Требует вендорный префикс: webkit
Edge Полная поддержка 12Firefox Полная поддержка 16
Полная поддержка 16
Нет поддержки 10 — 16
С префиксом
С префиксом Требует вендорный префикс: moz
IE Полная поддержка 10
Замечания
Полная поддержка 10
Замечания
Замечания partial
Opera Полная поддержка 15Safari Полная поддержка 7WebView Android Полная поддержка Да
Полная поддержка Да
Нет поддержки ? — ?
С префиксом
С префиксом Требует вендорный префикс: webkit
Chrome Android Полная поддержка 25Firefox Android Полная поддержка 22Opera Android Полная поддержка 14Safari iOS Полная поддержка 8Samsung Internet Android Полная поддержка Да
getChrome Полная поддержка 24
Полная поддержка 24
Нет поддержки 23 — 24
С префиксом
С префиксом Требует вендорный префикс: webkit
Edge Полная поддержка 12Firefox Полная поддержка 16
Полная поддержка 16
Нет поддержки 10 — 16
С префиксом
С префиксом Требует вендорный префикс: moz
IE Полная поддержка 10
Замечания
Полная поддержка 10
Замечания
Замечания partial
Opera Полная поддержка 15Safari Полная поддержка 7WebView Android Полная поддержка Да
Полная поддержка Да
Нет поддержки ? — ?
С префиксом
С префиксом Требует вендорный префикс: webkit
Chrome Android Полная поддержка 25Firefox Android Полная поддержка 22Opera Android Полная поддержка 14Safari iOS Полная поддержка 8Samsung Internet Android Полная поддержка Да
getAllChrome Полная поддержка 48Edge Полная поддержка ДаFirefox Полная поддержка 44
Отключено
Полная поддержка 44
Отключено
Отключено From version 44: this feature is behind the dom.indexedDB.experimental preference. To change preferences in Firefox, visit about:config.
IE Нет поддержки НетOpera Полная поддержка 35Safari Полная поддержка 10.1WebView Android Полная поддержка 48Chrome Android Полная поддержка 48Firefox Android Полная поддержка 44
Отключено
Полная поддержка 44
Отключено
Отключено From version 44: this feature is behind the dom.indexedDB.experimental preference. To change preferences in Firefox, visit about:config.
Opera Android Полная поддержка 35Safari iOS Полная поддержка 10.1Samsung Internet Android Полная поддержка 5.0
getAllKeysChrome Полная поддержка 48Edge Полная поддержка ДаFirefox Полная поддержка 44
Отключено
Полная поддержка 44
Отключено
Отключено From version 44: this feature is behind the dom.indexedDB.experimental preference. To change preferences in Firefox, visit about:config.
IE Нет поддержки НетOpera Полная поддержка 35Safari Полная поддержка 10.1WebView Android Полная поддержка 48Chrome Android Полная поддержка 48Firefox Android Полная поддержка 44
Отключено
Полная поддержка 44
Отключено
Отключено From version 44: this feature is behind the dom.indexedDB.experimental preference. To change preferences in Firefox, visit about:config.
Opera Android Полная поддержка 35Safari iOS Полная поддержка 10.1Samsung Internet Android Полная поддержка 5.0
getKeyChrome Полная поддержка 24
Полная поддержка 24
Нет поддержки 23 — 24
С префиксом
С префиксом Требует вендорный префикс: webkit
Edge Полная поддержка 12Firefox Полная поддержка 16
Полная поддержка 16
Нет поддержки 10 — 16
С префиксом
С префиксом Требует вендорный префикс: moz
IE Полная поддержка 10
Замечания
Полная поддержка 10
Замечания
Замечания partial
Opera Полная поддержка 15Safari Полная поддержка 7WebView Android Полная поддержка Да
Полная поддержка Да
Нет поддержки ? — ?
С префиксом
С префиксом Требует вендорный префикс: webkit
Chrome Android Полная поддержка 25Firefox Android Полная поддержка 22Opera Android Полная поддержка 14Safari iOS Полная поддержка 8Samsung Internet Android Полная поддержка Да
isAutoLocale
ЭкспериментальнаяНестандартная
Chrome Нет поддержки НетEdge Нет поддержки НетFirefox Полная поддержка 43IE Нет поддержки НетOpera Нет поддержки НетSafari Нет поддержки НетWebView Android Нет поддержки НетChrome Android Нет поддержки НетFirefox Android Полная поддержка 43Opera Android Нет поддержки НетSafari iOS Нет поддержки НетSamsung Internet Android Нет поддержки Нет
keyPathChrome Полная поддержка 24
Полная поддержка 24
Нет поддержки 23 — 24
С префиксом
С префиксом Требует вендорный префикс: webkit
Edge Полная поддержка 12Firefox Полная поддержка 16
Полная поддержка 16
Нет поддержки 10 — 16
С префиксом
С префиксом Требует вендорный префикс: moz
IE Полная поддержка 10
Замечания
Полная поддержка 10
Замечания
Замечания partial
Opera Полная поддержка 15Safari Полная поддержка 7WebView Android Полная поддержка Да
Полная поддержка Да
Нет поддержки ? — ?
С префиксом
С префиксом Требует вендорный префикс: webkit
Chrome Android Полная поддержка 25Firefox Android Полная поддержка 22Opera Android Полная поддержка 14Safari iOS Полная поддержка 8Samsung Internet Android Полная поддержка Да
locale
ЭкспериментальнаяНестандартная
Chrome Нет поддержки НетEdge Нет поддержки НетFirefox Полная поддержка 43IE Нет поддержки НетOpera Нет поддержки НетSafari Нет поддержки НетWebView Android Нет поддержки НетChrome Android Нет поддержки НетFirefox Android Полная поддержка 43Opera Android Нет поддержки НетSafari iOS Нет поддержки НетSamsung Internet Android Нет поддержки Нет
multiEntryChrome Полная поддержка 24
Полная поддержка 24
Нет поддержки 23 — 24
С префиксом
С префиксом Требует вендорный префикс: webkit
Edge ? Firefox Полная поддержка 16
Полная поддержка 16
Нет поддержки 10 — 16
С префиксом
С префиксом Требует вендорный префикс: moz
IE Полная поддержка 10
Замечания
Полная поддержка 10
Замечания
Замечания partial
Opera Полная поддержка 15Safari Полная поддержка 7WebView Android Полная поддержка Да
Полная поддержка Да
Нет поддержки ? — ?
С префиксом
С префиксом Требует вендорный префикс: webkit
Chrome Android Полная поддержка 25Firefox Android Полная поддержка 22Opera Android Полная поддержка 14Safari iOS Полная поддержка 8Samsung Internet Android Полная поддержка Да
nameChrome Полная поддержка 24
Полная поддержка 24
Нет поддержки 23 — 24
С префиксом
С префиксом Требует вендорный префикс: webkit
Edge Полная поддержка 12Firefox Полная поддержка 16
Полная поддержка 16
Нет поддержки 10 — 16
С префиксом
С префиксом Требует вендорный префикс: moz
IE Полная поддержка 10
Замечания
Полная поддержка 10
Замечания
Замечания partial
Opera Полная поддержка 15Safari Полная поддержка 7WebView Android Полная поддержка Да
Полная поддержка Да
Нет поддержки ? — ?
С префиксом
С префиксом Требует вендорный префикс: webkit
Chrome Android Полная поддержка 25Firefox Android Полная поддержка 22Opera Android Полная поддержка 14Safari iOS Полная поддержка 8Samsung Internet Android Полная поддержка Да
objectStoreChrome Полная поддержка 24
Полная поддержка 24
Нет поддержки 23 — 24
С префиксом
С префиксом Требует вендорный префикс: webkit
Edge Полная поддержка 12Firefox Полная поддержка 16
Полная поддержка 16
Нет поддержки 10 — 16
С префиксом
С префиксом Требует вендорный префикс: moz
IE Полная поддержка 10
Замечания
Полная поддержка 10
Замечания
Замечания partial
Opera Полная поддержка 15Safari Полная поддержка 7WebView Android Полная поддержка Да
Полная поддержка Да
Нет поддержки ? — ?
С префиксом
С префиксом Требует вендорный префикс: webkit
Chrome Android Полная поддержка 25Firefox Android Полная поддержка 22Opera Android Полная поддержка 14Safari iOS Полная поддержка 8Samsung Internet Android Полная поддержка Да
openCursorChrome Полная поддержка 24
Полная поддержка 24
Нет поддержки 23 — 24
С префиксом
С префиксом Требует вендорный префикс: webkit
Edge Полная поддержка 12Firefox Полная поддержка 16
Полная поддержка 16
Нет поддержки 10 — 16
С префиксом
С префиксом Требует вендорный префикс: moz
IE Полная поддержка 10
Замечания
Полная поддержка 10
Замечания
Замечания partial
Opera Полная поддержка 15Safari Полная поддержка 7WebView Android Полная поддержка Да
Полная поддержка Да
Нет поддержки ? — ?
С префиксом
С префиксом Требует вендорный префикс: webkit
Chrome Android Полная поддержка 25Firefox Android Полная поддержка 22Opera Android Полная поддержка 14Safari iOS Полная поддержка 8Samsung Internet Android Полная поддержка Да
openKeyCursorChrome Полная поддержка 24
Полная поддержка 24
Нет поддержки 23 — 24
С префиксом
С префиксом Требует вендорный префикс: webkit
Edge Полная поддержка 12Firefox Полная поддержка 16
Полная поддержка 16
Нет поддержки 10 — 16
С префиксом
С префиксом Требует вендорный префикс: moz
IE Полная поддержка 10
Замечания
Полная поддержка 10
Замечания
Замечания partial
Opera Полная поддержка 15Safari Полная поддержка 7WebView Android Полная поддержка Да
Полная поддержка Да
Нет поддержки ? — ?
С префиксом
С префиксом Требует вендорный префикс: webkit
Chrome Android Полная поддержка 25Firefox Android Полная поддержка 22Opera Android Полная поддержка 14Safari iOS Полная поддержка 8Samsung Internet Android Полная поддержка Да
uniqueChrome Полная поддержка 24
Полная поддержка 24
Нет поддержки 23 — 24
С префиксом
С префиксом Требует вендорный префикс: webkit
Edge Полная поддержка 12Firefox Полная поддержка 16
Полная поддержка 16
Нет поддержки 10 — 16
С префиксом
С префиксом Требует вендорный префикс: moz
IE Полная поддержка 10
Замечания
Полная поддержка 10
Замечания
Замечания partial
Opera Полная поддержка 15Safari Полная поддержка 7WebView Android Полная поддержка Да
Полная поддержка Да
Нет поддержки ? — ?
С префиксом
С префиксом Требует вендорный префикс: webkit
Chrome Android Полная поддержка 25Firefox Android Полная поддержка 22Opera Android Полная поддержка 14Safari iOS Полная поддержка 8Samsung Internet Android Полная поддержка Да
Available in workersChrome Полная поддержка ДаEdge Полная поддержка ДаFirefox Полная поддержка 37IE ? Opera Полная поддержка ДаSafari ? WebView Android Полная поддержка ДаChrome Android Полная поддержка ДаFirefox Android Полная поддержка 37Opera Android Полная поддержка ДаSafari iOS ? Samsung Internet Android Полная поддержка Да

Легенда

Полная поддержка  
Полная поддержка
Нет поддержки  
Нет поддержки
Совместимость неизвестна  
Совместимость неизвестна
Экспериментальная. Ожидаемое поведение может измениться в будущем.
Экспериментальная. Ожидаемое поведение может измениться в будущем.
Нестандартная. Ожидается плохая кросс-браузерная поддержка.
Нестандартная. Ожидается плохая кросс-браузерная поддержка.
Смотрите замечания реализации.
Смотрите замечания реализации.
Пользователь должен сам включить эту возможность.
Пользователь должен сам включить эту возможность.
Требует вендорный префикс или другое имя для использования.
Требует вендорный префикс или другое имя для использования.

See also