idb_sqflite library

Classes

Cursor
represents a cursor for traversing or iterating over multiple records in a database.
CursorWithValue
represents a cursor for traversing or iterating over multiple records in a database. It is the same as the Cursor, except that it includes the value property.
Database
provides a connection to a database; you can use an Database 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.
Event
Event abstraction for onBlockedFunction
IdbFactory
Out factory for opening a database instead of using window.indexedDB
Index
provides asynchronous access to an index in a database. An index is a kind of object store for looking up records in another object store, called the referenced object store. You use this interface to retrieve data.
KeyRange
represents a continuous interval over some data type that is used for keys.
ObjectStore
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.
OpenDBRequest
provides access to the results of requests to open or delete databases
Request
provides access to results of asynchronous requests to databases and database objects using event handler attributes. Each reading and writing operation on a database is done using a request.
Transaction
static, asynchronous transaction on a database using event handler attributes. All reading and writing of data is done within transactions. You actually use Database to start transactions and Transaction to set the mode of the transaction (e.g. is it readonly or readwrite), and access an ObjectStore to make a request. You can also use it to abort transactions.
VersionChangeEvent
indicates that the version of the database has changed, as the result of an onupgradeneeded event handler function.

Extensions

IdbFactoryLoggerDebugExt on IdbFactory
Debug extension for Logger.

Constants

idbDirectionNext → const String
Default forward mode for cursor.
idbDirectionPrev → const String
Backward mode for cursor.
idbFactoryNameBrowser → const String
Pseudo - best browser shim (persistent of it not available memory).
idbFactoryNameLogger → const String
Factory name logger (wrapping another factory).
idbFactoryNameMemory → const String
Factory name that could be used to use Sembast Memory implementation.
idbFactoryNameNative → const String
Factory name using native indexeddb implementation.
idbFactoryNamePersistent → const String
Pseudo - best persistent shim (indexeddb).
idbFactoryNameSembastIo → const String
Factory name using Sembast implementation
idbFactoryNameSembastMemory → const String
Factory name using Sembast memory implementation
idbModeReadOnly → const String
Read-only mode for transaction.
idbModeReadWrite → const String
Read-write mode for transaction.
kIdbDartIsWeb → const bool
Borrowed from flutter (isRunningAsJavascript is false in wasm)

Properties

idbFactoryMemory IdbFactory
The in-memory factory
no setter
idbFactoryMemoryFs IdbFactory
Special factory in memory but supporting writing on a virtual file system (in memory too)
no setter
idbFactoryNative IdbFactory
The native factory
no setter
idbFactorySqflite IdbFactory
The idb factory using the default sqflite factory (initialized either using the plugin or manually)
getter/setter pair
idbFactoryWeb IdbFactory
The web factory
no setter
idbFactoryWebSupported bool
no setter

Functions

getIdbFactorySqflite(DatabaseFactory factory) IdbFactory
Build the indexed db factory from a sqflite factory

Typedefs

OnBlockedFunction = void Function(Event event)
OnBlocked function.
OnUpgradeNeededFunction = FutureOr<void> Function(VersionChangeEvent event)
OnUpgrade function.

Exceptions / Errors

DatabaseError
Generic database error.
DatabaseException
Generic database exception.
DatabaseIndexNotFoundError
Index not found.
DatabaseInvalidKeyError
invalid key error.
DatabaseNoKeyError
no key error.
DatabaseReadOnlyError
Read only error.
DatabaseStoreNotFoundError
Store not found error.
DatabaseTransactionStoreNotFoundError
Store not found.