IDBDatabase

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.

MDN Reference

Properties

abortEvent

val abortEvent: EventInstance<Event, IDBDatabase, IDBDatabase>

MDN Reference

closeEvent

val closeEvent: EventInstance<Event, IDBDatabase, IDBDatabase>

MDN Reference

errorEvent

val errorEvent: EventInstance<Event, IDBDatabase, IDBTransaction>

MDN Reference

name

val name: String

The name read-only property of the IDBDatabase interface is a string that contains the name of the connected database.

objectStoreNames

val objectStoreNames: DOMStringList

The objectStoreNames read-only property of the list of the names of the object stores currently in the connected database.

onabort

var onabort: EventHandler<Event, IDBDatabase, IDBDatabase>?

onclose

var onclose: EventHandler<Event, IDBDatabase, IDBDatabase>?

MDN Reference

onerror

var onerror: EventHandler<Event, IDBDatabase, IDBTransaction>?

onversionchange

var onversionchange: EventHandler<IDBVersionChangeEvent, IDBDatabase, IDBDatabase>?

MDN Reference

version

val version: UInt53

The version property of the IDBDatabase interface is a 64-bit integer that contains the version of the connected database.

versionChangeEvent

val versionChangeEvent: EventInstance<IDBVersionChangeEvent, IDBDatabase, IDBDatabase>

MDN Reference

Functions

fun close()

The close() method of the IDBDatabase interface returns immediately and closes the connection in a separate thread.

createObjectStore

fun createObjectStore(name: String, options: IDBObjectStoreParameters = definedExternally): IDBObjectStore

The createObjectStore() method of the The method takes the name of the store as well as a parameter object that lets you define important optional properties.

deleteObjectStore

fun deleteObjectStore(name: String)

The deleteObjectStore() method of the the connected database, along with any indexes that reference it.

dispatchEvent

fun dispatchEvent(event: Event): Boolean

transaction

fun transaction( storeNames: ReadonlyArray<JsString>, mode: IDBTransactionMode = definedExternally, options: IDBTransactionOptions = definedExternally): IDBTransaction

fun transaction( storeNames: String, mode: IDBTransactionMode = definedExternally, options: IDBTransactionOptions = definedExternally): IDBTransaction

The transaction method of the IDBDatabase interface immediately returns a transaction object (IDBTransaction) containing the IDBTransaction.objectStore method, which you can use to access your object store.

when

fun <T : Event> when(type: EventType<T>, options: ObservableEventListenerOptions?): Observable<T>