Database class abstract

Database to send sql commands, created during openDatabase

Implemented types

• DatabaseExecutor

Constructors

Database()

Properties

hashCode → int

The hash code for this object.

no setter, inherited

isOpen → bool

Tell if the database is open, returns false once close has been called

no setter

path → String

The path of the database

no setter

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

batch() → Batch

Creates a batch, used for performing multiple operation in a single atomic operation.

inherited

close() → Future<void>

Close the database. Cannot be accessed anymore

delete(String table, {String? where, List<Object?>? whereArgs}) → Future<int>

Convenience method for deleting rows in the database.

inherited

devInvokeMethod<T>(String method, [dynamic arguments]) → Future<T>

testing only

devInvokeSqlMethod<T>(String method, String sql, [List<Object?>? arguments]) → Future<T>

testing only

events({OnDatabaseNotReadyFn? onNotReady, OnDatabaseReadyFn? onReady, OnDatabaseSyncFn? onSync}) → Future<void>

Register callbacks for database events

execute(String sql, [List<Object?>? arguments]) → Future<void>

Execute an SQL query with no return value.

inherited

getVersion() → Future<int>

Get the database inner version

insert(String table, Map<String, Object?> values, {String? nullColumnHack, ConflictAlgorithm? conflictAlgorithm}) → Future<int>

This method helps insert a map of values into the specified table and returns the id of the last inserted row.

inherited

isReady() → Future<bool>

Check if the database is ready for access

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

query(String table, {bool? distinct, List<String>? columns, String? where, List<Object?>? whereArgs, String? groupBy, String? having, String? orderBy, int? limit, int? offset}) → Future<List<Map<String, Object?>>>

This is a helper to query a table and return the items found. All optional clauses and filters are formatted as SQL queries excluding the clauses' names.

inherited

rawDelete(String sql, [List<Object?>? arguments]) → Future<int>

Executes a raw SQL DELETE query and returns the number of changes made.

inherited

rawInsert(String sql, [List<Object?>? arguments]) → Future<int>

Executes a raw SQL INSERT query and returns the last inserted row ID.

inherited

rawQuery(String sql, [List<Object?>? arguments]) → Future<List<Map<String, Object?>>>

Executes a raw SQL SELECT query and returns a list of the rows that were found.

inherited

rawUpdate(String sql, [List<Object?>? arguments]) → Future<int>

Executes a raw SQL UPDATE query and returns the number of changes made.

inherited

setVersion(int version) → Future<void>

Set the database inner version Used internally for open helpers and automatic versioning

toString() → String

A string representation of this object.

inherited

transaction<T>(Future<T> action(Transaction txn), {bool? exclusive}) → Future<T>

Calls in action must only be done using the transaction object using the database will trigger a dead-lock.

update(String table, Map<String, Object?> values, {String? where, List<Object?>? whereArgs, ConflictAlgorithm? conflictAlgorithm}) → Future<int>

Convenience method for updating rows in the database. Returns the number of changes made

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited