IDBIndex.locale
Experimental: Это экспериментальная технология
Так как спецификация этой технологии ещё не стабилизировалась, смотрите таблицу совместимости по поводу использования в различных браузерах. Также заметьте, что синтаксис и поведение экспериментальной технологии может измениться в будущих версиях браузеров, вслед за изменениями спецификации.
The locale
read-only property of the IDBIndex
interface 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 (en-US).) Note that this property always returns the current locale being used in this index, in other words, it never returns "auto"
.
Syntax
var myIndex = objectStore.index('index');
console.log(myIndex.locale);
Value
A DOMString
.
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
(en-US) — this works the same as opening a cursor directly on an ObjectStore
using IDBObjectStore.openCursor
(en-US) except that the returned records are sorted based on the index, not the primary key.
The locale
value is logged to the console.
function displayDataByIndex() {
tableEntry.innerHTML = '';
var transaction = db.transaction(['contactsList'], 'readonly');
var objectStore = transaction.objectStore('contactsList');
var myIndex = objectStore.index('lName');
console.log(myIndex.locale);
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
Not currently part of any specification.
Browser compatibility
BCD tables only load in the browser
See also
- Using IndexedDB
- Starting transactions:
IDBDatabase
(en-US) - Using transactions:
IDBTransaction
(en-US) - Setting a range of keys:
IDBKeyRange
(en-US) - Retrieving and making changes to your data:
IDBObjectStore
(en-US) - Using cursors:
IDBCursor
(en-US) - Reference example: To-do Notifications (view example live.)