kotlin-browser/web.idb/IDBDatabase

IDBDatabase

sealed external class IDBDatabase : EventTarget(source)

This IndexedDB API interface 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.

Properties

val abortEvent: EventInstance<Event, IDBDatabase, IDBDatabase>

val closeEvent: EventInstance<Event, IDBDatabase, IDBDatabase>

val errorEvent: EventInstance<Event, IDBDatabase, IDBTransaction>

val name: String

Returns the name of the database.

objectStoreNames

val objectStoreNames: DOMStringList

Returns a list of the names of object stores in the database.

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

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

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

onversionchange

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

val version: JsLong

Returns the version of the database.

versionChangeEvent

val versionChangeEvent: EventInstance<IDBVersionChangeEvent, IDBDatabase, IDBDatabase>

Functions

fun close()

Closes the connection once all running transactions have finished.

createObjectStore

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

Creates a new object store with the given name and options and returns a new IDBObjectStore.

deleteObjectStore

fun deleteObjectStore(name: String)

Deletes the object store with the given name.

fun dispatchEvent(event: Event): Boolean

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

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

Returns a new transaction with the given mode ("readonly" or "readwrite") and scope which can be a single object store name or an array of names.