Chrome DevTools Protocol

Methods

IndexedDB.clearObjectStore

Clears all entries from an object store.

parameters
securityOrigin
string

At least and at most one of securityOrigin, storageKey, or storageBucket must be specified. Security origin.

storageKey
string

Storage key.

storageBucket
Storage.StorageBucket

Storage bucket. If not specified, it uses the default bucket.

databaseName
string

Database name.

objectStoreName
string

Object store name.

IndexedDB.deleteDatabase

Deletes a database.

parameters
securityOrigin
string

At least and at most one of securityOrigin, storageKey, or storageBucket must be specified. Security origin.

storageKey
string

Storage key.

storageBucket
Storage.StorageBucket

Storage bucket. If not specified, it uses the default bucket.

databaseName
string

Database name.

IndexedDB.deleteObjectStoreEntries

Delete a range of entries from an object store

parameters
securityOrigin
string

At least and at most one of securityOrigin, storageKey, or storageBucket must be specified. Security origin.

storageKey
string

Storage key.

storageBucket
Storage.StorageBucket

Storage bucket. If not specified, it uses the default bucket.

databaseName
string
objectStoreName
string
keyRange
KeyRange

Range of entry keys to delete

IndexedDB.disable

Disables events from backend.

IndexedDB.enable

Enables events from backend.

IndexedDB.getMetadata

Gets metadata of an object store.

parameters
securityOrigin
string

At least and at most one of securityOrigin, storageKey, or storageBucket must be specified. Security origin.

storageKey
string

Storage key.

storageBucket
Storage.StorageBucket

Storage bucket. If not specified, it uses the default bucket.

databaseName
string

Database name.

objectStoreName
string

Object store name.

Return Object
entriesCount
number

the entries count

keyGeneratorValue
number

the current value of key generator, to become the next inserted key into the object store. Valid if objectStore.autoIncrement is true.

IndexedDB.requestData

Requests data from object store or index.

parameters
securityOrigin
string

At least and at most one of securityOrigin, storageKey, or storageBucket must be specified. Security origin.

storageKey
string

Storage key.

storageBucket
Storage.StorageBucket

Storage bucket. If not specified, it uses the default bucket.

databaseName
string

Database name.

objectStoreName
string

Object store name.

indexName
string

Index name, empty string for object store data requests.

skipCount
integer

Number of records to skip.

pageSize
integer

Number of records to fetch.

keyRange
KeyRange

Key range.

Return Object
objectStoreDataEntries
array[ DataEntry ]

Array of object store data entries.

hasMore
boolean

If true, there are more entries to fetch in the given range.

IndexedDB.requestDatabase

Requests database with given name in given frame.

parameters
securityOrigin
string

At least and at most one of securityOrigin, storageKey, or storageBucket must be specified. Security origin.

storageKey
string

Storage key.

storageBucket
Storage.StorageBucket

Storage bucket. If not specified, it uses the default bucket.

databaseName
string

Database name.

Return Object
databaseWithObjectStores
DatabaseWithObjectStores

Database with an array of object stores.

IndexedDB.requestDatabaseNames

Requests database names for given security origin.

parameters
securityOrigin
string

At least and at most one of securityOrigin, storageKey, or storageBucket must be specified. Security origin.

storageKey
string

Storage key.

storageBucket
Storage.StorageBucket

Storage bucket. If not specified, it uses the default bucket.

Return Object
databaseNames
array[ string ]

Database names for origin.

Types

IndexedDB.DatabaseWithObjectStores

Database with an array of object stores.

Type: object

properties
name
string

Database name.

version
number

Database version (type is not 'integer', as the standard requires the version number to be 'unsigned long long')

objectStores
array[ ObjectStore ]

Object stores in this database.

IndexedDB.DataEntry

Data entry.

Type: object

properties
key
Runtime.RemoteObject

Key object.

primaryKey
Runtime.RemoteObject

Primary key object.

value
Runtime.RemoteObject

Value object.

IndexedDB.Key

Key.

Type: object

properties
type
string

Key type.

Allowed Values: number, string, date, array
number
number

Number value.

string
string

String value.

date
number

Date value.

array
array[ Key ]

Array value.

IndexedDB.KeyPath

Key path.

Type: object

properties
type
string

Key path type.

Allowed Values: null, string, array
string
string

String value.

array
array[ string ]

Array value.

IndexedDB.KeyRange

Key range.

Type: object

properties
lower
Key

Lower bound.

upper
Key

Upper bound.

lowerOpen
boolean

If true lower bound is open.

upperOpen
boolean

If true upper bound is open.

IndexedDB.ObjectStore

Object store.

Type: object

properties
name
string

Object store name.

keyPath
KeyPath

Object store key path.

autoIncrement
boolean

If true, object store has auto increment flag set.

indexes
array[ ObjectStoreIndex ]

Indexes in this object store.

IndexedDB.ObjectStoreIndex

Object store index.

Type: object

properties
name
string

Index name.

keyPath
KeyPath

Index key path.

unique
boolean

If true, index is unique.

multiEntry
boolean

If true, index allows multiple entries for a key.