Database class final

Inheritance
Available extensions

Properties

future → Future<void>?
no setterinherited
hashCode → int
The hash code for this object.
no setterinherited
initialised → bool
no setterinherited
metaTable → DbTable
no setterinherited
onBeforeMigration ↔ Future<void> Function(SqlliteDatabase db)?
getter/setter pairinherited
path → String?
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
schema ↔ Schema
getter/setter pairinherited
tableChangeStream → Stream<Table>
Returns a stream of any table change
no setterinherited
tableDeleteStream → Stream<TableDelete>
no setterinherited
tableInsertStream → Stream<TableInsert>
no setterinherited
tables ↔ Map<String, DbTable>
getter/setter pairinherited
tableUpdateStream → Stream<TableUpdate>
no setterinherited
user → DbTableWithConverter<int, UserCache>

Available on SqlliteDatabase, provided by the UserDatabase extension

no setter

Methods

addTable(Table table) → Future<void>
inherited
backup() → Future<void>
Creates .bak version of this db
inherited
batch(void executor(Batch batch)) → Future<List<Object?>>
inherited
clone(String newPath) → Future<void>
inherited
close() → Future<void>
inherited
delete(Table table, Query query) → Future<int>
Returns number of rows affected
inherited
deleteDatabase() → Future<void>
inherited
execute(String sql) → Future<void>
inherited
executeBuilder(StatementBuilder builder(StatementBuilder builder)) → Future<void>
inherited
getRawBatch() → Batch
inherited
getTable<Key>(String name) → DbTable<Key>
inherited
getTableWithConverter<Key, Value>(String name, Converter<Value> converter) → DbTableWithConverter<Key, Value>
inherited
init() → Future<void>

Available on SqlliteDatabase, provided by the UserDatabase extension

insert<KeyType>(Table<KeyType> table, Map<String, Object?> values, {ConflictAlgorithm conflictAlgorithm = ConflictAlgorithm.abort}) → Future<KeyType>
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
open(Schema schema, {String dbPath = 'default.db', bool nukeDb = false, Future<void> onBeforeMigration(SqlliteDatabase db)?}) → Future<void>
inherited
query(Table table, Query query) → Future<List<Map<String, Object?>>>
inherited
rawQuery(String query) → Future<List<Map<String, Object?>>>
inherited
toString() → String
A string representation of this object.
inherited
update(Table table, Map<String, Object?> values, Query query) → Future<int>
Convenience method for updating rows in the database. Returns the number of changes made
inherited
watchQuery(Table table, Query query) → Stream<List<Map<String, Object?>>>
inherited
watchUpdates() → Stream<Table>
inherited
when<T>(Stream<List<T>> builder(SqlliteDatabase db)) → Stream<List<T>>
Provides a safe builder access for querying the database when you are unsure of the initialisation status
inherited

Operators

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

Static Properties

instance → Database
no setter