SqliteConnection class abstract interface

Abstract class representing a connection to the SQLite database.

This package typically pools multiple SqliteConnection instances into a managed SqliteDatabase automatically.

Inheritance
Implementers

Constructors

SqliteConnection.synchronousWrapper(CommonDatabase raw, {Mutex? mutex, bool? profileQueries})
Creates a SqliteConnection instance that wraps a raw CommonDatabase from the sqlite3 package.
factory

Properties

closed → bool
Returns true if the connection is closed
no setteroverride
hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
updates → Stream<UpdateNotification>?
Reports table change update notifications
no setter

Methods

close() → Future<void>
computeWithDatabase<T>(Future<T> compute(CommonDatabase db)) → Future<T>
Run a function within a database isolate, with direct synchronous access to the underlying database.
inherited
execute(String sql, [List<Object?> parameters = const []]) → Future<ResultSet>
Execute a write query (INSERT, UPDATE, DELETE) and return the results (if any).
inherited
executeBatch(String sql, List<List<Object?>> parameterSets) → Future<void>
Execute a write query (INSERT, UPDATE, DELETE) multiple times with each parameter set. This is faster than executing separately with each parameter set.
inherited
get(String sql, [List<Object?> parameters = const []]) → Future<Row>
Execute a read-only (SELECT) query and return a single result.
inherited
getAll(String sql, [List<Object?> parameters = const []]) → Future<ResultSet>
Execute a read-only (SELECT) query and return the results.
inherited
getAutoCommit() → Future<bool>
Returns true if auto-commit is enabled. This means the database is not currently in a transaction. This may be true even if a transaction lock is still held, when the transaction has been committed or rolled back.
inherited
getOptional(String sql, [List<Object?> parameters = const []]) → Future<Row?>
Execute a read-only (SELECT) query and return a single optional result.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
readLock<T>(Future<T> callback(SqliteReadContext tx), {Duration? lockTimeout, String? debugContext}) → Future<T>
Takes a read lock, without starting a transaction.
readTransaction<T>(Future<T> callback(SqliteReadContext tx), {Duration? lockTimeout}) → Future<T>
Open a read-only transaction.
refreshSchema() → Future<void>
Ensures that all connections are aware of the latest schema changes applied (if any). Queries and watch calls can potentially use outdated schema information after a schema update.
toString() → String
A string representation of this object.
inherited
watch(String sql, {List<Object?> parameters = const [], Duration throttle = const Duration(milliseconds: 30)}) → Stream<ResultSet>
Execute a read query every time the source tables are modified.
writeLock<T>(Future<T> callback(SqliteWriteContext tx), {Duration? lockTimeout, String? debugContext}) → Future<T>
Takes a global lock, without starting a transaction.
writeTransaction<T>(Future<T> callback(SqliteWriteContext tx), {Duration? lockTimeout}) → Future<T>
Open a read-write transaction.
override

Operators

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