web.storage.IDBDatabase — clojure-interop/cljs-web-api 1.0.9

The IDBDatabase interface of the IndexedDB API provides a connection a database; you can use an IDBDatabase object to open a transaction your database then create, manipulate, and delete objects (data) that database. The interface provides the only way to get and versions of the database.

close cljs

(close this)

Method.

The connection is not actually closed until all transactions using this connection are complete. No new transactions can be for this connection once this method is called. Methods that transactions throw an exception if a closing operation is pending.

IDBDatabase.close();

See also: https://developer.mozilla.org/en-US/docs/Web/API/IDBDatabase/close

create-object-store cljs

(create-object-store this & args)

Method.

The method takes the name of the store as well as a parameter that lets you define important optional properties. You can use property to uniquely identify individual objects in the store. the property is an identifier, it should be unique to every object, every object should have that property.

IDBDatabase.createObjectStore(name); IDBDatabase.createObjectStore(name, options);

See also: https://developer.mozilla.org/en-US/docs/Web/API/IDBDatabase/createObjectStore

delete-object-store cljs

(delete-object-store this name)

Method.

As with IDBDatabase.createObjectStore, this method can be called within a versionchange transaction.

dbInstance.deleteObjectStore(name);

See also: https://developer.mozilla.org/en-US/docs/Web/API/IDBDatabase/deleteObjectStore

name cljs

(name this)

Property.

[Read Only]

A web.dom.DOMString containing the name of the connected database.

var dbName = IDBDatabase.name;

See also: https://developer.mozilla.org/en-US/docs/Web/API/IDBDatabase/name

object-store-names cljs

(object-store-names this)

Property.

[Read Only]

A web.dom.DOMStringList containing a list of the names of the stores currently in the connected database.

var list[] = IDBDatabase.objectStoreNames;

See also: https://developer.mozilla.org/en-US/docs/Web/API/IDBDatabase/objectStoreNames

onabort cljs

(onabort this)

Property.

The onabort event handler of the web.storage.IDBDatabase interface the abort event, fired when a transaction is aborted and bubbles to the connection object.

IDBDatabase.onabort = function(event) { ... };

See also: https://developer.mozilla.org/en-US/docs/Web/API/IDBDatabase/onabort

onclose cljs

(onclose this)

Property.

A function which is called when the close event is fired.

IDBDatabase.onclose = function(event) { ... };

See also: https://developer.mozilla.org/en-US/docs/Web/API/IDBDatabase/onclose

onerror cljs

(onerror this)

Property.

The onerror event handler of the web.storage.IDBDatabase interface the error event, fired when a request returns an error and bubbles to the connection object.

IDBDatabase.onerror = function(event) { ... }

See also: https://developer.mozilla.org/en-US/docs/Web/API/IDBDatabase/onerror

onversionchange cljs

(onversionchange this)

Property.

This example shows an IDBOpenDBRequest.onupgradeneeded block creates a new object store; it also includes onerror and onabort to handle non-success cases, and an onversionchange function notify when a database structure change has occurred.

IDBDatabase.onversionchange = function(event) { ... }

See also: https://developer.mozilla.org/en-US/docs/Web/API/IDBDatabase/onversionchange

set-onabort! cljs

(set-onabort! this val)

Property.

The onabort event handler of the web.storage.IDBDatabase interface the abort event, fired when a transaction is aborted and bubbles to the connection object.

IDBDatabase.onabort = function(event) { ... };

See also: https://developer.mozilla.org/en-US/docs/Web/API/IDBDatabase/onabort

set-onclose! cljs

(set-onclose! this val)

Property.

A function which is called when the close event is fired.

IDBDatabase.onclose = function(event) { ... };

See also: https://developer.mozilla.org/en-US/docs/Web/API/IDBDatabase/onclose

set-onerror! cljs

(set-onerror! this val)

Property.

The onerror event handler of the web.storage.IDBDatabase interface the error event, fired when a request returns an error and bubbles to the connection object.

IDBDatabase.onerror = function(event) { ... }

See also: https://developer.mozilla.org/en-US/docs/Web/API/IDBDatabase/onerror

set-onversionchange! cljs

(set-onversionchange! this val)

Property.

This example shows an IDBOpenDBRequest.onupgradeneeded block creates a new object store; it also includes onerror and onabort to handle non-success cases, and an onversionchange function notify when a database structure change has occurred.

IDBDatabase.onversionchange = function(event) { ... }

See also: https://developer.mozilla.org/en-US/docs/Web/API/IDBDatabase/onversionchange

transaction cljs

(transaction this & args)

Method.

An web.storage.IDBTransaction object.

IDBDatabase.transaction(storeNames); IDBDatabase.transaction(storeNames, mode);

See also: https://developer.mozilla.org/en-US/docs/Web/API/IDBDatabase/transaction

version cljs

(version this)

Property.

[Read Only]

An integer containing the version of the connected database.

var myInteger = IDBDatabase.version;

See also: https://developer.mozilla.org/en-US/docs/Web/API/IDBDatabase/version