Interface IDBObjectStore

The IDBObjectStore interface of the IndexedDB API represents an object store in a database. Records within an object store are sorted according to their keys. This sorting enables fast insertion, look-up, and ordered retrieval.

MDN Reference

interface IDBObjectStore {
    autoIncrement: boolean;
    indexNames: DOMStringList;
    keyPath: string | string[] | null;
    name: string;
    transaction: IDBTransaction;
    add(value: any, key?: IDBValidKey): IDBRequest<IDBValidKey>;
    clear(): IDBRequest<undefined>;
    count(query?: IDBValidKey | IDBKeyRange): IDBRequest<number>;
    createIndex(
        name: string,
        keyPath: string | string[],
        options?: IDBIndexParameters,
    ): IDBIndex;
    createIndex(
        name: string,
        keyPath: string | Iterable<string, any, any>,
        options?: IDBIndexParameters,
    ): IDBIndex;
    delete(query: IDBValidKey | IDBKeyRange): IDBRequest<undefined>;
    deleteIndex(name: string): void;
    get(query: IDBValidKey | IDBKeyRange): IDBRequest<any>;
    getAll(
        queryOrOptions?: IDBValidKey | IDBKeyRange | null,
        count?: number,
    ): IDBRequest<any[]>;
    getAllKeys(
        queryOrOptions?: IDBValidKey | IDBKeyRange | null,
        count?: number,
    ): IDBRequest<IDBValidKey[]>;
    getKey(
        query: IDBValidKey | IDBKeyRange,
    ): IDBRequest<IDBValidKey | undefined>;
    index(name: string): IDBIndex;
    openCursor(
        query?: IDBValidKey | IDBKeyRange | null,
        direction?: IDBCursorDirection,
    ): IDBRequest<IDBCursorWithValue | null>;
    openKeyCursor(
        query?: IDBValidKey | IDBKeyRange | null,
        direction?: IDBCursorDirection,
    ): IDBRequest<IDBCursor | null>;
    put(value: any, key?: IDBValidKey): IDBRequest<IDBValidKey>;
}
Index
autoIncrement indexNames keyPath name transaction
add clear count createIndex delete deleteIndex get getAll getAllKeys getKey index openCursor openKeyCursor put
autoIncrement: boolean

The autoIncrement read-only property of the IDBObjectStore interface returns the value of the auto increment flag for this object store.

MDN Reference

indexNames: DOMStringList

The indexNames read-only property of the IDBObjectStore interface returns a list of the names of indexes on objects in this object store.

MDN Reference

keyPath: string | string[] | null

The keyPath read-only property of the IDBObjectStore interface returns the key path of this object store.

MDN Reference

name: string

The name property of the IDBObjectStore interface indicates the name of this object store.

MDN Reference

transaction: IDBTransaction

The transaction read-only property of the IDBObjectStore interface returns the transaction object to which this object store belongs.

MDN Reference

  • The add() method of the IDBObjectStore interface returns an IDBRequest object, and, in a separate thread, creates a structured clone of the value, and stores the cloned value in the object store. This is for adding new records to an object store.

    MDN Reference

    Parameters

    Returns IDBRequest<IDBValidKey>

  • The clear() method of the IDBObjectStore interface creates and immediately returns an IDBRequest object, and clears this object store in a separate thread. This is for deleting all the current data out of an object store.

    MDN Reference

    Returns IDBRequest<undefined>

  • The count() method of the IDBObjectStore interface returns an IDBRequest object, and, in a separate thread, returns the total number of records that match the provided key or IDBKeyRange. If no arguments are provided, it returns the total number of records in the store.

    MDN Reference

    Parameters

    Returns IDBRequest<number>

  • The createIndex() method of the IDBObjectStore interface creates and returns a new IDBIndex object in the connected database. It creates a new field/column defining a new data point for each database record to contain.

    MDN Reference

    Parameters

    Returns IDBIndex

  • The createIndex() method of the IDBObjectStore interface creates and returns a new IDBIndex object in the connected database. It creates a new field/column defining a new data point for each database record to contain.

    MDN Reference

    Parameters

    Returns IDBIndex

  • The deleteIndex() method of the IDBObjectStore interface destroys the index with the specified name in the connected database, used during a version upgrade.

    MDN Reference

    Parameters

    • name: string

    Returns void

  • The getAll() method of the IDBObjectStore interface returns an IDBRequest object containing all objects in the object store matching the specified parameter or all objects in the store if no parameters are given.

    MDN Reference

    Parameters

    Returns IDBRequest<any[]>

  • The index() method of the IDBObjectStore interface opens a named index in the current object store, after which it can be used to, for example, return a series of records sorted by that index using a cursor.

    MDN Reference

    Parameters

    • name: string

    Returns IDBIndex

Was this helpful?