Interface IDBDatabase

This IndexedDB API interface provides a connection to a database; you can use an IDBDatabase object to open a transaction on your database then create, manipulate, and delete objects (data) in that database. The interface provides the only way to get and manage versions of the database.

MDN Reference

interface IDBDatabase {
    name: string;
    objectStoreNames: DOMStringList;
    onabort: null | (this: IDBDatabase, ev: Event) => any;
    onclose: null | (this: IDBDatabase, ev: Event) => any;
    onerror: null | (this: IDBDatabase, ev: Event) => any;
    onversionchange:
        | null
        | (this: IDBDatabase, ev: IDBVersionChangeEvent) => any;
    version: number;
    addEventListener<K extends keyof IDBDatabaseEventMap>(
        type: K,
        listener: (this: IDBDatabase, ev: IDBDatabaseEventMap[K]) => any,
        options?: boolean | AddEventListenerOptions,
    ): void;
    addEventListener(
        type: string,
        listener: EventListenerOrEventListenerObject,
        options?: boolean | AddEventListenerOptions,
    ): void;
    close(): void;
    createObjectStore(
        name: string,
        options?: IDBObjectStoreParameters,
    ): IDBObjectStore;
    deleteObjectStore(name: string): void;
    dispatchEvent(event: Event): boolean;
    removeEventListener<K extends keyof IDBDatabaseEventMap>(
        type: K,
        listener: (this: IDBDatabase, ev: IDBDatabaseEventMap[K]) => any,
        options?: boolean | EventListenerOptions,
    ): void;
    removeEventListener(
        type: string,
        listener: EventListenerOrEventListenerObject,
        options?: boolean | EventListenerOptions,
    ): void;
    transaction(
        storeNames: string | string[],
        mode?: IDBTransactionMode,
        options?: IDBTransactionOptions,
    ): IDBTransaction;
}

Hierarchy

  • EventTarget
    • IDBDatabase

Properties

name objectStoreNames onabort onclose onerror onversionchange version

Methods

addEventListener close createObjectStore deleteObjectStore dispatchEvent removeEventListener transaction

Properties

Readonlyname

name: string

Returns the name of the database.

MDN Reference

ReadonlyobjectStoreNames

objectStoreNames: DOMStringList

Returns a list of the names of object stores in the database.

MDN Reference

onabort

onabort: null | (this: IDBDatabase, ev: Event) => any

onclose

onclose: null | (this: IDBDatabase, ev: Event) => any

MDN Reference

onerror

onerror: null | (this: IDBDatabase, ev: Event) => any

onversionchange

onversionchange: null | (this: IDBDatabase, ev: IDBVersionChangeEvent) => any

MDN Reference

Readonlyversion

version: number

Returns the version of the database.

MDN Reference

Methods

addEventListener

  • addEventListener<K extends keyof IDBDatabaseEventMap>(
        type: K,
        listener: (this: IDBDatabase, ev: IDBDatabaseEventMap[K]) => any,
        options?: boolean | AddEventListenerOptions,
    ): void

    Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.

    The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.

    When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.

    When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.

    When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.

    If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.

    The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture.

    MDN Reference

    Type Parameters

    Parameters

    Returns void

  • addEventListener(
        type: string,
        listener: EventListenerOrEventListenerObject,
        options?: boolean | AddEventListenerOptions,
    ): void

    Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.

    The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.

    When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.

    When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.

    When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.

    If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.

    The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture.

    MDN Reference

    Parameters

    Returns void

close

  • close(): void

    Closes the connection once all running transactions have finished.

    MDN Reference

    Returns void

createObjectStore

deleteObjectStore

  • deleteObjectStore(name: string): void

    Deletes the object store with the given name.

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

    MDN Reference

    Parameters

    • name: string

    Returns void

dispatchEvent

  • dispatchEvent(event: Event): boolean

    Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

    MDN Reference

    Parameters

    • event: Event

    Returns boolean

removeEventListener

transaction

Settings

Member Visibility

On This Page

Properties
Methods