WebDatabase class

Experimental drift backend for the web. To use this platform, you need to include the latest version of sql.js in your html.

Inheritance
Available extensions

Constructors

WebDatabase(String name, {bool logStatements = false, CreateWebDatabase? initializer, WebSetup? setup, bool readIntsAsBigInt = false})
A database executor that works on the web.
WebDatabase.withStorage(DriftWebStorage storage, {bool logStatements = false, CreateWebDatabase? initializer, WebSetup? setup, bool readIntsAsBigInt = false})
A database executor that works on the web.

Properties

delegate DatabaseDelegate
The DatabaseDelegate to send queries to.
finalinherited
dialect SqlDialect
The SqlDialect to use for this database engine.
no setterinherited
hashCode int
The hash code for this object.
no setterinherited
impl QueryDelegate
no setterinherited
isSequential bool
finalinherited
logStatements bool
getter/setter pairinherited
readIntsAsBigInt bool
Whether sql.js should report integers as BigInt.
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited

Methods

beginExclusive() QueryExecutor
Returns a new QueryExecutor that, when first opened, takes an exclusive lock over this executor and prevents queries from running until it is closed.
inherited
beginTransaction() TransactionExecutor
Starts a TransactionExecutor.
inherited
beginTransactionInContext(_BaseExecutor context) TransactionExecutor
inherited
close() Future<void>
Closes this database connection and releases all resources associated with it. Implementations should also handle close calls in a state where the database isn't open.
inherited
ensureOpen(QueryExecutorUser user) Future<bool>
Opens the executor, if it has not yet been opened.
inherited
interceptWith(QueryInterceptor interceptor) QueryExecutor

Available on QueryExecutor, provided by the ApplyInterceptor extension

Returns a QueryExecutor that will use this executor internally, but with calls intercepted by the given interceptor.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
runBatched(BatchedStatements statements) Future<void>
Prepares and runs statements.
inherited
runCustom(String statement, [List<Object?>? args]) Future<void>
Runs a custom SQL statement without any variables. The result of that statement will be ignored.
inherited
runDelete(String statement, List<Object?> args) Future<int>
Runs an delete statement and returns how many rows where affected.
inherited
runInsert(String statement, List<Object?> args) Future<int>
Runs an insert statement with the given variables. Returns the row id or the auto_increment id of the inserted row.
inherited
runSelect(String statement, List<Object?> args) Future<List<Map<String, Object?>>>
Runs a select statement with the given variables and returns the raw results.
inherited
runUpdate(String statement, List<Object?> args) Future<int>
Runs an update statement with the given variables and returns how many rows where affected.
inherited
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited