Interface IDBObjectStore

Readonly autoIncrement

Readonly indexNames

Readonly keyPath

name

Readonly transaction

add

• add(value, key?): IDBRequest<IDBValidKey>

• 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

  • value: any

  • Optional key: IDBValidKey

  Returns IDBRequest<IDBValidKey>

clear

• clear(): IDBRequest<undefined>

• Deletes all records in store.

  If successful, request's result will be undefined.

  MDN Reference

  Returns IDBRequest<undefined>

count

• count(query?): IDBRequest<number>

• 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

  • Optional query: IDBValidKey | IDBKeyRange

  Returns IDBRequest<number>

createIndex

• createIndex(name, keyPath, options?): IDBIndex

• 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

  • name: string

  • keyPath: string | string[]

  • Optional options: IDBIndexParameters

  Returns IDBIndex
• createIndex(name, keyPath, options?): IDBIndex

• 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

  • name: string

  • keyPath: string | Iterable<string>

  • Optional options: IDBIndexParameters

  Returns IDBIndex

delete

• delete(query): IDBRequest<undefined>

• 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

  • query: IDBValidKey | IDBKeyRange

  Returns IDBRequest<undefined>

deleteIndex

• deleteIndex(name): void

• 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

• get(query): IDBRequest<any>

• 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

  • query: IDBValidKey | IDBKeyRange

  Returns IDBRequest<any>

getAll

• getAll(query?, count?): IDBRequest<any[]>

• 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

  • Optional query: IDBValidKey | IDBKeyRange

  • Optional count: number

  Returns IDBRequest<any[]>

getAllKeys

• getAllKeys(query?, count?): IDBRequest<IDBValidKey[]>

• 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

  • Optional query: IDBValidKey | IDBKeyRange

  • Optional count: number

  Returns IDBRequest<IDBValidKey[]>

getKey

• getKey(query): IDBRequest<IDBValidKey>

• 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

  • query: IDBValidKey | IDBKeyRange

  Returns IDBRequest<IDBValidKey>

index

• index(name): IDBIndex

• MDN Reference

  Parameters

  • name: string

  Returns IDBIndex

openCursor

• openCursor(query?, direction?): IDBRequest<IDBCursorWithValue>

• 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

  • Optional query: IDBValidKey | IDBKeyRange

  • Optional direction: IDBCursorDirection

  Returns IDBRequest<IDBCursorWithValue>

openKeyCursor

• openKeyCursor(query?, direction?): IDBRequest<IDBCursor>

• 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

  • Optional query: IDBValidKey | IDBKeyRange

  • Optional direction: IDBCursorDirection

  Returns IDBRequest<IDBCursor>

put

• put(value, key?): IDBRequest<IDBValidKey>

• 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

  • value: any

  • Optional key: IDBValidKey

  Returns IDBRequest<IDBValidKey>