SqliteDatabaseImpl class

Implemented types
Mixed-in types

Constructors

SqliteDatabaseImpl({required dynamic path, int maxReaders = SqliteDatabase.defaultMaxReaders, SqliteOptions options = const SqliteOptions.defaults()})
factory
SqliteDatabaseImpl.withFactory(AbstractDefaultSqliteOpenFactory<CommonDatabase> openFactory, {int maxReaders = SqliteDatabase.defaultMaxReaders})

Properties

closed bool
Returns true if the connection is closed
no setteroverride
hashCode int
The hash code for this object.
no setterinherited
isInitialized Future<void>
no setteroverride
maxReaders int
Maximum number of concurrent read transactions.
getter/setter pairoverride-getter
openFactory AbstractDefaultSqliteOpenFactory<CommonDatabase>
Factory that opens a raw database connection in each isolate.
getter/setter pairoverride-getter
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
updates Stream<UpdateNotification>
Reports table change update notifications
no setteroverride

Methods

close() Future<void>
override
computeWithDatabase<T>(Future<T> compute(CommonDatabase db)) Future<T>
See SqliteReadContext.computeWithDatabase.
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 more 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.
override
getOptional(String sql, [List<Object?> parameters = const []]) Future<Row?>
Execute a read-only (SELECT) query and return a single optional result.
inherited
initialize() Future<void>
Wait for initialization to complete.
inherited
isolateConnectionFactory() IsolateConnectionFactory<CommonDatabase>
A connection factory that can be passed to different isolates.
override
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
onChange(Iterable<String>? tables, {Duration throttle = const Duration(milliseconds: 30), bool triggerImmediately = true}) Stream<UpdateNotification>
Create a Stream of changes to any of the specified tables.
inherited
readLock<T>(Future<T> callback(SqliteReadContext tx), {Duration? lockTimeout, String? debugContext}) Future<T>
Takes a read lock, without starting a transaction.
override
readTransaction<T>(Future<T> callback(SqliteReadContext tx), {Duration? lockTimeout}) Future<T>
Open a read-only transaction.
inherited
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.
inherited
toString() String
A string representation of this object.
inherited
watch(String sql, {List<Object?> parameters = const [], Duration throttle = const Duration(milliseconds: 30), Iterable<String>? triggerOnTables}) Stream<ResultSet>
Execute a read query every time the source tables are modified.
inherited
withAllConnections<T>(Future<T> block(SqliteWriteContext writer, List<SqliteReadContext> readers)) Future<T>
Locks all underlying connections making up this database, and gives block access to all of them at once. This can be useful to run the same statement on all connections. For instance, ATTACHing a database, that is expected to be available in all connections.
override
writeLock<T>(Future<T> callback(SqliteWriteContext tx), {Duration? lockTimeout, String? debugContext}) Future<T>
Takes a global lock, without starting a transaction.
override
writeTransaction<T>(Future<T> callback(SqliteWriteContext tx), {Duration? lockTimeout}) Future<T>
Open a read-write transaction on this write context.
inherited

Operators

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