Liking cljdoc? Tell your friends :D

web.storage.IDBDatabase

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.

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.
raw docstring

closecljs

(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

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`
sourceraw docstring

create-object-storecljs

(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

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`
sourceraw docstring

delete-object-storecljs

(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

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`
sourceraw docstring

namecljs

(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

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`
sourceraw docstring

object-store-namescljs

(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

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`
sourceraw docstring

onabortcljs

(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

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`
sourceraw docstring

onclosecljs

(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

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`
sourceraw docstring

onerrorcljs

(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

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`
sourceraw docstring

onversionchangecljs

(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

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`
sourceraw docstring

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

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`
sourceraw docstring

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

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`
sourceraw docstring

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

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`
sourceraw docstring

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

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`
sourceraw docstring

transactioncljs

(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

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`
sourceraw docstring

versioncljs

(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

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`
sourceraw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close