This document defines APIs for a database of records holding simple values and hierarchical objects. Each record consists of a key and some value. Moreover, the database maintains indexes over records it stores. An application developer directly uses an API to locate records either by their key or by using an index. A query language can be layered on this API. An indexed database can be implemented using a persistent B-tree data structure.

This is the Second Edition of Indexed Database API. The First Edition became a W3C Recommendation on 8 January 2015.

This specification's bugs and issues are managed in GitHub (new bug, open bugs). Feature requests are tracked in the Indexed Database Features document.

Introduction

User agents need to store large numbers of objects locally in order to satisfy off-line data requirements of Web applications. [[WEBSTORAGE]] is useful for storing pairs of keys and their corresponding values. However, it does not provide in-order retrieval of keys, efficient searching over values, or storage of duplicate values for a key.

This specification provides a concrete API to perform advanced key-value data management that is at the heart of most sophisticated query processors. It does so by using transactional databases to store keys and their corresponding values (one or more per key), and providing a means of traversing keys in a deterministic order. This is often implemented through the use of persistent B-tree data structures that are considered efficient for insertion and deletion as well as in-order traversal of very large numbers of data records.

This specification defines one class of products:

Conforming user agent

A user agent MUST behave as described in this specification in order to be considered conformant.

User agents MAY implement algorithms given in this specification in any way desired, so long as the end result is indistinguishable from the result that would be obtained by the specification's algorithms.

A conforming Indexed Database API user agent MUST also be a conforming implementation of the IDL fragments of this specification, as described in the “Web IDL” specification. [[!WEBIDL]]

Dependencies

This specification relies on several other underlying specifications.

DOM-LEVEL-3-EVENTS
The terms default action and propagation path are defined by the Document Object Model (DOM) Level 3 Events Specification [[!DOM-LEVEL-3-EVENTS]].
DOM4
The types Event, EventTarget and DOMStringList are defined by the W3C DOM4 Specification [[!DOM4]].
HTML5
The terms and algorithms document, Window, EventHandler, Function, document base URL, event handler attributes, event handler event type, strictly split a string, origin, same origin, structured clone, structured clone algorithm, task, task source, and queue a task are defined by the HTML 5 specification [[!HTML5]].
WebIDL
The terms, types, and algorithms throw, getting a copy of the bytes held by a buffer source, octet, unrestricted double, DOMString, sequence<DOMString>, DOMException and and the interface definition language used in this spec are defined by [[!WEBIDL]].
WebWorkers
The terms Worker and WorkerUtils are defined by the WebWorkers specification [[!WEBWORKERS]].

Indexed Database API

A sorted list is a DOMStringList containing strings sorted in ascending order using the algorithm defined by step 4 of section 11.8.5, The Abstract Relational Comparison Algorithm of the ECMAScript Language Specification [[!ECMA-262]].

Constructs

Database

A database's origin is the same as the origin of the document or worker. Each origin has an associated set of databases.

Each origin has an associated set of databases. A database has zero or more object stores which hold the data stored in the database.

A database has a name which identifies it within a specific origin. The name can be any string value, including the empty string, and stays constant for the lifetime of the database. Database names are always compared in a case-sensitive manner, as opaque sequences of 16-bit code units. Implementations MUST support all names.

A database has a version. When a database is first created, its version is 0 (zero).

A database has a delete pending flag which is used during deletion. When a database is requested to be deleted the flag is set and all attempts at opening the database are stalled until the database can be deleted.

Database Connection

Script does not interact with databases directly. Instead, script has indirect access via a connection. A connection object can be used to manipulate the objects of that database. It is also the only way to obtain a transaction for that database.

The act of opening a database creates a connection. There MAY be multiple connections to a given database at any given time.

A connection has a version, which is set when the connection is created. It remains constant for the lifetime of the connection unless an upgrade is aborted, in which case it is set to the previous version of the database. Once the connection is closed the version does not change.

Each connection has a close pending flag which is initially unset.

When a connection is initially created it is in opened state. The connection can be closed through several means. If the execution context where the connection was created is destroyed (for example due to the user navigating away from that page), the connection is closed. The connection can also be closed explicitly using the steps for closing a database connection. When the connection is closed the close pending flag is always set if it hasn't already been.

A connection may be closed by a user agent in exceptional circumstances, for example due to loss of access to the file system or a permission change. If this occurs the user agent MUST run the steps for closing a database connection with the connection and with the forced flag set.

A connection has an object store set, which is initialized to the set of object stores in the associated database when the connection is created. The contents of the set will remain constant except when an upgrade transaction is running.

Object Store

An object store is the primary storage mechanism for storing data in a database.

Each database has a set of object stores. The set of object stores can be changed, but only using an upgrade transaction, i.e. in response to an upgradeneeded event. When a new database is created it doesn't contain any object stores.

An object store has a list of records which hold the data stored in the object store. Each record consists of a key and a value. The list is sorted according to key in ascending order. There can never be multiple records in a given object store with the same key.

An object store has a name. The name can be any string value, including the empty string. At any one time, the name is unique within the database to which it belongs. Object store names are always compared in a case-sensitive manner, as opaque sequences of 16-bit code units.

An object store optionally has a key path. If the object store has a key path it is said to use in-line keys. Otherwise it is said to use out-of-line keys.

An object store optionally has a key generator.

An object store can derive a key for a record from one of three sources:

  1. A key generator. A key generator generates a monotonically increasing numbers every time a key is needed.
  2. Keys can be derived via a key path.
  3. Keys can also be explicitly specified when a value is stored in the object store.
Object Store Handle

Script does not interact with object stores directly. Instead, within a transaction, script has indirect access via an object store handle.

An object store handle has an associated object store and an associated transaction. Multiple handles MAY be associated with the same object store in different transactions, but there MUST be only one object store handle associated with a particular object store within a transaction.

An object store handle has an index set, which is initialized to the set of indexes that reference the associated object store when the object store handle is created. The contents of the set will remain constant except when an upgrade transaction is running.

An object store handle has a name, which is initialized to the name of the associated object store when the object store handle is created. The name will remain constant except when an upgrade transaction is running.

Values

Each record is associated with a value. Conforming user agents MUST support any ECMAScript [[!ECMA-262]] value supported by the structured clone algorithm [[!HTML5]]. This includes simple types such as String primitive values and Date objects as well as Object and Array instances, File objects, Blob objects, ImageData objects, and so on. Record values are stored and retrieved by value rather than by reference; later changes to a value have no effect on the record stored in the database.

Keys

In order to efficiently retrieve records stored in an indexed database, each record is organized according to its key.

A key has an associated type which is one of: number, date, string, binary, or array.

A key also has an associated value, which will be either: an unrestricted double if type is number or date, a DOMString if type is string, a list of octets if type is binary, or a list of other keys if type is array.

An ECMAScript [[!ECMA-262]] value can be converted to a key by following the steps to convert a value to a key.

An array key is a key with type array. The subkeys of an array key are the members of the array key's value list.

To compare two keys a and b, run these steps:

  1. Let ta be the type of a.
  2. Let tb be the type of b.
  3. If ta is array and tb is binary, string, date or number, return 1.
  4. If tb is array and ta is binary, string, date or number, return -1.
  5. If ta is binary and tb is string, date or number, return 1.
  6. If tb is binary and ta is string, date or number, return -1.
  7. If ta is string and tb is date or number, return 1.
  8. If tb is string and ta is date or number, return -1.
  9. If ta is date and tb is number, return 1.
  10. If tb is date and ta is number, return -1.
  11. Assert: ta and tb are equal.
  12. Let va be the value of a.
  13. Let vb be the value of b.
  14. Switch on ta:
    number
    date
    1. If va is greater than vb, then return 1.
    2. If va is less than vb, then return -1.
    3. Return 0
    string
    1. Let length be the lesser of va's length and vb's length.
    2. Let i be 0.
    3. While i is less than length, run these substeps:
      1. Let u be the code unit of va at index i
      2. Let v be the code unit of vb at index i
      3. If u is greater than v then return 1
      4. If u is less than v then return -1
      5. Increase i by 1
    4. If va's length is greater than vb's length, then return 1
    5. If va's length is less than vb's length, then return -1
    6. Return 0
    binary
    1. Let length be the lesser of va's length and vb's length.
    2. Let i be 0.
    3. While i is less than length, run these substeps:
      1. Let u be the octet in va at index i
      2. Let v be the octet in vb at index i
      3. If u is greater than v then return 1
      4. If u is less than v then return -1
      5. Increase i by 1
    4. If va's length is greater than vb's length, then return 1
    5. If va's length is less than vb's length, then return -1
    6. Return 0
    array
    1. Let length be the lesser of va's length and vb's length.
    2. Let i be 0.
    3. While i is less than length, run these substeps:
      1. Let u be the key in va at index i
      2. Let v be the key in vb at index i
      3. Let c be the result of recursively running the steps to compare two keys with u and v
      4. If c is not 0, return c
      5. Increase i by 1
    4. If va's length is greater than vb's length, then return 1
    5. If va's length is less than vb's length, then return -1
    6. Return 0

The key a is greater than the key b if the result of running the steps to compare two keys with a and b is 1.

The key a is less than the key b if the result of running the steps to compare two keys with a and b is -1.

The key a is equal to the key b if the result of running the steps to compare two keys with a and b is 0.

Key Path

A key path is a DOMString or sequence<DOMString> that defines how to extract a key from a value. A valid key path is one of:

  • An empty DOMString.
  • An identifier, which is a DOMString matching the IdentifierName production from the ECMAScript Language Specification [[!ECMA-262]].
  • A DOMString consisting of two or more identifiers separated by periods (ASCII character code 46, U+002E FULL STOP).
  • A non-empty sequence<DOMString> containing only strings conforming to the above requirements.

Key path values can only be accessed from properties explicitly copied by the structured clone algorithm, as well as the following type-specific properties:

TypeProperties
Blobsize, type
Filename, lastModified, lastModifiedDate
Arraylength
Stringlength

Index

It is sometimes useful to retrieve records in an object store through other means than their key. An index allows looking up records in an object store using properties of the values in the object stores records.

An index is a specialized persistent key-value storage and has a referenced object store. The index has a list of records which hold the data stored in the index. The records in an index are automatically populated whenever records in the referenced object store are inserted, updated or deleted. There can be several indexes referencing the same object store, in which changes to the object store cause all such indexes to get updated.

The values in the index's records are always values of keys in the index's referenced object store. The keys are derived from the referenced object store's values using a key path. If a given record with key X in the object store referenced by the index has the value A, and evaluating the index's key path on A yields the result Y, then the index will contain a record with key Y and value X.

Records in an index are said to have a referenced value. This is the value of the record in the index's referenced object store which has a key equal to the index's record's value. So in the example above, the record in the index whose key is Y and value is X has a referenced value of A.

The records in an index are always sorted according to the record's key. However unlike object stores, a given index can contain multiple records with the same key. Such records are additionally sorted according to the index's record's value (meaning the key of the record in the referenced object store).

An index has a name. The name can be any string value, including the empty string. At any one time, the name is unique within index's referenced object store. Index names are always compared in a case-sensitive manner, as opaque sequences of 16-bit code units.

An index has a unique flag. When this flag is set, the index enforces that no two records in the index has the same key. If a record in the index's referenced object store is attempted to be inserted or modified such that evaluating the index's key path on the records new value yields a result which already exists in the index, then the attempted modification to the object store fails.

An index has a multiEntry flag. This flag affects how the index behaves when the result of evaluating the index's key path yields an array key. If the multiEntry flag is unset, then a single record whose key is an array key is added to the index. If the multiEntry flag is true, then the one record is added to the index for each of the subkeys.

Index Handle

Script does not interact with indexes directly. Instead, within a transaction, script has indirect access via an index handle.

An index handle has an associated index and an associated object store handle. The transaction of an index handle is the transaction of its associated object store handle. Multiple handles MAY be associated with the same index in different transactions, but there MUST be only one index handle associated with a particular index within a transaction.

An index handle has a name, which is initialized to the name of the associated index when the index handle is created. The name will remain constant except when an upgrade transaction is running.

Transactions

A Transaction is used to interact with the data in a database. Whenever data is read or written to the database it is done by using a transaction.

transactions offer some protection from application and system failures. A transaction may be used to store multiple data records or to conditionally modify certain data records. A transaction represents an atomic and durable set of data access and data mutation operations.

All transactions are created through a connection, which is the transaction's connection.

A transaction has a scope that determines the object stores with which the transaction may interact. A transaction's scope remains fixed for the lifetime of that transaction.

A transaction has a mode that determines which types of interactions can be performed upon that transaction. The mode is set when the transaction is created and remains fixed for the life of the transaction. A transaction's mode is one of the following:

"readonly"
The transaction is only allowed to read data. No modifications can be done by this type of transaction. This has the advantage that several read-only transactions can run at the same time even if their scopes are overlapping, i.e. if they are using the same object stores. This type of transaction can be created any time once a database has been opened.
"readwrite"
The transaction is allowed to read, modify and delete data from existing object stores. However object stores and indexes can't be added or removed. Multiple "readwrite" transactions can't run at the same time if their scopes are overlapping since that would mean that they can modify each other's data in the middle of the transaction. This type of transaction can be created any time once a database has been opened.
"versionchange"
The transaction is allowed to read, modify and delete data from existing object stores, and can also create and remove object stores and indexes. It is the only type of transaction that can do so. This type of transaction can't be manually created, but instead is created automatically when an upgradeneeded event is fired.

A transaction has an active flag, which determines if new requests can be made against the transaction. A transaction is said to be active if its active flag is set.

A transaction has a request list of requests which have been made against the transaction.

A transaction has a error which is set if the transaction is aborted.

transactions are expected to be short lived. This is encouraged by the automatic committing functionality described below.

The lifetime of a transaction is as follows:

  1. A transaction is created with a scope and a mode. When a transaction is created its active flag is initially set.
  2. The implementation MUST allow requests to be placed against the transaction whenever the active flag is set. This is the case even if the transaction has not yet been started. Until the transaction is started the implementation MUST NOT execute these requests; however, the implementation MUST keep track of the requests and their order. Requests may be placed against a transaction only while that transaction is active. If an attempt is made to place a request against a transaction when that transaction is not active, the implementation MUST reject the attempt by throwing a TransactionInactiveError exception.
  3. Once an implementation is able to enforce the constraints defined for the transaction scope and mode, defined below, the implementation MUST queue a task to start the transaction asynchronously.
  4. Once the transaction has been started the implementation can start executing the requests placed against the transaction. Unless otherwise defined, requests MUST be executed in the order in which they were made against the transaction. Likewise, their results MUST be returned in the order the requests were placed against a specific transaction. There is no guarantee about the order that results from requests in different transactions are returned. Similarly, the transaction modes ensure that two requests placed against different transactions can execute in any order without affecting what resulting data is stored in the database.
  5. A transaction can be aborted at any time before it is finished, even if the transaction isn't currently active or hasn't yet started. When a transaction is aborted the implementation MUST undo (roll back) any changes that were made to the database during that transaction. This includes both changes to the contents of object stores as well as additions and removals of object stores and indexes.
  6. A transaction can fail for reasons not tied to a particular request. For example due to IO errors when committing the transaction, or due to running into a quota limit where the implementation can't tie exceeding the quota to a partcular request. In this case the implementation MUST run the steps for aborting a transaction using the transaction as transaction and the appropriate error type as error. For example if quota was exceeded then QuotaExceededError should be used as error, and if an IO error happened, UnknownError should be used as error.
  7. When a transaction can no longer become active, the implementation MUST attempt to commit it, as long as the transaction has not been aborted. This usually happens after all requests placed against the transaction have been executed and their returned results handled, and no new requests have been placed against the transaction. When a transaction is committed, the implementation MUST atomically write any changes to the database made by requests placed against the transaction. That is, either all of the changes MUST be written, or if an error occurs, such as a disk write error, the implementation MUST NOT write any of the changes to the database. If such an error occurs, the implementation MUST abort the transaction by following the steps for aborting a transaction, otherwise it MUST commit the transaction by following the steps for committing a transaction.
  8. When a transaction is committed or aborted, it is said to be finished. If a transaction can't be finished, for example due to the implementation crashing or the user taking some explicit action to cancel it, the implementation MUST abort the transaction.

A read-only transaction is a transaction with mode "readonly".

A read/write transaction is a transaction with mode "readwrite".

The following constraints define when a transaction can be started:

  • Any number of read-only transactions are allowed to run concurrently, even if the transaction's scope overlap and include the same object stores. As long as a read-only transaction is running, the data that the implementation returns through requests created with that transaction MUST remain constant. That is, two requests to read the same piece of data MUST yield the same result both for the case when data is found and the result is that data, and for the case when data is not found and a lack of data is indicated.
  • Similarly, implementations MUST ensure that a read/write transaction is only affected by changes to object stores that are made using the transaction itself. For example, the implementation MUST ensure that another transaction does not modify the contents of object stores in the read/write transaction's scope. The implementation MUST also ensure that if the read/write transaction completes successfully, the changes written to object stores using the transaction can be committed to the database without merge conflicts. An implementation MUST NOT abort a transaction due to merge conflicts.
  • If multiple read/write transactions are attempting to access the same object store (i.e. if they have overlapping scope), the transaction that was created first MUST be the transaction which gets access to the object store first. Due to the requirements in the previous paragraph, this also means that it is the only transaction which has access to the object store until the transaction is finished.
  • Any transaction created after a read/write transaction MUST see the changes written by the read/write transaction. So if a read/write transaction, A, is created, and later another transaction B, is created, and the two transactions have overlapping scopes, then B MUST see any changes made to any object stores that are part of that overlapping scope. Due to the requirements in the previous paragraph, this also means that the B transaction does not have access to any object stores in that overlapping scope until the A transaction is finished.
  • User agents MUST ensure a reasonable level of fairness across transactions to prevent starvation. For example, if multiple read-only transactions are started one after another the implementation MUST NOT indefinitely prevent a pending read/write transaction from starting.
Upgrade Transactions

An upgrade transaction is a transaction with mode "versionchange".

An upgrade transaction is automatically created when running steps for running an upgrade transaction after a connection is opened to a database giving a greater version than the current version. This transaction will be active inside the upgradeneeded event handler, allowing the creation of new object stores and indexes.

An upgrade transaction is never run concurrently with other transactions. When a database is opened with a version number higher than the current version, a new upgrade transaction is automatically created and made available through the open request when the upgradeneeded event is fired. The upgradeneeded event isn't fired, and thus the upgrade transaction isn't started, until all other connections to the same database are closed. This ensures that all other transactions are finished.

As long as an upgrade transaction is running, attempts to open more connections to the same database are delayed, and any attempts to use the same connection to start additional transactions will result in an exception being thrown. Thus upgrade transactions not only ensure that no other transactions are running concurrently, but also ensure that no other transactions are queued against the same database as long as the transaction is running.

Requests

Each asynchronous operation on a database is done using a request. Every request represents one operation.

A request has a done flag which is initially unset.

A request has a source object.

A request has a result and an error, neither of which are accessible until the done flag is set.

A request has a transaction which is initially null. This will be set when a request is placed against a transaction using the steps for asynchronously executing a request.

When a request is made, a new request is returned with its done flag unset. If a request completes successfully, the done flag is set, the result is set to the result of the request, and an event with type success is fired at the request.

If an error occurs while performing the operation, the done flag is set, the error is set to the error, and an event with type error is fired at the request.

An open request is a special type of request used when opening a connection or deleting a database. In addition to success and error events, blocked and upgradeneeded may be fired at an open request to indicate progress.

The source of an open request is always null.

The transaction of an open request is null unless an upgradeneeded event has been fired.

Key Range

Records can be retrieved from object stores and indexes using either keys or key ranges. A key range is a continuous interval over some data type used for keys.

A key range has an associated lower bound (null or a key).

A key range has an associated upper bound (null or a key).

A key range has an associated lower open flag. Unless otherwise stated it is unset.

A key range has an associated upper open flag. Unless otherwise stated it is unset.

A key range MAY have a lower bound equal to its upper bound. A key range MUST NOT have a lower bound greater than its upper bound.

A key range containing only key has both lower bound and upper bound equal to key.

A key is in a key range if both of the following conditions are fulfilled:

An unbounded key range is a key range that has both lower bound and upper bound equal to null. All keys are in an unbounded key range.

The steps to convert a value to a key range with value and optional null allowed flag are as follows:

  1. If value is a key range, return value.
  2. If value is undefined or is null, then throw a DataError exception if null disallowed flag is set, or return an unbounded key range otherwise.
  3. Let key be the result of running the steps to convert a value to a key with value. If this throws an exception, rethrow it.
  4. If key is invalid, throw a DataError exception.
  5. Return a key range containing only key.

Cursor

A cursor is used to iterate over a range of records in an index or an object store in a specific direction.

A cursor has a transaction, the transaction that was active when the cursor was created.

A cursor has a range of records in either an index or an object store.

A cursor has a source that indicates which index or an object store is associated with the records over which the cursor is iterating.

A cursor has a direction that determines whether it moves in monotonically increasing or decreasing order of the record keys when iterated, and if it skips duplicated values when iterating indexes. The direction of a cursor also determines if the cursor initial position is at the start of its source or at its end. A cursor's direction is one of the following:

"next"
This direction causes the cursor to be opened at the start of the source. When iterated, the cursor should yield all records, including duplicates, in monotonically increasing order of keys.
"nextunique"
This direction causes the cursor to be opened at the start of the source. When iterated, the cursor should not yield records with the same key, but otherwise yield all records, in monotonically increasing order of keys. For every key with duplicate values, only the first record is yielded. When the source is an object store or an index with the unique flag set, this direction has exactly the same behavior as "next".
"prev"
This direction causes the cursor to be opened at the end of the source. When iterated, the cursor should yield all records, including duplicates, in monotonically decreasing order of keys.
"prevunique"
This direction causes the cursor to be opened at the end of the source. When iterated, the cursor should not yield records with the same key, but otherwise yield all records, in monotonically decreasing order of keys. For every key with duplicate values, only the first record is yielded. When the source is an object store or an index with the unique flag set, this direction has exactly the same behavior as "prev".

A cursor has a position within its range. It is possible for the list of records which the cursor is iterating over to change before the full range of the cursor has been iterated. In order to handle this, cursors maintain their position not as an index, but rather as a key of the previously returned record. For a forward iterating cursor, the next time the cursor is asked to iterate to the next record it returns the record with the lowest key greater than the one previously returned. For a backwards iterating cursor, the situation is opposite and it returns the record with the highest key less than the one previously returned.

For cursors iterating indexes the situation is a little bit more complicated since multiple records can have the same key and are therefore also sorted by value. When iterating indexes the cursor also has an object store position, which indicates the value of the previously found record in the index. Both position and the object store position are used when finding the next appropriate record.

A cursor has a key and a value which represent the key and the value of the last iterated record.

A cursor has a got value flag. When this flag unset, the cursor is either in the process of loading the next value or it has reached the end of its range. When it is set, it indicates that the cursor is currently holding a value and that it is ready to iterate to the next one.

If the source of a cursor is an object store, the effective object store of the cursor is that object store and the effective key of the cursor is the cursor's position. If the source of a cursor is an index, the effective object store of the cursor is that index's referenced object store and the effective key is the cursor's object store position.

A cursor also has a key only flag, that indicates whether the cursor's value is exposed via the API. Unless stated otherwise it is unset.

Key Generators

When a object store is created it can be specified to use a key generator. A key generator keeps an internal current number. The current number is always a positive integer. Whenever the key generator is used to generate a new key, the generator's current number is returned and then incremented to prepare for the next time a new key is needed. Implementations MUST use the following rules for generating numbers when a key generator is used.

  • Every object store that uses key generators use a separate generator. I.e. interacting with one object store never affects the key generator of any other object store.
  • The current number of a key generator is always set to 1 when the object store for that key generator is first created.
  • When a key generator is used to generate a new key for a object store, the key generator's current number is used as the new key value and then the key generator's current number is increased by 1.
  • When a record is stored and a key is specified in the call to store the record, if type of the key is number and the value is greater than or equal to the key generator's current number, then the key generator's current number is set to the smallest integer number greater than the explicit key. A key can be specified both for object stores which use in-line keys, by setting the property on the stored value which the object store's key path points to, and for object stores which use out-of-line keys, by passing a key argument to the call to store the record.

  • Modifying a key generator's current number is considered part of a database operation. This means that if the operation fails and the operation is reverted, the current number is reverted to the value it had before the operation started. This applies both to modifications that happen due to the current number getting increased by 1 when the key generator is used, and to modifications that happen due to a record being stored with a key value specified in the call to store the record.
  • Likewise, if a transaction is aborted, the current number of the key generator for each object store in the transaction's scope is reverted to the value it had before the transaction was started.
  • When the current number of a key generator reaches above the value 253 (9007199254740992) any attempts to use the key generator to generate a new key will result in a ConstraintError. It is still possible to insert records into the object store by specifying an explicit key, however the only way to use a key generator again for the object store is to delete the object store and create a new one.
  • The current number for a key generator never decreases, other than as a result of database operations being reverted. Deleting a record from an object store never affects the object store's key generator. Even clearing all records from an object store, for example using the clear() method, does not affect the current number of the object store's key generator.

A practical result of this is that the first key generated for an object store is always 1 (unless a higher numeric key is inserted first) and the key generated for an object store is always a positive integer higher than the highest numeric key in the store. The same key is never generated twice for the same object store unless a transaction is rolled back.

Exceptions

Each of the exceptions defined in this document is a DOMException with a specific type. The exception types and properties such as code value are defined in [[!WEBIDL]].

Type Description
AbortError A request was aborted.
ConstraintError A mutation operation in the transaction failed because a constraint was not satisfied.
DataCloneError The data being stored could not be cloned by the internal structured cloning algorithm.
DataError Data provided to an operation does not meet requirements.
InvalidAccessError An invalid operation was performed on an object.
InvalidStateError An operation was called on an object on which it is not allowed or at a time when it is not allowed, or if a request is made on a source object that has been deleted or removed.
NotFoundError The operation failed because the requested database object could not be found.
QuotaExceededError The operation failed because there was not enough remaining storage space, or the storage quota was reached and the user declined to give more space to the database.
SyntaxError The keyPath argument contains an invalid key path.
ReadOnlyError The mutating operation was attempted in a read-only transaction.
TransactionInactiveError A request was placed against a transaction which is currently not active, or which is finished.
UnknownError The operation failed for reasons unrelated to the database itself and not covered by any other errors.
VersionError An attempt was made to open a database using a lower version than the existing version.

API

The API methods return without blocking the calling thread. All asynchronous operations immediately return an IDBRequest instance. This object does not initially contain any information about the result of the operation. Once information becomes available, an event is fired on the request and the information becomes available through the properties of the IDBRequest instance.

The task source for these tasks is the database access task source.

The IDBRequest interface

The IDBRequest interface provides the means to access results of asynchronous requests to databases and database objects using event handler attributes [[!HTML5]].

Every method for making asynchronous requests returns an IDBRequest object that communicates back to the requesting application through events. This design means that any number of requests can be active on any database at a time.

[Exposed=(Window,Worker)]
interface IDBRequest : EventTarget {
    readonly    attribute any                                        result;
    readonly    attribute DOMException                               error;
    readonly    attribute (IDBObjectStore or IDBIndex or IDBCursor)? source;
    readonly    attribute IDBTransaction                             transaction;
    readonly    attribute IDBRequestReadyState                       readyState;

    // Event handlers:
                attribute EventHandler                               onsuccess;
                attribute EventHandler                               onerror;
};

enum IDBRequestReadyState {
    "pending",
    "done"
};
          

The result attribute's getter must throw an InvalidStateError exception if the done flag is unset. Otherwise, the attribute's getter must return the result of the request, or undefined if the request.resulted in an error.

The error attribute's getter must throw an InvalidStateError exception if the done flag is unset. Otherwise, the attribute's getter must return the error of the request, or null if no error occurred.

The source attribute's getter must return the source of the request, or null if no source is set.

The transaction attribute's getter must return the transaction of the request. This property can be null for certain requests, such as for request returned from IDBFactory.open().

The readyState attribute's getter must return "pending" if the done flag is unset, and "done" otherwise.

The onsuccess attribute is the event handler for the success event.

The onerror attribute is the event handler for the error event.

Methods on IDBFactory that return a open request use an extended interface to allow listening to the blocked event and upgradeneeded event.

[Exposed=(Window,Worker)]
interface IDBOpenDBRequest : IDBRequest {
    // Event handlers:
                attribute EventHandler onblocked;
                attribute EventHandler onupgradeneeded;
};
          

The onblocked attribute is the event handler for the blocked event.

The onupgradeneeded attribute is the event handler for the upgradeneeded event.

Event interfaces

This specification fires events with the following custom interfaces:

[Exposed=(Window,Worker), Constructor(DOMString type, optional IDBVersionChangeEventInit eventInitDict)]
interface IDBVersionChangeEvent : Event {
    readonly    attribute unsigned long long  oldVersion;
    readonly    attribute unsigned long long? newVersion;
};

dictionary IDBVersionChangeEventInit : EventInit {
    unsigned long long  oldVersion = 0;
    unsigned long long? newVersion = null;
};
          

The oldVersion attribute getter returns the previous version of the database.

The newVersion attribute getter returns the new version of the database, or null if the database is being deleted. See the steps for running an upgrade transaction.

Events are constructed as defined in Constructing events, in [[!DOM4]].

To fire a version change event named e at target given oldVersion and newVersion, dispatch an event at target. The event MUST use the IDBVersionChangeEvent interface with its type set to e, its oldVersion attribute set to oldVersion, and its newVersion attribute set to newVersion. This event MUST NOT bubble or be cancelable. The propagation path for the event is just target.

The IDBFactory interface

Database objects are accessed through methods on the IDBFactory interface. A single object implementing this interface is present in the global scope of environments that support Indexed DB operations.

[NoInterfaceObject]
interface IDBEnvironment {
    readonly    attribute IDBFactory indexedDB;
};
Window implements IDBEnvironment;
WorkerUtils implements IDBEnvironment;
          

The indexedDB attribute provides applications a mechanism for accessing capabilities of indexed databases.

[Exposed=(Window,Worker)]
interface IDBFactory {
    IDBOpenDBRequest open(DOMString name, [EnforceRange] optional unsigned long long version);
    IDBOpenDBRequest deleteDatabase(DOMString name);

    short            cmp(any first, any second);
};
          

The open(name, version) method, when invoked, must run these steps:

  1. If version is 0 (zero), throw a TypeError.
  2. Let request be a new open request.
  3. Queue a task to run these substeps:
    1. Let result be the result of running the steps for opening a database, with the origin of the IDBEnvironment used to access this IDBFactory, name, version if given and undefined otherwise, and request.
    2. If result is an error, set the error of request to result and dispatch an event at request. The event must use the Event interface and set the type attribute to "error". The event does bubble but is not cancelable. The propagation path of the event is just request.
    3. Otherwise, set the result of request to result and dispatch an event at request. The event must use the Event interface and set the type attribute to "success". The event does not bubble and is not cancelable. The propagation path of the event is just request. If the steps above resulted in an upgrade transaction being run, then firing the "success" event MUST be done after the upgrade transaction completes.
  4. Return a new IDBOpenDBRequest object for request.

The deleteDatabase(name) method, when invoked, must run these steps:

  1. Let request be a new open request.
  2. Queue a task to run these substeps:
    1. Let result be the result of running the steps for deleting a database, with the origin of the IDBEnvironment used to access this IDBFactory, name, and request.
    2. If result is an error set the error of request to result and dispatch an event at request. The event must use the Event interface and set the type attribute to "error". The event does bubble but is not cancelable. The propagation path of the event is just request.
    3. Otherwise, set the result of request to undefined and fire a version change event named success at request with result and null.
  3. Return a new IDBOpenDBRequest object for request.

The cmp(first, second) method, when invoked, must run these steps:

  1. Let a be the result of running the steps to convert a value to a key with first. If this throws an exception, rethrow it.
  2. If a is invalid, throw a DataError exception.
  3. Let b be the result of running the steps to convert a value to a key with second. If this throws an exception, rethrow it.
  4. If b is invalid, throw a DataError exception.
  5. Return the results of running the steps to compare two keys with a and b.

The IDBDatabase interface

The IDBDatabase interface represents a connection to a database.

An IDBDatabase object MUST NOT be garbage collected if its associated connection's close pending flag is unset and it has one or more event listeners registers whose type is one of abort, error, or versionchange. If an IDBDatabase object is garbage collected, the associated connection must be closed.

[Exposed=(Window,Worker)]
interface IDBDatabase : EventTarget {
    readonly    attribute DOMString          name;
    readonly    attribute unsigned long long version;
    readonly    attribute DOMStringList      objectStoreNames;

    IDBTransaction transaction((DOMString or sequence<DOMString>) storeNames, optional IDBTransactionMode mode = "readonly");
    void           close();

    IDBObjectStore createObjectStore(DOMString name, optional IDBObjectStoreParameters options);
    void           deleteObjectStore(DOMString name);

    // Event handlers:
                attribute EventHandler       onabort;
                attribute EventHandler       onclose;
                attribute EventHandler       onerror;
                attribute EventHandler       onversionchange;
};

dictionary IDBObjectStoreParameters {
    (DOMString or sequence<DOMString>)? keyPath = null;
    boolean                             autoIncrement = false;
};
          

The name attribute's getter must return the name of the connected database. The attribute MUST return this name even if the close pending flag is set on the connection. In other words, the value of this attribute stays constant for the lifetime of the IDBDatabase instance.

The version attribute's getter must return this connection's version.

The objectStoreNames attribute's getter must return a sorted list of the names of the object stores in this connection's object store set.

The createObjectStore(name, options) method, when invoked, must run these steps:

  1. Let database be the database associated with this connection.
  2. Let transaction be the currently running upgrade transaction associated with database, or throw an InvalidStateError exception if none.
  3. If transaction is not active, throw a TransactionInactiveError exception.
  4. If an object store named name already exists in database throw a ConstraintError exception.
  5. Let keyPath be options's keyPath member if it is not undefined or null, or null otherwise.
  6. If keyPath is not null and is not a valid key path, throw a SyntaxError exception.
  7. Let autoIncrement be set if options's autoIncrement member is true, or unset otherwise.
  8. If autoIncrement is set and keyPath is an empty string or any sequence (empty or otherwise), throw an InvalidAccessError exception.
  9. Let store be a new object store in database. Set the created object store's name to name. If autoIncrement is set, then the created object store uses a key generator. If keyPath is not null, set the created object store's key path to keyPath.
  10. Return a new object store handle associated with store and transaction.

This method creates and returns a new object store with the given name in the connected database. Note that this method must only be called from within an upgrade transaction.

This method synchronously modifies the objectStoreNames property on the IDBDatabase instance on which it was called.

In some implementations it is possible for the implementation to run into problems after queuing a task to create the object store after the createObjectStore() method has returned. For example in implementations where metadata about the newly created object store is inserted into the database asynchronously, or where the implementation might need to ask the user for permission for quota reasons. Such implementations MUST still create and return an IDBObjectStore object, and once the implementation determines that creating the object store has failed, it MUST abort the transaction using the steps for aborting a transaction using the appropriate error. For example if creating the object store failed due to quota reasons, QuotaExceededError MUST be used as error.

The deleteObjectStore(name) method, when invoked, must run these steps:

  1. Let database be the database associated with this connection.
  2. Let transaction be the currently running upgrade transaction associated with database, or throw an InvalidStateError exception if none.
  3. If transaction is not active, throw a TransactionInactiveError exception.
  4. Let store be the object store named name in database, or throw a NotFoundError exception if none.
  5. Remove store from this connection's object store set.
  6. Destroy store.

This method destroys the object store with the given name in the connected database. Note that this method must only be called from within an upgrade transaction.

This method synchronously modifies the objectStoreNames property on the IDBDatabase instance on which it was called.

The transaction(storeNames, mode) method, when invoked, must run these steps:

  1. If mode parameter is not "readonly" or "readwrite", throw a TypeError.
  2. If this method is called on IDBDatabase object for which an upgrade transaction is still running, throw an InvalidStateError exception.
  3. If this method is called on an IDBDatabase instance where the close pending flag is set, throw an InvalidStateError exception.
  4. Let scope be the set of unique strings in storeNames if it is a sequence, or a set containing one string equal to storeNames otherwise.
  5. If any string in scope is not the name of an object store in the connected database, throw a NotFoundError exception.
  6. If scope is empty, throw an InvalidAccessError exception.
  7. Let transaction be a new transaction with connection, mode and the set of object stores named in scope.
  8. When control is returned to the event loop, the implementation MUST unset the active flag.
  9. Return an IDBTransaction object representing transaction.

The close() method, when invoked, must run these steps:

  1. Run the steps for closing a database connection with this connection.

The onabort attribute is the event handler for the abort event.

The onclose attribute is the event handler for the close event.

The onerror attribute is the event handler for the error event.

The onversionchange attribute is the event handler for the versionchange event.

The IDBObjectStore interface

The IDBObjectStore interface represents an object store handle.

[Exposed=(Window,Worker)]
interface IDBObjectStore {
                attribute DOMString      name;
    readonly    attribute any            keyPath;
    readonly    attribute DOMStringList  indexNames;
    readonly    attribute IDBTransaction transaction;
    readonly    attribute boolean        autoIncrement;

    IDBRequest put(any value, optional any key);
    IDBRequest add(any value, optional any key);
    IDBRequest delete(any query);
    IDBRequest clear();
    IDBRequest get(any query);
    IDBRequest getAll(optional any query, [EnforceRange] optional unsigned long count);
    IDBRequest getAllKeys(optional any query, [EnforceRange] optional unsigned long count);
    IDBRequest count(optional any query);

    IDBRequest openCursor(optional any query, optional IDBCursorDirection direction = "next");
    IDBRequest openKeyCursor(optional any query, optional IDBCursorDirection direction = "next");

    IDBIndex   index(DOMString name);

    IDBIndex   createIndex(DOMString name, (DOMString or sequence<DOMString>) keyPath, optional IDBIndexParameters options);
    void       deleteIndex(DOMString indexName);
};

dictionary IDBIndexParameters {
    boolean unique = false;
    boolean multiEntry = false;
};
          

The name attribute's getter must return this object store handle's object store's name.

The name attribute's setter must run these steps:

  1. Let name be the given value.
  2. Let transaction be this object store handle's transaction.
  3. Let store be this object store handle's object store.
  4. If store has been deleted, throw an InvalidStateError exception.
  5. If transaction is not an upgrade transaction, throw an InvalidStateError exception.
  6. If transaction is not active, throw a TransactionInactiveError exception.
  7. If store's name is equal to name, terminate these steps.
  8. If an object store named name already exists in store's database, throw a ConstraintError exception.
  9. Set store's name to name.
  10. Set this object store handle's name to name.

The keyPath attribute's getter must return this object store handle's object store's key path, or null if none.

The conversion is done following the normal [[!WEBIDL]] binding logic for DOMString and sequence<DOMString> values, as appropriate.

The returned value is not the same instance that was used when the object store was created. However, if this attribute returns an object (specifically an Array), it returns the same object instance every time it is inspected. Changing the properties of the object has no effect on the object store.

The indexNames attribute's getter must return a sorted list of the names of indexes in this object store handle's index set.

The transaction attribute's getter must return this object store handle's transaction,

The autoIncrement attribute's getter must return true if this object store handle's object store has a key generator, and false otherwise.

The put(value, key) method, when invoked, must run these steps:

  1. Let transaction be this object store handle's transaction.
  2. Let store be this object store handle's object store.
  3. If store has been deleted, throw an InvalidStateError exception.
  4. If transaction is not active, throw a TransactionInactiveError exception.
  5. If transaction is a read-only transaction, throw a ReadOnlyError exception.
  6. If store uses in-line keys and key was given, throw a DataError exception.
  7. If store uses out-of-line keys and has no key generator and key was not given, throw a DataError exception.
  8. If key was given, run these substeps:
    1. Let r be the result of running the steps to convert a value to a key with key. If this throws an exception, rethrow it.
    2. If r is invalid, throw a DataError exception.
    3. Let key be r.
  9. Let clone be structured clone of value. If this throws an exception, rethrow the exception.
  10. If store uses in-line keys, run these substeps:
    1. Let kpk be the result of running the steps to extract a key from a value using a key path with clone and store's key path. If this throws an exception, rethrow it.
    2. If kpk is invalid, throw a DataError exception.
    3. If kpk is not failure, let key be kpk.
    4. Otherwise, if store does not have a key generator, throw a DataError exception.
  11. Run the steps for asynchronously executing a request and return the IDBRequest created by these steps. The steps are run with this object store handle as source and the steps for storing a record into an object store as operation, using store, the clone as value, key, and with the no-overwrite flag unset.

The add(value, key) method, when invoked, must run these steps:

  1. Let transaction be this object store handle's transaction.
  2. Let store be this object store handle's object store.
  3. If store has been deleted, throw an InvalidStateError exception.
  4. If transaction is not active, throw a TransactionInactiveError exception.
  5. If transaction is a read-only transaction, throw a ReadOnlyError exception.
  6. If store uses in-line keys and key was given, throw a DataError exception.
  7. If store uses out-of-line keys and has no key generator and key was not given, throw a DataError exception.
  8. If key was given, run these substeps:
    1. Let r be the result of running the steps to convert a value to a key with key. If this throws an exception, rethrow it.
    2. If r is invalid, throw a DataError exception.
    3. Let key be r.
  9. Let clone be structured clone of value. If this throws an exception, rethrow the exception.
  10. If store uses in-line keys, run these substeps:
    1. Let kpk be the result of running the steps to extract a key from a value using a key path with clone and store's key path. If this throws an exception, rethrow it.
    2. If kpk is invalid, throw a DataError exception.
    3. If kpk is not failure, let key be kpk.
    4. Otherwise, if store does not have a key generator, throw a DataError exception.
  11. Run the steps for asynchronously executing a request and return the IDBRequest created by these steps. The steps are run with this object store handle as source and the steps for storing a record into an object store as operation, using store, clone as value, key, and with the no-overwrite flag set.

The delete(query) method, when invoked, must run these steps:

  1. Let transaction be this object store handle's transaction.
  2. Let store be this object store handle's object store.
  3. If store has been deleted, throw an InvalidStateError exception.
  4. If transaction is not active, throw a TransactionInactiveError exception.
  5. If transaction is a read-only transaction, throw a ReadOnlyError exception.
  6. Let range be the result of running the steps to convert a value to a key range with query and null disallowed flag set. If this throws an exception, rethrow it.
  7. Run the steps for asynchronously executing a request and return the IDBRequest created by these steps. The steps are run with this object store handle as source and the steps for deleting records from an object store as operation, using store and range.

The query parameter may be a key or an IDBKeyRange identifying the records keys to be deleted.

The clear() method, when invoked, must run these steps:

  1. Let transaction be this object store handle's transaction.
  2. Let store be this object store handle's object store.
  3. If store has been deleted, throw an InvalidStateError exception.
  4. If transaction is not active, throw a TransactionInactiveError exception.
  5. If transaction is a read-only transaction, throw a ReadOnlyError exception.
  6. Run the steps for asynchronously executing a request and return the IDBRequest created by these steps. The steps are run with this object store handle as source and the steps for clearing an object store as operation, using store.

The get(query) method, when invoked, must run these steps:

  1. Let transaction be this object store handle's transaction.
  2. Let store be this object store handle's object store.
  3. If store has been deleted, throw an InvalidStateError exception.
  4. If transaction is not active, throw a TransactionInactiveError exception.
  5. Let range be the result of running the steps to convert a value to a key range with query and null disallowed flag set. If this throws an exception, rethrow it.
  6. Run the steps for asynchronously executing a request and return the IDBRequest created by these steps. The steps are run with this object store handle as source and the steps for retrieving a value from an object store as operation, using store and range.

The query parameter may be a key or an IDBKeyRange identifying the record to be retrieved. If a range is specified, the method retrieves the first existing value in that range.

The getAll(query, count) method, when invoked, must run these steps:

  1. Let transaction be this object store handle's transaction.
  2. Let store be this object store handle's object store.
  3. If store has been deleted, throw an InvalidStateError exception.
  4. If transaction is not active, throw a TransactionInactiveError exception.
  5. Let range be the result of running the steps to convert a value to a key range with query. If this throws an exception, rethrow it.
  6. Run the steps for asynchronously executing a request and return the IDBRequest created by these steps. The steps are run with this object store handle as source and the steps for retrieving multiple values from an object store as operation, using store, range, and count if given.

The query parameter may be a key or an IDBKeyRange identifying the records 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:

  1. Let transaction be this object store handle's transaction.
  2. Let store be this object store handle's object store.
  3. If store has been deleted, throw an InvalidStateError exception.
  4. If transaction is not active, throw a TransactionInactiveError exception.
  5. Let range be the result of running the steps to convert a value to a key range with query. If this throws an exception, rethrow it.
  6. Run the steps for asynchronously executing a request and return the IDBRequest created by these steps. The steps are run with this object store handle as source and the steps for retrieving multiple keys from an object store as operation, using store, range, and count if given.

The query parameter may be a key or an IDBKeyRange identifying the records 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:

  1. Let transaction be this object store handle's transaction.
  2. Let store be this object store handle's object store.
  3. If store has been deleted, throw an InvalidStateError exception.
  4. If transaction is not active, throw a TransactionInactiveError exception.
  5. Let range be the result of running the steps to convert a value to a key range with query. If this throws an exception, rethrow it.
  6. Run the steps for asynchronously executing a request and return the IDBRequest created by these steps. The steps are run with this object store handle as source and the steps to count the records in a range as operation, with source and range.

The query parameter may be a key or an IDBKeyRange identifying the records keys to be counted. If null or not given, an unbounded key range is used.

The openCursor(query, direction) method, when invoked, must run these steps:

  1. Let transaction be this object store handle's transaction.
  2. Let store be this object store handle's object store.
  3. If store has been deleted, throw an InvalidStateError exception.
  4. If transaction is not active, throw a TransactionInactiveError exception.
  5. Let range be the result of running the steps to convert a value to a key range with query. If this throws an exception, rethrow it.
  6. Let cursor be a new cursor with transaction set to transaction, an undefined position, direction set to direction, got value flag unset, and undefined key and value. The source of cursor is store. The range of cursor is range.
  7. Run the steps for asynchronously executing a request and return the IDBRequest created by these steps. The steps are run with this object store handle as source and the steps for iterating a cursor with cursor as operation.

The query parameter may be a key or an IDBKeyRange to use as the cursor's range. If null or not given, an unbounded key range is used.

The openKeyCursor(query, direction) method, when invoked, must run these steps:

  1. Let transaction be this object store handle's transaction.
  2. Let store be this object store handle's object store.
  3. If store has been deleted, throw an InvalidStateError exception.
  4. If transaction is not active, throw a TransactionInactiveError exception.
  5. Let range be the result of running the steps to convert a value to a key range with query. If this throws an exception, rethrow it.
  6. Let cursor be a new cursor with transaction set to transaction, an undefined position, direction set to direction, got value flag unset, and undefined key and value. The source of cursor is store. The range of cursor is range. The key only flag of cursor is set.
  7. Run the steps for asynchronously executing a request and return the IDBRequest created by these steps. The steps are run with this object store handle as source and the steps for iterating a cursor with cursor as operation.

The query parameter may be a key or an IDBKeyRange to use as the cursor's range. If null or not given, an unbounded key range is used.

The createIndex(name, keyPath, options) method, when invoked, must run these steps:

  1. Let transaction be this object store handle's transaction.
  2. Let store be this object store handle's object store.
  3. If transaction is not an upgrade transaction, throw an InvalidStateError exception.
  4. If store has been deleted, throw an InvalidStateError exception.
  5. If transaction is not active, throw a TransactionInactiveError exception.
  6. If an index named name already exists in store, throw a ConstraintError exception.
  7. If keyPath is not a valid key path, throw a SyntaxError exception.
  8. Let unique be set if options's unique member is true, and unset otherwise.
  9. Let multiEntry be set if options's multiEntry member is true, and unset otherwise.
  10. If keyPath is a sequence and multiEntry is set, throw an InvalidAccessError exception.
  11. Let index be a new index in store. Set index's name to name and key path to keyPath. If unique is set, set index's unique flag. If multiEntry is set, set index's multiEntry flag.
  12. Add index to this object store handle's index set.
  13. Return a new index handle associated with index and this object store handle.

This method creates and returns a new index with the given name in the object store. Note that this method must only be called from within an upgrade transaction.

The index that is requested to be created can contain constraints on the data allowed in the index's referenced object store, such as requiring uniqueness of the values referenced by the index's keyPath. If the referenced object store already contains data which violates these constraints, this MUST NOT cause the implementation of createIndex to throw an exception or affect what it returns. The implementation MUST still create and return an IDBIndex object, and the implementation MUST queue a task to abort the upgrade transaction which was used for the createIndex call.

This method synchronously modifies the indexNames property on the IDBObjectStore instance on which it was called. Although this method does not return an IDBRequest object, the index creation itself is processed as an asynchronous request within the upgrade transaction.

In some implementations it is possible for the implementation to asynchronously run into problems creating the index after the createIndex method has returned. For example in implementations where metadata about the newly created index is queued up to be inserted into the database asynchronously, or where the implementation might need to ask the user for permission for quota reasons. Such implementations MUST still create and return an IDBIndex object, and once the implementation determines that creating the index has failed, it MUST abort the transaction using the steps for aborting a transaction using an appropriate error as error. For example if creating the index failed due to quota reasons, QuotaExceededError MUST be used as error and if the index can't be created due to unique flag constraints, ConstraintError MUST be used as error.

The index(name) method, when invoked, must run these steps:

  1. Let transaction be this object store handle's transaction.
  2. Let store be this object store handle's object store.
  3. If store has been deleted, throw an InvalidStateError exception.
  4. If transaction has finished, throw an InvalidStateError exception.
  5. Let index be the index named name in this object store handle's index set if one exists, or throw a NotFoundError exception otherwise.
  6. Return an index handle associated with index and this object store handle.

The deleteIndex(name) method, when invoked, must run these steps:

  1. Let transaction be this object store handle's transaction.
  2. Let store be this object store handle's object store.
  3. If transaction is not an upgrade transaction, throw an InvalidStateError exception.
  4. If store has been deleted, throw an InvalidStateError exception.
  5. If transaction is not active, throw a TransactionInactiveError exception.
  6. Let index be the index named name in store if one exists, or throw a NotFoundError exception otherwise.
  7. Remove index from this object store handle's index set.
  8. Destroy index.

This method destroys the index with the given name in the object store. Note that this method must only be called from within an upgrade transaction.

This method synchronously modifies the indexNames property on the IDBObjectStore instance on which it was called. Although this method does not return an IDBRequest object, the index destruction itself is processed as an asynchronous request within the upgrade transaction.

The IDBIndex interface

The IDBIndex interface represents an index handle.

[Exposed=(Window,Worker)]
interface IDBIndex {
                attribute DOMString      name;
    readonly    attribute IDBObjectStore objectStore;
    readonly    attribute any            keyPath;
    readonly    attribute boolean        multiEntry;
    readonly    attribute boolean        unique;

    IDBRequest get(any query);
    IDBRequest getKey(any query);
    IDBRequest getAll(optional any query, [EnforceRange] optional unsigned long count);
    IDBRequest getAllKeys(optional any query, [EnforceRange] optional unsigned long count);
    IDBRequest count(optional any query);

    IDBRequest openCursor(optional any query, optional IDBCursorDirection direction = "next");
    IDBRequest openKeyCursor(optional any query, optional IDBCursorDirection direction = "next");
};
          

The name attribute's getter must return this index handle's index's name.

The name attribute's setter must run these steps:

  1. Let name be the given value.
  2. Let transaction be this index handle's transaction.
  3. Let index be this index handle's index.
  4. If transaction is not an upgrade transaction, throw an InvalidStateError exception.
  5. If transaction is not active, throw a TransactionInactiveError exception.
  6. If index or index's object store has been deleted, throw an InvalidStateError exception.
  7. If index's name is equal to name, terminate these steps.
  8. If an index named name already exists in index's object store, throw a ConstraintError exception.
  9. Set index's name to name.
  10. Set this index handle's name to name.

The objectStore attribute's getter must return this index handle's object store handle.

The keyPath attribute's getter must return this index handle's index's key path.

The conversion is done following the normal [[!WEBIDL]] binding logic for DOMString and sequence<DOMString> values, as appropriate.

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 Array), 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 true if this index handle's index's multiEntry flag is set, and false otherwise.

The unique attribute's getter must return true if this index handle's index's unique flag is set, and false otherwise.

The get(query) method, when invoked, must run these steps:

  1. Let transaction be this index handle's transaction.
  2. Let index be this index handle's index.
  3. If index or index's object store has been deleted, throw an InvalidStateError exception.
  4. If transaction is not active, throw a TransactionInactiveError exception.
  5. Let range be the result of running the steps to convert a value to a key range with query and null disallowed flag set. If this throws an exception, rethrow it.
  6. Run the steps for asynchronously executing a request and return the IDBRequest created by these steps. The steps are run with this index handle as source and the steps for retrieving a referenced value from an index as operation, using index and range.

The query parameter may be a key or an IDBKeyRange identifying the record to be retrieved. If a range is specified, the method retrieves the first existing record in that range.

The getKey(query) method, when invoked, must run these steps:

  1. Let transaction be this index handle's transaction.
  2. Let index be this index handle's index.
  3. If index or index's object store has been deleted, throw an InvalidStateError exception.
  4. If transaction is not active, throw a TransactionInactiveError exception.
  5. Let range be the result of running the steps to convert a value to a key range with query and null disallowed flag set. If this throws an exception, rethrow it.
  6. Run the steps for asynchronously executing a request and return the IDBRequest created by these steps. The steps are run with this index handle as source and the steps for retrieving a value from an index as operation, using index and range.

The query parameter may be a key or an 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:

  1. Let transaction be this index handle's transaction.
  2. Let index be this index handle's index.
  3. If index or index's object store has been deleted, throw an InvalidStateError exception.
  4. If transaction is not active, throw a TransactionInactiveError exception.
  5. Let range be the result of running the steps to convert a value to a key range with query. If this throws an exception, rethrow it.
  6. Run the steps for asynchronously executing a request and return the IDBRequest created by these steps. The steps are run with this index handle as source and the steps for retrieving multiple referenced values from an index as operation, using index, range, and count if given.

The query parameter may be a key or an IDBKeyRange identifying the records 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:

  1. Let transaction be this index handle's transaction.
  2. Let index be this index handle's index.
  3. If index or index's object store has been deleted, throw an InvalidStateError exception.
  4. If transaction is not active, throw a TransactionInactiveError exception.
  5. Let range be the result of running the steps to convert a value to a key range with query. If this throws an exception, rethrow it.
  6. Run the steps for asynchronously executing a request and return the IDBRequest created by these steps. The steps are run with this index handle as source and the steps for retrieving multiple values from an index as operation, using index, range, and count if given.

The query parameter may be a key or an IDBKeyRange identifying the records 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:

  1. Let transaction be this index handle's transaction.
  2. Let index be this index handle's index.
  3. If index or index's object store has been deleted, throw an InvalidStateError exception.
  4. If transaction is not active, throw a TransactionInactiveError exception.
  5. Let range be the result of running the steps to convert a value to a key range with query. If this throws an exception, rethrow it.
  6. Run the steps for asynchronously executing a request and return the IDBRequest created by these steps. The steps are run with this index handle as source and the steps to count the records in a range as operation, with index as source and range.

The query parameter may be a key or an IDBKeyRange identifying the records keys to be counted. If null or not given, an unbounded key range is used.

The openCursor(query, direction) method, when invoked, must run these steps:

  1. Let transaction be this index handle's transaction.
  2. Let index be this index handle's index.
  3. If index or index's object store has been deleted, throw an InvalidStateError exception.
  4. If transaction is not active, throw a TransactionInactiveError exception.
  5. Let range be the result of running the steps to convert a value to a key range with query. If this throws an exception, rethrow it.
  6. Let cursor be a new cursor with transaction set to transaction, an undefined position, direction set to direction, got value flag unset, and undefined key and value. The source of cursor is index. The range of cursor is range.
  7. Run the steps for asynchronously executing a request and return the IDBRequest created by these steps. The steps are run with this index handle as source and the steps for iterating a cursor with cursor as operation.

The query parameter may be a key or an IDBKeyRange to use as the cursor's range. If null or not given, an unbounded key range is used.

The openKeyCursor(query, direction) method, when invoked, must run these steps:

  1. Let transaction be this index handle's transaction.
  2. Let index be this index handle's index.
  3. If index or index's object store has been deleted, throw an InvalidStateError exception.
  4. If transaction is not active, throw a TransactionInactiveError exception.
  5. Let range be the result of running the steps to convert a value to a key range with query. If this throws an exception, rethrow it.
  6. Let cursor be a new cursor with transaction set to transaction, an undefined position, direction set to direction, got value flag unset, and undefined key and value. The source of cursor is index. The range of cursor is range. The key only flag of cursor is set.
  7. Run the steps for asynchronously executing a request and return the IDBRequest created by these steps. The steps are run with this index handle as source and the steps for iterating a cursor with cursor as operation.

The query parameter may be a key or an IDBKeyRange to use as the cursor's range. If null or not given, an unbounded key range is used.

The IDBKeyRange interface

The IDBKeyRange interface represents a key range.

[Exposed=(Window,Worker)]
interface IDBKeyRange {
    readonly    attribute any     lower;
    readonly    attribute any     upper;
    readonly    attribute boolean lowerOpen;
    readonly    attribute boolean upperOpen;

    // Static construction methods:
    static IDBKeyRange only(any value);
    static IDBKeyRange lowerBound(any lower, optional boolean open = false);
    static IDBKeyRange upperBound(any upper, optional boolean open = false);
    static IDBKeyRange bound(any lower, any upper, optional boolean lowerOpen = false, optional boolean upperOpen = false);
};
          

The lower attribute's getter must return result of running the steps to convert a key to a value with the lower bound if it is not null, or undefined otherwise.

The upper attribute's getter must return the result of running the steps to convert a key to a value with the upper bound if it is not null, or undefined otherwise.

The lowerOpen attribute's getter must return true if the lower open flag is set, and false otherwise.

The upperOpen attribute's getter must return true if the upper open flag is set, and false otherwise.

The only(value) method, when invoked, must run these steps:

  1. Let key be the result of running the steps to convert a value to a key with value. If this throws an an exception, rethrow it.
  2. If key is invalid, throw a DataError exception.
  3. Create and return a new key range containing only key.

The lowerBound(lower, lowerOpen) method, when invoked, must run these steps:

  1. Let lowerKey be the result of running the steps to convert a value to a key with lower. If this throws an an exception, rethrow it.
  2. If lowerKey is invalid, throw a DataError exception.
  3. Create and return a new key range with lower bound set to lowerKey, lower open flag set if lowerOpen is true, upper bound set to null and upper open flag set.

The upperBound(upper, upperOpen) method, when invoked, must run these steps:

  1. Let upperKey be the result of running the steps to convert a value to a key with upper. If this throws an an exception, rethrow it.
  2. If upperKey is invalid, throw a DataError exception.
  3. Create and return a new key range with lower bound set to null, lower open flag set, upper bound set if upperKey, and upper open flag set to upperOpen.

The bound(lower, upper, lowerOpen, upperOpen) method, when invoked, must run these steps:

  1. Let lowerKey be the result of running the steps to convert a value to a key with lower. If this throws an an exception, rethrow it.
  2. If lowerKey is invalid, throw a DataError exception.
  3. Let upperKey be the result of running the steps to convert a value to a key with upper. If this throws an an exception, rethrow it.
  4. If upperKey is invalid, throw a DataError exception.
  5. If lowerKey is greater than upperKey, throw a DataError exception.
  6. Create and return a new key range with lower bound set to lowerKey, lower open flag set if lowerOpen is true, upper bound set to upperKey and upper open flag set if upperOpen is true.

The IDBCursor interface

Cursor objects implement the IDBCursor interface. There is only ever one IDBCursor instance representing a given cursor. There is no limit on how many cursors can be used at the same time.

[Exposed=(Window,Worker)]
interface IDBCursor {
    readonly    attribute (IDBObjectStore or IDBIndex) source;
    readonly    attribute IDBCursorDirection           direction;
    readonly    attribute any                          key;
    readonly    attribute any                          primaryKey;

    void       advance([EnforceRange] unsigned long count);
    void       continue(optional any key);
    void       continuePrimaryKey(any key, any primaryKey);

    IDBRequest update(any value);
    IDBRequest delete();
};

enum IDBCursorDirection {
    "next",
    "nextunique",
    "prev",
    "prevunique"
};
          

The source attribute's getter must return the source of this cursor. This attribute never returns null or throws an exception, even if the cursor is currently being iterated, has iterated past its end, or its transaction is not active.

The direction attribute's getter must return the direction of the cursor.

The key attribute's getter must return the result of running the steps to convert a key to a value with the cursor's current key. Note that if this property returns an object (e.g. a Date or Array), it returns the same object instance every time it is inspected, until the cursor's key is changed. This means that if the object is modified, those modifications will be seen by anyone inspecting the value of the cursor. However modifying such an object does not modify the contents of the database.

The primaryKey attribute's getter must return the result of running the steps to convert a key to a value with the cursor's current effective key. Note that if this property returns an object (e.g. a Date or Array), it returns the same object instance every time it is inspected, until the cursor's effective key is changed. This means that if the object is modified, those modifications will be seen by anyone inspecting the value of the cursor. However modifying such an object does not modify the contents of the database.

The update(value) method, when invoked, must run these steps:

  1. Let transaction be this cursor's transaction.
  2. If transaction is not active, throw a TransactionInactiveError exception.
  3. If transaction is a read-only transaction, throw a ReadOnlyError exception.
  4. If the cursor's source or effective object store has been deleted, throw an InvalidStateError exception.
  5. If this cursor's got value flag is unset, indicating that the cursor is being iterated or has iterated past its end, throw an InvalidStateError exception.
  6. If this cursor's key only flag is set, throw an InvalidStateError exception.
  7. Let clone be structured clone of value. If this throws an exception, rethrow the exception.
  8. If the effective object store of this cursor uses in-line keys, run these substeps:
    1. Let kpk be the result of running the steps to extract a key from a value using a key path with clone and the key path of the effective object store. If this throws an exception, rethrow it.
    2. If kpk is failure, invalid, or not equal to the cursor's effective key, throw a DataError exception.
  9. Run steps for asynchronously executing a request and return the IDBRequest created by these steps. The steps are run with this cursor as source and the steps for storing a record into an object store as operation, using this cursor's effective object store as store, the clone as value, this cursor's effective key as key, and with the no-overwrite flag unset.

The advance(count) method, when invoked, must run these steps:

  1. If count is 0 (zero), throw a TypeError.
  2. Let transaction be this cursor's transaction.
  3. If transaction is not active, throw a TransactionInactiveError exception.
  4. If the cursor's source or effective object store has been deleted, throw an InvalidStateError exception.
  5. If this cursor's got value flag is unset, indicating that the cursor is being iterated or has iterated past its end, throw an InvalidStateError exception.
  6. Unset the got value flag on the cursor.
  7. Let request be the request created when this cursor was created.
  8. Unset the done flag on request.
  9. Run the steps for asynchronously executing a request with the cursor's source as source and the steps for iterating a cursor with this cursor and count, and request.

The continue(key) method, when invoked, must run these steps:

  1. Let transaction be this cursor's transaction.
  2. If transaction is not active, throw a TransactionInactiveError exception.
  3. If the cursor's source or effective object store has been deleted, throw an InvalidStateError exception.
  4. If this cursor's got value flag is unset, indicating that the cursor is being iterated or has iterated past its end, throw an InvalidStateError exception.
  5. If key is given, run these substeps:
    1. Let r be the result of running the steps to convert a value to a key with key. If this throws an exception, rethrow it.
    2. If r is invalid, throw a DataError exception.
    3. Let key be r.
    4. If key is less than or equal to this cursor's position and this cursor's direction is "next" or "nextunique", throw a DataError exception.
    5. If key is greater than or equal to this cursor's position and this cursor's direction is "prev" or "prevunique", throw a DataError exception.
  6. Unset the got value flag on the cursor.
  7. Let request be the request created when this cursor was created.
  8. Unset the done flag on request.
  9. Run the steps for asynchronously executing a request with the cursor's source as source and the steps for iterating a cursor with this cursor and key (if given), and request.

The continuePrimaryKey(key, primaryKey) method, when invoked, must run these steps:

  1. Let transaction be this cursor's transaction.
  2. If transaction is not active, throw a TransactionInactiveError exception.
  3. If the cursor's source or effective object store has been deleted, throw an InvalidStateError exception.
  4. If this cursor's source is not an index throw an InvalidAccessError exception.
  5. If this cursor's direction is not "next" or "prev", throw an InvalidAccessError exception.
  6. If this cursor's got value flag is unset, indicating that the cursor is being iterated or has iterated past its end, throw an InvalidStateError exception.
  7. Let r be the result of running the steps to convert a value to a key with key. If this throws an exception, rethrow it.
  8. If r is invalid, throw a DataError exception.
  9. Let key be r.
  10. Let r be the result of running the steps to convert a value to a key with primaryKey. If this throws an exception, rethrow it.
  11. If r is invalid, throw a DataError exception.
  12. Let primaryKey be r.
  13. If key is less than or equal to this cursor's position and this cursor's direction is "next" or "nextunique", throw a DataError exception.
  14. If key is greater than or equal to this cursor's position and this cursor's direction is "prev" or "prevunique", throw a DataError exception.
  15. If key is equal to this cursor's position and primaryKey is less than or equal to this cursor's object store position and this cursor's direction is "next" or "nextunique", throw a DataError exception.
  16. If key is equal to this cursor's position and primaryKey is greater than or equal to this cursor's object store position and this cursor's direction is "prev" or "prevunique", throw a DataError exception.
  17. Unset the got value flag on the cursor.
  18. Let request be the request created when this cursor was created.
  19. Unset the done flag on request.
  20. Run the steps for asynchronously executing a request with the cursor's source as source and the steps for iterating a cursor with this cursor, key, primaryKey, and request.

The delete() method, when invoked, must run these steps:

  1. Let transaction be this cursor's transaction.
  2. If transaction is not active, throw a TransactionInactiveError exception.
  3. If transaction is a read-only transaction, throw a ReadOnlyError exception.
  4. If the cursor's source or effective object store has been deleted, throw an InvalidStateError exception.
  5. If this cursor's got value flag is unset, indicating that the cursor is being iterated or has iterated past its end, throw an InvalidStateError exception.
  6. If this cursor's key only flag is set, throw an InvalidStateError exception.
  7. Run the steps for asynchronously executing a request and return the IDBRequest created by these steps. The steps are run with this cursor as source and the steps for deleting records from an object store as operation, using this cursor's effective object store and effective key as store and key respectively.

A cursor that has the key only flag unset implements the IDBCursorWithValue interface as well.

[Exposed=(Window,Worker)]
interface IDBCursorWithValue : IDBCursor {
    readonly    attribute any value;
};
          

The value attribute's getter must return the cursor's current value. Note that if this property returns an object, it returns the same object instance every time it is inspected, until the cursor's value is changed. This means that if the object is modified, those modifications will be seen by anyone inspecting the value of the cursor. However modifying such an object does not modify the contents of the database.

The IDBTransaction interface

Transaction objects implement the following interface:

[Exposed=(Window,Worker)]
interface IDBTransaction : EventTarget {
    readonly    attribute DOMStringList      objectStoreNames;
    readonly    attribute IDBTransactionMode mode;
    readonly    attribute IDBDatabase        db;
    readonly    attribute DOMException       error;

    IDBObjectStore objectStore(DOMString name);
    void           abort();

    // Event handlers:
                attribute EventHandler       onabort;
                attribute EventHandler       oncomplete;
                attribute EventHandler       onerror;
};

enum IDBTransactionMode {
    "readonly",
    "readwrite",
    "versionchange"
};
          

The objectStoreNames attribute's getter must run the following steps:

  1. If this transaction is an upgrade transaction, return a sorted list of the names of the object stores in this transaction's connection's object store set.
  2. Otherwise, return a sorted list of the names of the object stores in this transaction's scope.

The mode attribute's getter must return the mode of the transaction.

The db attribute's getter must return the database connection of which this transaction is a part.

The error attribute's getter must return this transaction's error, or null if none.

The objectStore(name) method, when invoked, must run these steps:

  1. If transaction has finished, throw an InvalidStateError exception.
  2. Let store be the object store named name in this transaction's scope, or throw a NotFoundError exception if none.
  3. Return an object store handle associated with store and this transaction.

The abort() method, when invoked, must run these steps:

  1. If this transaction is finished, throw an InvalidStateError exception.
  2. Unset the transaction's active flag and run the steps for aborting a transaction with null as error.

The onabort attribute is the event handler for the abort event.

The oncomplete attribute is the event handler for the complete event.

The onerror attribute is the event handler for the error event.

Algorithms

Opening a database

The steps for opening a database are defined in the following steps. The algorithm in these steps takes four arguments: the origin which requested the database to be opened, a database name, a database version, and a request.

  1. Let db be the database named name in the origin origin, or null otherwise.
  2. If db is not null, run these substeps:
    1. Wait until the following conditions are all fulfilled:
    2. If db was deleted, let db be null.
  3. If version is undefined, let version be 1 if db is null, or db's version otherwise.
  4. If db is null, let db be a new database with name name, version 0 (zero) as version, and with no object stores.
  5. If db's version is greater than version, abort these steps and return a new VersionError.
  6. Let connection be a new connection to db.
  7. Set connection's version to version.
  8. If db's version is less than version, run these substeps:
    1. Run the steps for running an upgrade transaction using connection, version and request.
    2. If connection was closed, create and return a new AbortError exception and abort these steps.
    3. If the upgrade transaction was aborted, run the steps for closing a database connection with connection, create and return a new AbortError exception and abort these steps.
  9. Return connection.

Closing a database

The steps for closing a database connection are as follows. These steps take two arguments, a connection object, and an optional forced flag.

  1. Set the close pending flag of connection.
  2. If the forced flag is set, then for each transaction created using connection run the steps for aborting a transaction with transaction and newly created AbortError exception.
  3. Wait for all transactions created using connection to complete. Once they are complete, connection is closed.
  4. If the forced flag is set, then fire a close event at connection. The event MUST use the Event interface and have its type set to "close". The event MUST NOT bubble or be cancelable.

Deleting a database

The steps for deleting a database are as follows. The algorithm in these steps takes three arguments: the origin that requested the database to be deleted, a database name, and a request.

  1. Let db be the database with the given name from the origin origin, if one exists. Otherwise, return 0 (zero).
  2. Set db's delete pending flag.
  3. Let openConnections be the set of all connections associated with db.
  4. For each entry in openConnections that does not have its close pending flag set, fire a version change event named versionchange at entry with db's version and null.
  5. If any of the connections in openConnections are still not closed, and request was given, fire a version change event named blocked at request with db's version and null.
  6. Wait until all connections in openConnections are closed and all of their transactions are finished.
  7. Let version be db's version.
  8. Delete db.
  9. Return version.

Steps for committing a transaction

When taking the steps for committing a transaction the implementation MUST execute the following algorithm. This algorithm takes one argument, the transaction to commit.

  1. All the changes made to the database by the transaction are written to the database.
  2. If an error occurs while writing the changes to the database, abort the transaction by following the steps for aborting a transaction with transaction and an appropriate for the error, for example QuotaExceededError or UnknownError.
  3. Queue a task to dispatch an event at transaction. The event must use the Event interface and have its type set to "complete". The event does not bubble and is not cancelable. The propagation path for the event is transaction's connection and then transaction.

Steps for aborting a transaction

When taking the steps for aborting a transaction the implementation MUST execute the following algorithm. This algorithm takes two arguments: the transaction to abort, and error.

  1. All the changes made to the database by the transaction are reverted. For upgrade transactions this includes changes to the set of object stores and indexes, as well as the change to the version. Also run the steps for aborting an upgrade transaction which reverts changes to all connection and object store handle instances.
  2. If error is not null, set transaction's error to error.
  3. For each request in transaction's request list with done flag unset, abort the steps for asynchronously executing a request for request and queue a task to run these substeps:
    1. Set the done flag on request.
    2. Set the result of request to undefined.
    3. Set the error of request to a newly created AbortError exception.
    4. Dispatch an event at request. The event must use the Event interface and have its type set to "error". The event bubbles and is cancelable. The propagation path for the event is transaction's connection, then transaction and finally the request. There is no default action for the event.
  4. Queue a task to dispatch an event at transaction. The event must use the Event interface and have its type set to "abort". The event does bubble but is not cancelable. The propagation path for the event is transaction's connection and then transaction.

Steps for asynchronously executing a request

When taking the steps for asynchronously executing a request the implementation MUST run the following algorithm. The algorithm takes a source object and an operation to perform on a database, and an optional request.

These steps can be aborted at any point if the transaction the created request belongs to is aborted using the steps for aborting a transaction

  1. Let transaction be the transaction associated with source.
  2. If transaction is not active throw a TransactionInactiveError exception.
  3. If request was not given, let request be a new request with source as source
  4. Add request to the end of transaction's request list.
  5. Return request and queue up the execution of the remaining steps in this algorithm.
  6. Wait until all previously added requests in transaction have their done flag set.
  7. Let result be the result of performing operation.
  8. If result is an error, then revert all changes made by operation, set the done flag on request, set result of request to undefined and set the error on request to result. Finally fire an error event at request.
  9. Otherwise, set the done flag on the request, set result of request to result set the error of request to undefined. Finally fire a success event at request.

Upgrade transaction steps

The steps for running an upgrade transaction are as follows. This algorithm takes three arguments: a connection object which is used to update the database, a new version to be set for the database, and a request.

  1. Let openConnections be the set of all connections, except connection, connected to the same database as connection.
  2. For each entry in openConnections that does not have its close pending flag set, fire a version change event named versionchange at entry with db's version and version.
  3. If any of the connections in openConnections are still not closed, fire a version change event named blocked at request with db's version and version.
  4. Wait until all connections in openConnections are closed and all of their transactions are finished.
  5. Let transaction be a new upgrade transaction with connection used as connection. The scope of transaction includes every object store in connection.
  6. Unset transaction's active flag.
  7. Start transaction. Note that until this transaction is finished, no other connections can be opened to the same database.
  8. Let old version be database's version.
  9. Set the version of database to version. This change is considered part of the transaction, and so if the transaction is aborted, this change is reverted.
  10. Queue a task to run the following steps:
    1. Set request's result to connection.
    2. Set request's transaction to transaction.
    3. Set the done flag on the request.
    4. Fire a version change event named upgradeneeded at request with old version and version.
    5. If an exception was propagated out from any event handler while dispatching the event in the previous step, abort the transaction by following the steps for aborting a transaction with the error property set to a newly created AbortError exception.
  11. Execute transaction.
  12. If transaction is aborted for any reason, the steps for aborting a transaction MUST be run.
  13. When transaction is finished, immediately set request's transaction to null. This MUST be done in the same task as the task firing the complete or abort event, but after those events has been fired.

Steps for aborting an upgrade transaction

The steps for aborting an upgrade transaction transaction are as follows.

  1. Let connection be transaction's connection.
  2. Let database be connection's database.
  3. Set connection's version to database's version if database previously existed, or 0 (zero) if database was newly created
  4. Set connection's object store set to the set of object stores in database if database previously existed, or the empty set if database was newly created.
  5. For each object store handle handle associated with transaction, including handles for object stores that were deleted during transaction, run these substeps:
    1. Set handle's name to its object store's name.
    2. Set handle's index set to the set of indexes that reference its object store.
  6. For each index handle handle associated with transaction, including handles for indexes that were deleted during transaction, run these substeps:
    1. Set handle's name to its index's name.

Fire a success event

To fire a success event at a request, the implementation MUST run the following steps:

  1. Set transaction to the transaction associated with the source.
  2. Set the active flag of transaction.
  3. Dispatch an event at request. The event must use the Event interface and have its type set to "success". The event does not bubble and is not cancelable. The propagation path for the event is the transaction's connection, then transaction and finally request.
  4. Unset the active flag of transaction.
  5. If an exception was propagated out from any event handler while dispatching the event in step 3, abort the transaction by following the steps for aborting a transaction with transaction and a newly created AbortError exception.

Fire an error event

To fire an error event at a request, the implementation MUST run the following steps:

  1. Set transaction to the transaction associated with the source.
  2. Set the active flag of transaction.
  3. Dispatch an event at request. The event must use the Event interface and have its type set to "error". The event bubbles and is cancelable. The propagation path for the event is the transaction's connection, then transaction and finally request. The event's default action is to abort the transaction by running the steps for aborting a transaction using transaction and request's error. However the default action is not taken if any of the event handlers threw an exception.
  4. Unset the active flag of transaction.
  5. If an exception was propagated out from any event handler while dispatching the event in step 3, abort the transaction by following the steps for aborting a transaction with transaction and a newly created AbortError exception. This is done even if the error event is not canceled.

Database operations

This section describes various operations done on the data in object stores and indexes in a database. These operations are run by the steps for asynchronously executing a request.

Object Store Storage Operation

The steps for storing a record into an object store with store, value, an optional key, and a no-overwrite flag are as follows.

  1. If store uses in-line keys, run these substeps:
    1. Let kpk be the result of running the steps to extract a key from a value using a key path with value and store's key path.
    2. Assert: kpk will not be invalid or an exception.
    3. If kpk is not failure, let key be kpk.
  2. If store uses a key generator, run these substeps:
    1. If key is undefined, run these substeps:
      1. If the key generator's current number is greater than 253 (9007199254740992), then this operation failed with a ConstraintError. Abort this algorithm without taking any further steps.
      2. Set key to the key generator's current number
      3. Increase the key generator's current number by 1.
      4. If store also uses in-line keys, then run the steps to inject a key into a value using a key path with value, key and store's key path.
    2. Otherwise, if the type of key is number and the value is greater than or equal to the key generator's current number, set the current number to lowest integer greater than key.
  3. If the no-overwrite flag was given to these steps and is set, and a record already exists in store with its key equal to key, then this operation failed with a ConstraintError. Abort this algorithm without taking any further steps.
  4. If a record already exists in store with its key equal to key, then remove the record from store using the steps for deleting records from an object store.
  5. Store a record in store containing key as its key and object as its value. The record is stored in the object store's list such that the list is sorted according key of the records in ascending order.
  6. For each index which reference store, run these substeps:
    1. Let index key be the result of running the steps to extract a key from a value using a key path with value, index's key path, and index's multiEntry flag.
    2. If index key is an exception, or invalid, or failure, take no further actions for this index, and continue these substeps for the next index.
    3. If index's multiEntry flag is unset, or if index key is not an array key, and if index already contains a record with key equal to index key, and index has its unique flag set, then this operation failed with a ConstraintError. Abort this algorithm without taking any further steps.
    4. If index's multiEntry flag is set and index key is an array key, and if index already contains a record with key equal to any of the subkeys of index key, and index has its unique flag set, then this operation failed with a ConstraintError. Abort this algorithm without taking any further steps.
    5. If index's multiEntry flag is unset, or if index key is not an array key then store a record in index containing index key as its key and key as its value. The record is stored in index's list of records such that the list is sorted primarily on the records keys, and secondarily on the records values, in ascending order.
    6. If index's multiEntry flag is set and index key is an array key, then for each subkey of the subkeys of index key store a record in index containing subkey as its key and key as its value. The records are stored in index's list of records such that the list is sorted primarily on the records keys, and secondarily on the records values, in ascending order.
  7. Return key.

Object Store Retrieval Operations

The steps for retrieving a value from an object store with store and range are as follows:

  1. Let record be the first record in store's list of records whose key is in range, if any.
  2. If record was not found, return undefined.
  3. Return a structured clone of record's value.

The steps for retrieving multiple values from an object store with store, range and optional count are as follows:

  1. If count is not given or is 0 (zero), let count be infinity.
  2. Let records be a list containing the first count records in store's list of records whose key is in range.
  3. Let array be a new Array object.
  4. Let index be 0.
  5. For each record in records, run these substeps:
    1. Let entry be a structured clone of record's value.
    2. Let status be CreateDataProperty(array, index, entry).
    3. Assert: status is true.
    4. Increase index by 1.
  6. Return array

The steps for retrieving multiple keys from an object store with store, range and optional count are as follows:

  1. If count is not given or is 0 (zero), let count be infinity.
  2. Let records be a list containing the first count records in store's list of records whose key is in range.
  3. Let array be a new Array object.
  4. Let index be 0.
  5. For each record in records, run these substeps:
    1. Let entry be the result of running the steps to convert a key to a value with record's key.
    2. Let status be CreateDataProperty(array, index, entry).
    3. Assert: status is true.
    4. Increase index by 1.
  6. Return array

Index Retrieval Operations

The steps for retrieving a referenced value from an index with index and range are as follows.

  1. Let record be the first record in index's list of records whose key is in range, if any.
  2. If record was not found, return undefined.
  3. Return a structured clone of record's referenced value.

The steps for retrieving multiple referenced values from an index with index, range and optional count are as follows:

  1. If count is not given or is 0 (zero), let count be infinity.
  2. Let records be a list containing the first count records in index's list of records whose key is in range.
  3. Let array be a new Array object.
  4. Let index be 0.
  5. For each record in records, run these substeps:
    1. Let entry be a structured clone of record's referenced value.
    2. Let status be CreateDataProperty(array, index, entry).
    3. Assert: status is true.
    4. Increase index by 1.
  6. Return array

The steps for retrieving a value from an index with index and range are as follows.

  1. Let record be the first record in index's list of records whose key is in range, if any.
  2. If record was not found, return undefined.
  3. Return record's value.

The steps for retrieving multiple values from an index with index, range and optional count are as follows:

  1. If count is not given or is 0 (zero), let count be infinity.
  2. Let records be a list containing the first count records in index's list of records whose key is in range.
  3. Let array be a new Array object.
  4. Let index be 0.
  5. For each record in records, run these substeps:
    1. Let entry be the result of running the steps to convert a key to a value with record's value.
    2. Let status be CreateDataProperty(array, index, entry).
    3. Assert: status is true.
    4. Increase index by 1.
  6. Return array

Object Store Deletion Operation

The steps for deleting records from an object store with store and range are as follows.

  1. Remove all records, if any, from store's list of records with key in range.
  2. For each index which references store, remove every record from index's list of records whose value is in range, if any such records exist.
  3. Return undefined.

Record Counting Operation

The steps to count the records in a range with source and range are as follows:

  1. Let count be the number of records, if any, in source's list of records with key in range.
  2. Return count.

Object Store Clear Operation

The steps for clearing an object store with store are as follows.

  1. Remove all records from store.
  2. In all indexes which reference store, remove all records.
  3. Return undefined.

Cursor Iteration Operation

The steps for iterating a cursor with cursor, an optional key and primaryKey to iterate to, and an optional count are as follows.

  1. Let source be cursor's source.
  2. Let direction be cursor's direction.
  3. Assert: if primaryKey is given, source is an index and direction is "next" or "prev".
  4. Let records be the list of records in source.
  5. Let range be cursor's range.
  6. Let position be cursor's position.
  7. Let object store position be cursor's object store position.
  8. If count is not given, let count be 1.
  9. While count is greater than 0, run these substeps:
    1. Switch on direction:
      "next"
      Let found record be the first record in records which satisfy all of the following requirements:
      "nextunique"
      Let found record be the first record in records which satisfy all of the following requirements:
      "prev"
      Let found record be the last record in records which satisfy all of the following requirements:
      • If key is defined, the record's key is less than or equal to key.
      • If primaryKey is defined, the record's key is equal to key and the record's value is less than or equal to primaryKey, or the record's key is less than key.
      • If position is defined, and source is an object store, the record's key is less than position.
      • If position is defined, and source is an index, the record's key is equal to position and the record's value is less than object store position or the record's key is less than position.
      • The record's key is in range.
      "prevunique"
      Let temp record be the last record in records which satisfy all of the following requirements:
      • If key is defined, the record's key is less than or equal to key.
      • If position is defined, the record's key is less than position.
      • The record's key is in range.
      If temp record is defined, let found record be the first record in records whose key is equal to temp record's key.
    2. If found record is not defined, run these substeps:
      1. Set cursor's key to undefined.
      2. If source is an index, set cursor's object store position to undefined.
      3. If cursor's key only flag is unset, set cursor's value to undefined.
      4. Return null.
    3. Let position be found record's key.
    4. If source is an index, let object store position be found record's value.
    5. Decrease count by 1.
  10. Set cursor's position to position.
  11. If source is an index, set cursor's object store position to object store position.
  12. Set cursor's key to found record's key.
  13. If cursor's key only flag is unset, set cursor's value to a structured clone of found record's referenced value.
  14. Set cursor's got value flag.
  15. Return cursor.

ECMAScript binding

This section defines how key values defined in this specification are converted to and from ECMAScript values, and how they may be extracted from and injected into ECMAScript values using key paths. This section references types and algorithms from the ECMAScript Language Specification. [[!ECMA-262]]

Steps to extract a key from a value using a key path

The steps to extract a key from a value using a key path with value, keyPath and an optional multiEntry flag are as follows. The result of these steps is a key, invalid, or failure, or the steps may throw an exception.

  1. Let r be the result of running the steps to evaluate a key path on a value with value and keyPath. If this throws an exception, rethrow it.
  2. If r is failure, return failure.
  3. Let key be the result of running the steps to convert a value to a key with r if the multiEntry flag is unset, and the result of running the steps to convert a value to a multiEntry key with r otherwise. If this throws an exception, rethrow it.
  4. If key is invalid, return invalid.
  5. Return key.

The steps to evaluate a key path on a value with value and keyPath are as follows. The result of these steps is an ECMAScript value or failure, or the steps may throw an exception.

  1. If keyPath is a sequence<DOMString>, run these substeps:
    1. Let result be a new Array ECMAScript object.
    2. For each item in the keyPath sequence, run these substeps:
      1. Let key be the result of recursively running the steps to extract a key from a value using a key path using item as keyPath and value as value.
      2. ReturnIfAbrupt(key)
      3. If key is failure, abort the overall algorithm and return failure.
      4. Append the result of the first sub-step to end of result.
    3. Return result.
  2. If keyPath is the empty string, return value and skip the remaining steps.
  3. Let identifiers be the result of strictly splitting the string keyPath on U+002E FULL STOP characters (.).
  4. For each identifier in identifiers, run these substeps:
    1. If Type(value) is String, and identifier is the last item in identifiers, and identifier is "length", return a Number equal to the number of elements in value.
    2. If Type(value) is not Object, return failure.
    3. Let value be value.[[Get]](identifier, value)
    4. ReturnIfAbrupt(value)
    5. If value is Undefined, return failure.
  5. Return value.

Steps to inject a key into a value using a key path

The steps to inject a key into a value using a key path are as follows. The algorithm takes a value, a key and a keyPath.

  1. Let identifiers be the result of strictly splitting the string keyPath on U+002E FULL STOP characters (.).
  2. Assert: identifiers is not empty.
  3. Let last be the last member of identifiers and remove it from the list.
  4. For each remaining identifier in identifiers, run these substeps:
    1. If value is not an Object object or an Array object (see structured clone algorithm [[!HTML5]]), then throw a DataError exception.
    2. Let hop be HasOwnProperty(value, identifier)
    3. ReturnIfAbrupt(hop)
    4. If hop is false, run these substeps:
      1. Let o be a new Object.
      2. Let status be CreateDataProperty(value, identifier, o)
      3. Assert: status is true
    5. Let value be value[[Get]](identifier, value)
    6. Assert: value is not an abrupt completion.
  5. Assert: value is an Object or an Array.
  6. Let keyValue be the result of running the steps to convert a key to a value.
  7. Let status be CreateDataProperty(value, identifier, keyValue)
  8. Assert: status is true

Steps to convert a key to a value

The steps to convert a key to a value are as follows. These steps take one argument, key, and return an ECMAScript value.

  1. Let type be key's type.
  2. Let value be key's value.
  3. Switch on type:
    number
    Return an ECMAScript Number value equal to value
    string
    Return an ECMAScript String value equal to value
    date
    1. Let date be the result of executing the ECMAScript Date constructor with the single argument value
    2. Assert: date is not an abrupt completion.
    3. Return date
    binary
    1. Let len be the length of value.
    2. Let buffer be the result of executing the ECMAScript ArrayBuffer constructor with len.
    3. Assert: buffer is not an abrupt completion.
    4. Set the entries in buffer's [[ArrayBufferData]] internal slot to the entries in value.
    5. Return buffer
    array
    1. Let array be the result of executing the ECMAScript Array constructor with no arguments.
    2. Assert: array is not an abrupt completion.
    3. Let len be the length of value.
    4. Let index be 0.
    5. While index is less than len, run these substeps:
      1. Let entry be the result of running the steps to convert a key to a value with the indexth entry of value as input.
      2. Let status be CreateDataProperty(array, index, entry).
      3. Assert: status is true.
      4. Increase index by 1.
    6. Return array

Steps to convert a value to a key

The steps to convert a value to a key are as follows. These steps take two arguments, an ECMAScript value input, and an optional set seen. The result of these steps is a key or invalid, or the steps may throw an exception.

  1. If seen was not given, let seen be a new empty set
  2. If input is in seen return invalid
  3. Jump to the appropriate step below:
    If Type(input) is Number
    1. If input is NaN then return invalid.
    2. Otherwise, return a new key with type number and value input
    If input has an [[DateValue]] internal slot
    1. Let ms be the value of input's [[DateValue]] internal slot.
    2. If ms is NaN then return invalid.
    3. Otherwise, return type date and value ms.
    If Type(input) is String
    1. Return type string and value input.
    If input has an [[ArrayBufferData]] internal slot or an [[ViewedArrayBuffer]] internal slot
    1. Let octets be the result of running the steps for getting a copy of the bytes held by a buffer source with value. If this throws an exception, rethrow it.
    2. Return type binary and value octets.
    If IsArray(input)
    1. Let len be the ToLength(Get(input, "length"))
    2. Assert: len will never an abrupt completion.
    3. Add input to seen
    4. Let keys be a new empty list
    5. Let index be 0
    6. While index is less than len, run these substeps:
      1. Let entry be input.[[Get]](index, input)
      2. ReturnIfAbrupt(entry)
      3. Let key be the result of running the steps to convert a value to a key with arguments entry and seen
      4. ReturnIfAbrupt(key)
      5. If key is invalid or an exception, then abort these steps and return key.
      6. Append key to keys
      7. Increase index by 1
    7. Return a new array key with value keys.
    Otherwise
    Return invalid

The steps to convert a value to a multiEntry key are as follows. These steps take one argument, an ECMAScript value input. The result of these steps is a key or invalid, or the steps may throw an exception.

  1. If IsArray(input), then:
    1. Let len be the ToLength(Get(input, "length")).
    2. Assert: len will never an abrupt completion.
    3. Let seen be a new set containing only input.
    4. Let keys be a new empty set.
    5. Let index be 0.
    6. While index is less than len, run these substeps:
      1. Let entry be input.[[Get]](index, input)
      2. If entry is not an exception, run these substeps:
        1. Let key be the result of running the steps to convert a value to a key with arguments entry and seen
        2. If key is not invalid or an exception, add key to keys if there are no other members of keys equal to key
      3. Increase index by 1
    7. Return a new array key with value set to a list of the members of keys.
  2. Otherwise, return the result of running the steps to convert a value to a key with argument input.

Privacy

User tracking

A third-party host (or any object capable of getting content distributed to multiple sites) could use a unique identifier stored in its client-side database to track a user across multiple sessions, building a profile of the user's activities. In conjunction with a site that is aware of the user's real id object (for example an e-commerce site that requires authenticated credentials), this could allow oppressive groups to target individuals with greater accuracy than in a world with purely anonymous Web usage.

There are a number of techniques that can be used to mitigate the risk of user tracking:

Blocking third-party storage
User agents MAY restrict access to the database objects to scripts originating at the domain of the top-level document of the browsing context, for instance denying access to the API for pages from other domains running in iframes.
Expiring stored data

User agents MAY automatically delete stored data after a period of time.

This can restrict the ability of a site to track a user, as the site would then only be able to track the user across multiple sessions when she authenticates with the site itself (e.g. by making a purchase or logging in to a service).

However, this also puts the user's data at risk.

Treating persistent storage as cookies

User agents should present the database feature to the user in a way that associates them strongly with HTTP session cookies. [[COOKIES]]

This might encourage users to view such storage with healthy suspicion.

Site-specific white-listing of access to databases

User agents MAY require the user to authorize access to databases before a site can use the feature.

Origin-tracking of stored data

User agents MAY record the origins of sites that contained content from third-party origins that caused data to be stored.

If this information is then used to present the view of data currently in persistent storage, it would allow the user to make informed decisions about which parts of the persistent storage to prune. Combined with a blacklist ("delete this data and prevent this domain from ever storing data again"), the user can restrict the use of persistent storage to sites that she trusts.

Shared blacklists

User agents MAY allow users to share their persistent storage domain blacklists.

This would allow communities to act together to protect their privacy.

While these suggestions prevent trivial use of this API for user tracking, they do not block it altogether. Within a single domain, a site can continue to track the user during a session, and can then pass all this information to the third party along with any identifying information (names, credit card numbers, addresses) obtained by the site. If a third party cooperates with multiple sites to obtain such information, a profile can still be created.

However, user tracking is to some extent possible even with no cooperation from the user agent whatsoever, for instance by using session identifiers in URLs, a technique already commonly used for innocuous purposes but easily repurposed for user tracking (even retroactively). This information can then be shared with other sites, using using visitors' IP addresses and other user-specific data (e.g. user-agent headers and configuration settings) to combine separate sessions into coherent user profiles.

Sensitivity of data

User agents should treat persistently stored data as potentially sensitive; it is quite possible for e-mails, calendar appointments, health records, or other confidential documents to be stored in this mechanism.

To this end, user agents should ensure that when deleting data, it is promptly deleted from the underlying storage.

Authorization

DNS spoofing attacks

Because of the potential for DNS spoofing attacks, one cannot guarantee that a host claiming to be in a certain domain really is from that domain. To mitigate this, pages can use SSL. Pages using SSL can be sure that only pages using SSL that have certificates identifying them as being from the same domain can access their databases.

Cross-directory attacks

Different authors sharing one host name, for example users hosting content on geocities.com, all share one set of databases.

There is no feature to restrict the access by pathname. Authors on shared hosts are therefore recommended to avoid using these features, as it would be trivial for other authors to read the data and overwrite it.

Implementation risks

The two primary risks when implementing these persistent storage features are letting hostile sites read information from other domains, and letting hostile sites write information that is then read from other domains.

Letting third-party sites read data that is not supposed to be read from their domain causes information leakage, For example, a user's shopping wish list on one domain could be used by another domain for targeted advertising; or a user's work-in-progress confidential documents stored by a word-processing site could be examined by the site of a competing company.

Letting third-party sites write data to the persistent storage of other domains can result in information spoofing, which is equally dangerous. For example, a hostile site could add records to a user's wish list; or a hostile site could set a user's session identifier to a known ID that the hostile site can then use to track the user's actions on the victim site.

Thus, strictly following the origin model described in this specification is important for user security.

Requirements

Requirements will be written with an aim to verify that these were actually met by the API specified in this document.

Revision History

The following is an informative summary of the changes since the last publication of this specification. A complete revision history can be found here. For the revision history of the First Edition, see that document's Revision History.

Acknowledgements

Special thanks to Nikunj Mehta, the original author of the first edition, and Jonas Sicking, Eliot Graff, Andrei Popescu, and Jeremy Orlow, additional editors of the First Edition.

Garret Swart was extremely influential in the design of this specification.

Special thanks to Chris Anderson, Pablo Castro, Kristof Degrave, Jake Drew, Ben Dilts, João Eiras, Alec Flett, Dana Florescu, David Grogan, Israel Hilerio, Kyle Huey, Laxminarayan G Kamath A, Anne van Kesteren, Adam Klein, Tobie Langel, Kang-Hao Lu, Andrea Marchesini, Glenn Maynard, Ms2ger, Odin Omdal, Danillo Paiva, Olli Pettay, Simon Pieters, Yonathan Randolph, Arun Ranganathan, Margo Seltzer, Maciej Stachowiak, Ben Turner, Kyaw Tun, Hans Wennborg, Shawn Wilsher, Boris Zbarsky, Zhiqiang Zhang, and Kris Zyp, all of whose feedback and suggestions have led to improvements to this specification.