model library
Classes
- Batch
- A batch is used to perform multiple operation as a single atomic unit. A Batch object can be acquired by calling Database.batch. It provides methods for adding operation. None of the operation will be executed (or visible locally) until commit() is called. [...]
- Check
- Adds validation to column.
- Column
- Column of database.
- Constraint
- Column constraint.
- Database
- Database to send sql commands, created during openDatabase
- DatabaseDescriber
- Describes the database.
- DatabaseExecutor
- Common API for Database and Transaction to execute SQL commands
- DatabaseFactory
- Basic databases operations
- DBProvider
- Provides database.
- Default
- Set default value to column.
- MetaModel
- Holds column names.
- Model
- Model of a row in database.
- NotNull
- Restricts NULL for column.
- OpenDatabaseOptions
- Options for opening the database see openDatabase for details
- References
- Makes column reference another table.
- Sqflite
- sqflite plugin
- SqfliteOptions
- internal options. [...]
- Table
- Table.
- Transaction
- Database transaction to use during a transaction
- Unique
- Makes column unique.
Constants
- inMemoryDatabasePath → const String
-
Special database name opened in memory
':memory:'
Properties
- databaseFactory ↔ DatabaseFactory
-
sqflite Default factory
read / write
- onDatabaseDowngradeDelete → OnDatabaseVersionChangeFn
-
Downgrading will delete the database and open it again. [...]
final
- sqfliteLogLevelNone → int
-
No logs
final
- sqfliteLogLevelSql → int
-
Log native sql commands
final
- sqfliteLogLevelVerbose → int
-
Log native verbose
final
Functions
-
databaseExists(
String path) → Future< bool> - Check if a database exists at a given path.
-
deleteDatabase(
String path) → Future< void> - Delete the database at the given path.
-
getDatabasesPath(
) → Future< String> - Get the default databases location. [...]
-
onDatabaseVersionChangeError(
Database db, int oldVersion, int newVersion) → Future< void> -
to specify during openDatabase for
onDowngrade
Downgrading will always fail -
openDatabase(
String path, {int version, OnDatabaseConfigureFn onConfigure, OnDatabaseCreateFn onCreate, OnDatabaseVersionChangeFn onUpgrade, OnDatabaseVersionChangeFn onDowngrade, OnDatabaseOpenFn onOpen, bool readOnly = false, bool singleInstance = true}) → Future< Database> - Open the database at a given path [...]
-
openReadOnlyDatabase(
String path) → Future< Database> - Open the database at a given path in read only mode
Enums
- ConflictAlgorithm
- Insert/Update conflict resolver
- SQLiteType
- Available SQLite types.
Typedefs
-
OnDatabaseConfigureFn(
Database db) → FutureOr< void> -
Prototype of the function called before calling
onCreate
/onUpdate
/onOpen
when the database is open. [...] -
OnDatabaseCreateFn(
Database db, int version) → FutureOr< void> - Prototype of the function called when the database is created. [...]
-
OnDatabaseOpenFn(
Database db) → FutureOr< void> - Prototype of the function called when the database is open. [...]
-
OnDatabaseVersionChangeFn(
Database db, int oldVersion, int newVersion) → FutureOr< void> - Prototype of the function called when the version has changed. [...]
Exceptions / Errors
- DatabaseException
- Wrap sqlite native exception