The IDBDatabase
interface of the IndexedDB API provides a connection to a database; you can use an IDBDatabase
object to open a transaction on your database then create, manipulate, and delete objects (data) in that database. The interface provides the only way to get and manage versions of the database.
Documentation IDBDatabase by Mozilla Contributors, licensed under CC-BY-SA 2.5.
See also:
Variables
read onlyobjectStoreNames:DOMStringList
A DOMStringList
that contains a list of the names of the object stores currently in the connected database.
onclose:Function
Fires when the close
event occurs; this happens when the database is unexpectedly closed, such as during application shutdown.
onversionchange:Function
Fires when a database structure change (IDBOpenDBRequest.onupgradeneeded
event or
IDBFactory.deleteDatabase()
was requested elsewhere (most probably in another window/tab on the same computer). This is different from the version change transaction (see IDBVersionChangeEvent
), but it is related.
Methods
createObjectStore(name:String, ?optionalParameters:Null<ObjectStoreParameters>):ObjectStore
Creates and returns a new object store or index.
Throws:
null | DOMError |
---|
deleteObjectStore(name:String):Void
Destroys the object store with the given name in the connected database, along with any indexes that reference it.
Throws:
null | DOMError |
---|
transaction(storeNames:String, mode:TransactionMode = READONLY):Transaction
transaction(storeNames:Array<String>, mode:TransactionMode = READONLY):Transaction
Immediately returns a transaction object (IDBTransaction
) containing the IDBTransaction.objectStore
method, which you can use to access your object store. Runs in a separate thread.
Throws:
null | DOMError |
---|