DB Docs
API Reference
- Core API Reference
- Collection
- createCollection
- liveQueryCollectionOptions
- createLiveQueryCollection
- createOptimisticAction
- createTransaction
- Electric DB Collection
- electricCollectionOptions
- Query DB Collection
- queryCollectionOptions
- RxDB DB Collection
- rxdbCollectionOptions
- PowerSync Collection
- powerSyncCollectionOptions
- createIndexedDB
- indexedDBCollectionOptions
- React Hooks
- useLiveQuery
AI/LLM: This documentation page is available in plain markdown format at/db/latest/docs/reference/interfaces/IndexedDBInstance.md
IndexedDBInstance
Defined in: packages/db/src/indexed-db.ts:112
A shared IndexedDB database instance. Create with createIndexedDB() and pass to collections.
Properties#
close()#
ts
close: () => void;Defined in: packages/db/src/indexed-db.ts:124
Close the connection and mark its managed Collections as errored.
Returns#
void
db#
ts
readonly db: IDBDatabase;Defined in: packages/db/src/indexed-db.ts:114
The underlying IDBDatabase connection
idbFactory?#
ts
readonly optional idbFactory: IDBFactory;Defined in: packages/db/src/indexed-db.ts:122
IDBFactory used to create this database (for testing)
name#
ts
readonly name: string;Defined in: packages/db/src/indexed-db.ts:116
Database name
stores#
ts
readonly stores: readonly string[];Defined in: packages/db/src/indexed-db.ts:120
Requested object store names (frozen); omissions do not remove stores
version#
ts
readonly version: number;Defined in: packages/db/src/indexed-db.ts:118
Database version