Liking cljdoc? Tell your friends :D

web.idb.IDBObjectStore

This example shows a variety of different uses of object stores, updating the data structure with IDBObjectStore.createIndex an onupgradeneeded function, to adding a new item to our object with IDBObjectStore.add. For a full working example, see our Notifications app (view example live.)

This example shows a variety of different uses of object stores,
updating the data structure with `IDBObjectStore.createIndex`
an onupgradeneeded function, to adding a new item to our object
with `IDBObjectStore.add`. For a full working example, see our
Notifications app (view example live.)
raw docstring

addcljs

(add this & args)

Method.

To determine if the add operation has completed successfully, for the transaction’s complete event in addition to the IDBObjectStore.add success event, because the transaction may still fail after the event fires. In other words, the success event is only triggered the transaction has been successfully queued.

var request = objectStore.add(value); var request = objectStore.add(value, key);

See also: https://developer.mozilla.org/en-US/docs/Web/API/IDBObjectStore/add

Method.

To determine if the add operation has completed successfully,
for the transaction’s complete event in addition to the IDBObjectStore.add
success event, because the transaction may still fail after the
event fires. In other words, the success event is only triggered
the transaction has been successfully queued.

`var request = objectStore.add(value);
var request = objectStore.add(value, key);`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/IDBObjectStore/add`
sourceraw docstring

auto-incrementcljs

(auto-increment this)

Property.

A js.Boolean:

var myAutoIncrement = objectStore.autoIncrement;

See also: https://developer.mozilla.org/en-US/docs/Web/API/IDBObjectStore/autoIncrement

Property.

A `js.Boolean`:

`var myAutoIncrement = objectStore.autoIncrement;`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/IDBObjectStore/autoIncrement`
sourceraw docstring

clearcljs

(clear this)

Method.

Clearing an object store consists of removing all records from object store and removing all records in indexes that reference object store. To remove only some of the records in a store, IDBObjectStore.delete passing a key or web.storage.IDBKeyRange.

var request = objectStore.clear();

See also: https://developer.mozilla.org/en-US/docs/Web/API/IDBObjectStore/clear

Method.

Clearing an object store consists of removing all records from
object store and removing all records in indexes that reference
object store. To remove only some of the records in a store,
`IDBObjectStore.delete` passing a key or `web.storage.IDBKeyRange`.

`var request = objectStore.clear();`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/IDBObjectStore/clear`
sourceraw docstring

countcljs

(count this & args)

Method.

An web.storage.IDBRequest object on which subsequent events to this operation are fired.

var request = ObjectStore.count(); var request = ObjectStore.count(query);

See also: https://developer.mozilla.org/en-US/docs/Web/API/IDBObjectStore/count

Method.

An `web.storage.IDBRequest` object on which subsequent events
to this operation are fired.

`var request = ObjectStore.count();
var request = ObjectStore.count(query);`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/IDBObjectStore/count`
sourceraw docstring

create-indexcljs

(create-index this & args)

Method.

Note that this method must be called only from a VersionChange mode callback.

var myIDBIndex = objectStore.createIndex(indexName, keyPath); var myIDBIndex = objectStore.createIndex(indexName, keyPath, objectParameters);

See also: https://developer.mozilla.org/en-US/docs/Web/API/IDBObjectStore/createIndex

Method.

Note that this method must be called only from a VersionChange
mode callback.

`var myIDBIndex = objectStore.createIndex(indexName, keyPath);
var myIDBIndex = objectStore.createIndex(indexName, keyPath, objectParameters);`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/IDBObjectStore/createIndex`
sourceraw docstring

deletecljs

(delete this & args)

Method.

An web.storage.IDBRequest object on which subsequent events to this operation are fired. The request.result attribute is to undefined.

`var request = objectStore.delete(Key);

var request = objectStore.delete(KeyRange);`

See also: https://developer.mozilla.org/en-US/docs/Web/API/IDBObjectStore/delete

Method.

An `web.storage.IDBRequest` object on which subsequent events
to this operation are fired. The request.result attribute is
to undefined.

`var request = objectStore.delete(Key);

var request = objectStore.delete(KeyRange);`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/IDBObjectStore/delete`
sourceraw docstring

delete-indexcljs

(delete-index this index-name)

Method.

Note that this method must be called only from a VersionChange mode callback. Note that this method synchronously modifies the property.

objectStore.deleteIndex(indexName);

See also: https://developer.mozilla.org/en-US/docs/Web/API/IDBObjectStore/deleteIndex

Method.

Note that this method must be called only from a VersionChange
mode callback. Note that this method synchronously modifies the
property.

`objectStore.deleteIndex(indexName);`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/IDBObjectStore/deleteIndex`
sourceraw docstring

getcljs

(get this key)

Method.

If a value is successfully found, then a structured clone of is created and set as the result of the request object.

var request = objectStore.get(key);

See also: https://developer.mozilla.org/en-US/docs/Web/API/IDBObjectStore/get

Method.

If a value is successfully found, then a structured clone of
is created and set as the result of the request object.

`var request = objectStore.get(key);`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/IDBObjectStore/get`
sourceraw docstring

get-allcljs

(get-all this & args)

Method.

If a value is successfully found, then a structured clone of is created and set as the result of the request object.

var request = objectStore.getAll(); var request = objectStore.getAll(query); var request = objectStore.getAll(query, count);

See also: https://developer.mozilla.org/en-US/docs/Web/API/IDBObjectStore/getAll

Method.

If a value is successfully found, then a structured clone of
is created and set as the result of the request object.

`var request = objectStore.getAll();
var request = objectStore.getAll(query);
var request = objectStore.getAll(query, count);`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/IDBObjectStore/getAll`
sourceraw docstring

get-all-keyscljs

(get-all-keys this & args)

Method.

If a value is successfully found, then a structured clone of is created and set as the result of the request object.

var request = objectStore.getAllKeys(); var request = objectStore.getAllKeys(query); var request = objectStore.getAllKeys(query, count);

See also: https://developer.mozilla.org/en-US/docs/Web/API/IDBObjectStore/getAllKeys

Method.

If a value is successfully found, then a structured clone of
is created and set as the result of the request object.

`var request = objectStore.getAllKeys();
var request = objectStore.getAllKeys(query);
var request = objectStore.getAllKeys(query, count);`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/IDBObjectStore/getAllKeys`
sourceraw docstring

get-keycljs

(get-key this key)

Method.

If a key is successfully found, then a structured clone of it created and set as the result of the request object.

var request = objectStore.getKey(key);

See also: https://developer.mozilla.org/en-US/docs/Web/API/IDBObjectStore/getKey

Method.

If a key is successfully found, then a structured clone of it
created and set as the result of the request object.

`var request = objectStore.getKey(key);`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/IDBObjectStore/getKey`
sourceraw docstring

indexcljs

(index this name)

Method.

An web.storage.IDBIndex object for accessing the index.

var index = objectStore.index(name);

See also: https://developer.mozilla.org/en-US/docs/Web/API/IDBObjectStore/index

Method.

An `web.storage.IDBIndex` object for accessing the index.

`var index = objectStore.index(name);`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/IDBObjectStore/index`
sourceraw docstring

index-namescljs

(index-names this)

Property.

A web.dom.DOMStringList.

var myindexNames = objectStore.indexNames;

See also: https://developer.mozilla.org/en-US/docs/Web/API/IDBObjectStore/indexNames

Property.

A `web.dom.DOMStringList`.

`var myindexNames = objectStore.indexNames;`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/IDBObjectStore/indexNames`
sourceraw docstring

key-pathcljs

(key-path this)

Property.

If this property is null, the application must provide a key each modification operation.

var mykeyPath = objectStore.keyPath;

See also: https://developer.mozilla.org/en-US/docs/Web/API/IDBObjectStore/keyPath

Property.

If this property is null, the application must provide a key
each modification operation.

`var mykeyPath = objectStore.keyPath;`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/IDBObjectStore/keyPath`
sourceraw docstring

namecljs

(name this)

Property.

A web.dom.DOMString containing the object store's name.

IDBObjectStore.name = myNewName; var myObjectStoreName = IDBObjectStore.name;

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

Property.

A `web.dom.DOMString` containing the object store's name.

`IDBObjectStore.name = myNewName;
var myObjectStoreName = IDBObjectStore.name;`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/IDBObjectStore/name`
sourceraw docstring

open-cursorcljs

(open-cursor this & args)

Method.

To determine if the add operation has completed successfully, for the results’s success event.

var request = ObjectStore.openCursor(); var request = ObjectStore.openCursor(query); var request = ObjectStore.openCursor(query, direction);

See also: https://developer.mozilla.org/en-US/docs/Web/API/IDBObjectStore/openCursor

Method.

To determine if the add operation has completed successfully,
for the results’s success event.

`var request = ObjectStore.openCursor();
var request = ObjectStore.openCursor(query);
var request = ObjectStore.openCursor(query, direction);`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/IDBObjectStore/openCursor`
sourceraw docstring

open-key-cursorcljs

(open-key-cursor this & args)

Method.

To determine if the add operation has completed successfully, for the results’s success event.

var request = objectStore.openKeyCursor(); var request = objectStore.openKeyCursor(query); var request = objectStore.openKeyCursor(query, direction);

See also: https://developer.mozilla.org/en-US/docs/Web/API/IDBObjectStore/openKeyCursor

Method.

To determine if the add operation has completed successfully,
for the results’s success event.

`var request = objectStore.openKeyCursor();
var request = objectStore.openKeyCursor(query);
var request = objectStore.openKeyCursor(query, direction);`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/IDBObjectStore/openKeyCursor`
sourceraw docstring

putcljs

(put this & args)

Method.

The put method is an update or insert method. See the IDBObjectStore.add for an insert only method.

var request = objectStore.put(item); var request = objectStore.put(item, key);

See also: https://developer.mozilla.org/en-US/docs/Web/API/IDBObjectStore/put

Method.

The put method is an update or insert method. See the `IDBObjectStore.add`
for an insert only method.

`var request = objectStore.put(item);
var request = objectStore.put(item, key);`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/IDBObjectStore/put`
sourceraw docstring

set-auto-increment!cljs

(set-auto-increment! this val)

Property.

A js.Boolean:

var myAutoIncrement = objectStore.autoIncrement;

See also: https://developer.mozilla.org/en-US/docs/Web/API/IDBObjectStore/autoIncrement

Property.

A `js.Boolean`:

`var myAutoIncrement = objectStore.autoIncrement;`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/IDBObjectStore/autoIncrement`
sourceraw docstring

set-index-names!cljs

(set-index-names! this val)

Property.

A web.dom.DOMStringList.

var myindexNames = objectStore.indexNames;

See also: https://developer.mozilla.org/en-US/docs/Web/API/IDBObjectStore/indexNames

Property.

A `web.dom.DOMStringList`.

`var myindexNames = objectStore.indexNames;`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/IDBObjectStore/indexNames`
sourceraw docstring

set-key-path!cljs

(set-key-path! this val)

Property.

If this property is null, the application must provide a key each modification operation.

var mykeyPath = objectStore.keyPath;

See also: https://developer.mozilla.org/en-US/docs/Web/API/IDBObjectStore/keyPath

Property.

If this property is null, the application must provide a key
each modification operation.

`var mykeyPath = objectStore.keyPath;`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/IDBObjectStore/keyPath`
sourceraw docstring

set-name!cljs

(set-name! this val)

Property.

A web.dom.DOMString containing the object store's name.

IDBObjectStore.name = myNewName; var myObjectStoreName = IDBObjectStore.name;

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

Property.

A `web.dom.DOMString` containing the object store's name.

`IDBObjectStore.name = myNewName;
var myObjectStoreName = IDBObjectStore.name;`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/IDBObjectStore/name`
sourceraw docstring

set-transaction!cljs

(set-transaction! this val)

Property.

An web.storage.IDBTransaction object.

var myTransaction = objectStore.transaction;

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

Property.

An `web.storage.IDBTransaction` object.

`var myTransaction = objectStore.transaction;`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/IDBObjectStore/transaction`
sourceraw docstring

transactioncljs

(transaction this)

Property.

An web.storage.IDBTransaction object.

var myTransaction = objectStore.transaction;

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

Property.

An `web.storage.IDBTransaction` object.

`var myTransaction = objectStore.transaction;`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/IDBObjectStore/transaction`
sourceraw docstring

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

× close