Interface IDBObjectStore

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

MDN Reference

Hierarchy

  • IDBObjectStore

Properties

autoIncrement indexNames keyPath name transaction

Methods

add clear count createIndex delete deleteIndex get getAll getAllKeys getKey index openCursor openKeyCursor put

Properties

Readonly autoIncrement

autoIncrement: boolean

Returns true if the store has a key generator, and false otherwise.

MDN Reference

Readonly indexNames

indexNames: DOMStringList

Returns a list of the names of indexes in the store.

MDN Reference

Readonly keyPath

keyPath: string | string[]

Returns the key path of the store, or null if none.

MDN Reference

name

name: string

Returns the name of the store.

MDN Reference

Readonly transaction

transaction: IDBTransaction

Returns the associated transaction.

MDN Reference

Methods

add

  • Adds or updates a record in store with the given value and key.

    If the store uses in-line keys and key is specified a "DataError" DOMException will be thrown.

    If put() is used, any existing record with the key will be replaced. If add() is used, and if a record with the key already exists the request will fail, with request's error set to a "ConstraintError" DOMException.

    If successful, request's result will be the record's key.

    MDN Reference

    Parameters

    Returns IDBRequest<IDBValidKey>

clear

  • Deletes all records in store.

    If successful, request's result will be undefined.

    MDN Reference

    Returns IDBRequest<undefined>

count

  • Retrieves the number of records matching the given key or key range in query.

    If successful, request's result will be the count.

    MDN Reference

    Parameters

    Returns IDBRequest<number>

createIndex

  • Creates a new index in store with the given name, keyPath and options and returns a new IDBIndex. If the keyPath and options define constraints that cannot be satisfied with the data already in store the upgrade transaction will abort with a "ConstraintError" DOMException.

    Throws an "InvalidStateError" DOMException if not called within an upgrade transaction.

    MDN Reference

    Parameters

    Returns IDBIndex

delete

  • Deletes records in store with the given key or in the given key range in query.

    If successful, request's result will be undefined.

    MDN Reference

    Parameters

    Returns IDBRequest<undefined>

deleteIndex

  • Deletes the index in store with the given name.

    Throws an "InvalidStateError" DOMException if not called within an upgrade transaction.

    MDN Reference

    Parameters

    • name: string

    Returns void

get

  • Retrieves the value of the first record matching the given key or key range in query.

    If successful, request's result will be the value, or undefined if there was no matching record.

    MDN Reference

    Parameters

    Returns IDBRequest<any>

getAll

  • Retrieves the values of the records matching the given key or key range in query (up to count if given).

    If successful, request's result will be an Array of the values.

    MDN Reference

    Parameters

    Returns IDBRequest<any[]>

getAllKeys

  • Retrieves the keys of records matching the given key or key range in query (up to count if given).

    If successful, request's result will be an Array of the keys.

    MDN Reference

    Parameters

    Returns IDBRequest<IDBValidKey[]>

getKey

  • Retrieves the key of the first record matching the given key or key range in query.

    If successful, request's result will be the key, or undefined if there was no matching record.

    MDN Reference

    Parameters

    Returns IDBRequest<undefined | IDBValidKey>

index

  • MDN Reference

    Parameters

    • name: string

    Returns IDBIndex

openCursor

  • Opens a cursor over the records matching query, ordered by direction. If query is null, all records in store are matched.

    If successful, request's result will be an IDBCursorWithValue pointing at the first matching record, or null if there were no matching records.

    MDN Reference

    Parameters

    Returns IDBRequest<null | IDBCursorWithValue>

openKeyCursor

  • Opens a cursor with key only flag set over the records matching query, ordered by direction. If query is null, all records in store are matched.

    If successful, request's result will be an IDBCursor pointing at the first matching record, or null if there were no matching records.

    MDN Reference

    Parameters

    Returns IDBRequest<null | IDBCursor>

put

  • Adds or updates a record in store with the given value and key.

    If the store uses in-line keys and key is specified a "DataError" DOMException will be thrown.

    If put() is used, any existing record with the key will be replaced. If add() is used, and if a record with the key already exists the request will fail, with request's error set to a "ConstraintError" DOMException.

    If successful, request's result will be the record's key.

    MDN Reference

    Parameters

    Returns IDBRequest<IDBValidKey>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc