我的书签
添加书签
移除书签index . [name](#dom-idbindex-name)
Returns the of the index.
index . [name](#dom-idbindex-name) = newName
Updates the name of the store to newName.
Throws an “[InvalidStateError](https://heycam.github.io/webidl/#invalidstateerror)“ [DOMException](https://heycam.github.io/webidl/#idl-DOMException) if not called within an .
index . [objectStore](#dom-idbindex-objectstore)
Returns the [IDBObjectStore](#idbobjectstore) the index belongs to.
index . keyPath
Returns the key path of the index.
index . multiEntry
Returns true if the index’s is true.
index . unique
Returns true if the index’s unique flag is true.
The name attribute’s getter must return ‘s name.
Is this the same as the ‘s name? As long as the has not finished, this is the same as the associated ‘s name. But once the has finished, this attribute will not reflect changes made with a later .
The [name](#dom-idbindex-name) attribute’s setter must run these steps:
Let name be the given value.
Let transaction be ‘s transaction.
Let index be ‘s index.
If transaction is not an , throw an “
[InvalidStateError](https://heycam.github.io/webidl/#invalidstateerror)“[DOMException](https://heycam.github.io/webidl/#idl-DOMException).If transaction’s is not active, then a “
[TransactionInactiveError](https://heycam.github.io/webidl/#transactioninactiveerror)“[DOMException](https://heycam.github.io/webidl/#idl-DOMException).If index or index’s object store has been deleted, an “
[InvalidStateError](https://heycam.github.io/webidl/#invalidstateerror)“[DOMException](https://heycam.github.io/webidl/#idl-DOMException).If index’s name is equal to name, terminate these steps.
If an named name already exists in index’s , throw a “
[ConstraintError](https://heycam.github.io/webidl/#constrainterror)“[DOMException](https://heycam.github.io/webidl/#idl-DOMException).Set index’s to name.
Set this‘s to name.
The objectStore attribute’s getter must return this‘s .
The keyPath attribute’s getter must return this‘s ‘s key path. The is converted as a [DOMString](https://heycam.github.io/webidl/#idl-DOMString) (if a string) or a sequence (if a list of strings), per .
The returned value is not the same instance that was used when the index was created. However, if this attribute returns an object (specifically an ), it returns the same object instance every time it is inspected. Changing the properties of the object has no effect on the index.
The multiEntry attribute’s getter must return ‘s index‘s .
The unique attribute’s getter must return this‘s ‘s unique flag.
The following methods throw an “[TransactionInactiveError](https://heycam.github.io/webidl/#transactioninactiveerror)“ [DOMException](https://heycam.github.io/webidl/#idl-DOMException) if called when the is not active.
request = index . [get](#dom-idbindex-get)(query)
Retrieves the of the first record matching the given or key range in query.
If successful, request’s [result](#dom-idbrequest-result) will be the , or undefined if there was no matching record.
request = index . [getKey](#dom-idbindex-getkey)(query)
Retrieves the of the first record matching the given or key range in query.
If successful, request’s [result](#dom-idbrequest-result) will be the , or undefined if there was no matching record.
Retrieves the of the records matching the given or key range in query (up to count if given).
If successful, request’s will be an of the values.
request = index . [getAllKeys](#dom-idbindex-getallkeys)(query [, count])
Retrieves the of records matching the given or key range in query (up to count if given).
If successful, request’s [result](#dom-idbrequest-result) will be an of the keys.
request = index . [count](#dom-idbindex-count)(query)
Retrieves the number of matching the given key or in query.
If successful, request’s [result](#dom-idbrequest-result) will be the count.
The get(query) method, when invoked, must run these steps:
Let transaction be this‘s .
Let index be this‘s .
If index or index’s object store has been deleted, an “
[InvalidStateError](https://heycam.github.io/webidl/#invalidstateerror)“[DOMException](https://heycam.github.io/webidl/#idl-DOMException).If transaction’s state is not , then throw a “
[TransactionInactiveError](https://heycam.github.io/webidl/#transactioninactiveerror)“[DOMException](https://heycam.github.io/webidl/#idl-DOMException).Let range be the result of running with query and null disallowed flag true. Rethrow any exceptions.
Return the result (an
[IDBRequest](#idbrequest)) of running asynchronously execute a request with as source and retrieve a referenced value from an index as operation, using the as targetRealm, index and range.
The query parameter may be a key or (an [IDBKeyRange](#idbkeyrange)) identifying the record to be retrieved. If a range is specified, the method retrieves the first existing record in that range.
This method produces the same result if a record with the given key doesn’t exist as when a record exists, but has undefined as value. If you need to tell the two situations apart, you can use [openCursor()](#dom-idbindex-opencursor) with the same key. This will return a cursor with undefined as value if a record exists, or no cursor if no such record exists.
The getKey(query) method, when invoked, must run these steps:
Let transaction be ‘s transaction.
Let index be ‘s index.
If transaction’s is not active, then a “
[TransactionInactiveError](https://heycam.github.io/webidl/#transactioninactiveerror)“[DOMException](https://heycam.github.io/webidl/#idl-DOMException).Let range be the result of running convert a value to a key range with query and null disallowed flag true. Rethrow any exceptions.
Return the result (an
[IDBRequest](#idbrequest)) of running with this as source and as operation, using index and range.
The query parameter may be a key or (an [IDBKeyRange](#idbkeyrange)) identifying the record key to be retrieved. If a range is specified, the method retrieves the first existing key in that range.
The getAll(query, count) method, when invoked, must run these steps:
Let transaction be ‘s transaction.
Let index be ‘s index.
If index or index’s has been deleted, throw an “
[InvalidStateError](https://heycam.github.io/webidl/#invalidstateerror)“[DOMException](https://heycam.github.io/webidl/#idl-DOMException).If transaction’s is not active, then a “
[TransactionInactiveError](https://heycam.github.io/webidl/#transactioninactiveerror)“[DOMException](https://heycam.github.io/webidl/#idl-DOMException).Let range be the result of running convert a value to a key range with query. Rethrow any exceptions.
Return the result (an
[IDBRequest](#idbrequest)) of running with this as source and as operation, using the current Realm as targetRealm, index, range, and count if given.
The query parameter may be a or key range (an [IDBKeyRange](#idbkeyrange)) identifying the to be retrieved. If null or not given, an unbounded key range is used. If count is specified and there are more than count records in range, only the first count will be retrieved.
The getAllKeys(query, count) method, when invoked, must run these steps:
Let transaction be ‘s transaction.
Let index be ‘s index.
If index or index’s has been deleted, throw an “
[InvalidStateError](https://heycam.github.io/webidl/#invalidstateerror)“ .If transaction’s is not active, then a “
[TransactionInactiveError](https://heycam.github.io/webidl/#transactioninactiveerror)“[DOMException](https://heycam.github.io/webidl/#idl-DOMException).Return the result (an
[IDBRequest](#idbrequest)) of running asynchronously execute a request with as source and retrieve multiple values from an index as operation, using index, range, and count if given.
The query parameter may be a or key range (an [IDBKeyRange](#idbkeyrange)) identifying the keys to be retrieved. If null or not given, an unbounded key range is used. If count is specified and there are more than count keys in range, only the first count will be retrieved.
The count(query) method, when invoked, must run these steps:
Let transaction be ‘s transaction.
Let index be ‘s index.
If index or index’s has been deleted, throw an “
[InvalidStateError](https://heycam.github.io/webidl/#invalidstateerror)“[DOMException](https://heycam.github.io/webidl/#idl-DOMException).Let range be the result of running with query. Rethrow any exceptions.
Return the result (an
[IDBRequest](#idbrequest)) of running asynchronously execute a request with as source and count the records in a range as operation, using as source and range.
The query parameter may be a key or (an [IDBKeyRange](#idbkeyrange)) identifying the records keys to be counted. If null or not given, an is used.
The following methods throw an “[TransactionInactiveError](https://heycam.github.io/webidl/#transactioninactiveerror)“ [DOMException](https://heycam.github.io/webidl/#idl-DOMException) if called when the transaction is not .
request = index . [openCursor](#dom-idbindex-opencursor)([query [, direction = “next”]])
Opens a cursor over the matching query, ordered by direction. If query is null, all records in index are matched.
If successful, request’s [result](#dom-idbrequest-result) will be an [IDBCursorWithValue](#idbcursorwithvalue), or null if there were no matching .
request = index . [openKeyCursor](#dom-idbindex-openkeycursor)([query [, direction = “next”]])
Opens a cursor with set to true over the records matching query, ordered by direction. If query is null, all in index are matched.
If successful, request’s [result](#dom-idbrequest-result) will be an [IDBCursor](#idbcursor), or null if there were no matching records.
The openCursor(query, direction) method, when invoked, must run these steps:
Let transaction be ‘s transaction.
Let index be ‘s index.
If index or index’s has been deleted, throw an “
[InvalidStateError](https://heycam.github.io/webidl/#invalidstateerror)“[DOMException](https://heycam.github.io/webidl/#idl-DOMException).If transaction’s is not active, then a “
[TransactionInactiveError](https://heycam.github.io/webidl/#transactioninactiveerror)“[DOMException](https://heycam.github.io/webidl/#idl-DOMException).Let range be the result of running convert a value to a key range with query. Rethrow any exceptions.
Let cursor be a new with its transaction set to transaction, undefined , direction set to direction, set to false, undefined key and , source set to index, set to range, and key only flag set to false.
Let request be the result of running with this as source and as operation, using the current Realm as targetRealm, and cursor.
Set cursor’s to request.
Return request.
The query parameter may be a key or (an [IDBKeyRange](#idbkeyrange)) to use as the cursor‘s . If null or not given, an unbounded key range is used.
The openKeyCursor(query, direction) method, when invoked, must run these steps:
Let transaction be ‘s transaction.
Let index be ‘s index.
If index or index’s has been deleted, throw an “
[InvalidStateError](https://heycam.github.io/webidl/#invalidstateerror)“[DOMException](https://heycam.github.io/webidl/#idl-DOMException).If transaction’s is not active, then a “
[TransactionInactiveError](https://heycam.github.io/webidl/#transactioninactiveerror)“[DOMException](https://heycam.github.io/webidl/#idl-DOMException).Let range be the result of running convert a value to a key range with query. Rethrow any exceptions.
Let cursor be a new with its transaction set to transaction, undefined , direction set to direction, set to false, undefined key and , source set to index, set to range, and key only flag set to true.
Let request be the result of running with this as source and as operation, using the current Realm as targetRealm, and cursor.
Return request.
