sqflite 0.13.0

  • README.md
  • CHANGELOG.md
  • Example
  • Installing
  • Versions
  • 100

sqflite

SQLite plugin for Flutter. Supports both iOS and Android.

  • Support transactions and batches
  • Automatic version managment during open
  • Helpers for insert/query/update/delete queries
  • DB operation executed in a background thread on iOS and Android

Getting Started

In your flutter project add the dependency:

dependencies:
  ...
  sqflite: any

For help getting started with Flutter, view the online documentation.

Usage example

Import sqflite.dart

import 'package:sqflite/sqflite.dart';

Raw SQL queries

Demo code to perform Raw SQL queries

// Get a location using getDatabasesPath
var databasesPath = await getDatabasesPath();
String path = join(databasesPath, 'demo.db');

// Delete the database
await deleteDatabase(path);

// open the database
Database database = await openDatabase(path, version: 1,
    onCreate: (Database db, int version) async {
  // When creating the db, create the table
  await db.execute(
      'CREATE TABLE Test (id INTEGER PRIMARY KEY, name TEXT, value INTEGER, num REAL)');
});

// Insert some records in a transaction
await database.transaction((txn) async {
  int id1 = await txn.rawInsert(
      'INSERT INTO Test(name, value, num) VALUES("some name", 1234, 456.789)');
  print('inserted1: $id1');
  int id2 = await txn.rawInsert(
      'INSERT INTO Test(name, value, num) VALUES(?, ?, ?)',
      ['another name', 12345678, 3.1416]);
  print('inserted2: $id2');
});

// Update some record
int count = await database.rawUpdate(
    'UPDATE Test SET name = ?, VALUE = ? WHERE name = ?',
    ['updated name', '9876', 'some name']);
print('updated: $count');

// Get the records
List<Map> list = await database.rawQuery('SELECT * FROM Test');
List<Map> expectedList = [
  {'name': 'updated name', 'id': 1, 'value': 9876, 'num': 456.789},
  {'name': 'another name', 'id': 2, 'value': 12345678, 'num': 3.1416}
];
print(list);
print(expectedList);
assert(const DeepCollectionEquality().equals(list, expectedList));

// Count the records
count = Sqflite
    .firstIntValue(await database.rawQuery('SELECT COUNT(*) FROM Test'));
assert(count == 2);

// Delete a record
count = await database
    .rawDelete('DELETE FROM Test WHERE name = ?', ['another name']);
assert(count == 1);

// Close the database
await database.close();

SQL helpers

Example using the helpers

final String tableTodo = 'todo';
final String columnId = '_id';
final String columnTitle = 'title';
final String columnDone = 'done';

class Todo {
  int id;
  String title;
  bool done;

  Map<String, dynamic> toMap() {
    var map = <String, dynamic>{
      columnTitle: title,
      columnDone: done == true ? 1 : 0
    };
    if (id != null) {
      map[columnId] = id;
    }
    return map;
  }

  Todo();

  Todo.fromMap(Map<String, dynamic> map) {
    id = map[columnId];
    title = map[columnTitle];
    done = map[columnDone] == 1;
  }
}

class TodoProvider {
  Database db;

  Future open(String path) async {
    db = await openDatabase(path, version: 1,
        onCreate: (Database db, int version) async {
      await db.execute('''
create table $tableTodo ( 
  $columnId integer primary key autoincrement, 
  $columnTitle text not null,
  $columnDone integer not null)
''');
    });
  }

  Future<Todo> insert(Todo todo) async {
    todo.id = await db.insert(tableTodo, todo.toMap());
    return todo;
  }

  Future<Todo> getTodo(int id) async {
    List<Map> maps = await db.query(tableTodo,
        columns: [columnId, columnDone, columnTitle],
        where: '$columnId = ?',
        whereArgs: [id]);
    if (maps.length > 0) {
      return Todo.fromMap(maps.first);
    }
    return null;
  }

  Future<int> delete(int id) async {
    return await db.delete(tableTodo, where: '$columnId = ?', whereArgs: [id]);
  }

  Future<int> update(Todo todo) async {
    return await db.update(tableTodo, todo.toMap(),
        where: '$columnId = ?', whereArgs: [todo.id]);
  }

  Future close() async => db.close();
}

Transaction

Don't use the database but only use the Transaction object in a transaction to access the database

await database.transaction((txn) async {
  // Ok
  await txn.execute('CREATE TABLE Test1 (id INTEGER PRIMARY KEY)');
  
  // DON'T  use the database object in a transaction
  // this will deadlock!
  await database.execute('CREATE TABLE Test2 (id INTEGER PRIMARY KEY)');
});

Batch support

To avoid ping-pong between dart and native code, you can use Batch:

batch = db.batch();
batch.insert('Test', {'name': 'item'});
batch.update('Test', {'name': 'new_item'}, where: 'name = ?', whereArgs: ['item']);
batch.delete('Test', where: 'name = ?', whereArgs: ['item']);
results = await batch.commit();

Getting the result for each operation has a cost (id for insertion and number of changes for update and delete), especially on Android where an extra SQL request is executed. If you don't care about the result and worry about performance in big batches, you can use

await batch.commit(noResult: true);

Warning, during a transaction, the batch won't be commited until the transaction is commited

await database.transaction((txn) async {
  var batch = txn.batch();
  
  // ...
  
  // commit but the actual commit will happen when the transaction is commited
  // however the data is available in this transaction
  await batch.commit();
  
  //  ...
});

By default a batch stops as soon as it encounters an error (which typically reverts the uncommited changes). You can ignore errors so that every successfull operation is ran and committed even if one operation fails:

await batch.commit(continueOnError: true);

Table and column names

In general it is better to avoid using SQLite keywords for entity names. If any of the following name is used:

"add","all","alter","and","as","autoincrement","between","case","check","collate","commit","constraint","create","default","deferrable","delete","distinct","drop","else","escape","except","exists","foreign","from","group","having","if","in","index","insert","intersect","into","is","isnull","join","limit","not","notnull","null","on","or","order","primary","references","select","set","table","then","to","transaction","union","unique","update","using","values","when","where"

the helper will escape the name i.e.

db.query('table')

will be equivalent to manually adding double-quote around the table name (confusingly here named table)

db.rawQuery('SELECT * FROM "table"');

However in any other raw statement (including orderBy, where, groupBy), make sure to escape the name properly using double quote. For example see below where the column name group is not escaped in the columns argument, but is escaped in the where argument.

db.query('table', columns: ['group'], where: '"group" = ?', whereArgs: ['my_group']);

Supported SQLite types

No validity check is done on values yet so please avoid non supported types https://www.sqlite.org/datatype3.html

DateTime is not a supported SQLite type. Personally I store them as int (millisSinceEpoch) or string (iso8601)

bool is not a supported SQLite type. Use INTEGER and 0 and 1 values.

INTEGER

  • Dart type: int
  • Supported values: from -2^63 to 2^63 - 1

REAL

  • Dart type: num

TEXT

  • Dart type: String

BLOB

  • Dart type: Uint8List
  • Dart type List<int> is supported but not recommended (slow conversion)

Current issues

  • Due to the way transaction works in SQLite (threads), concurrent read and write transaction are not supported. All calls are currently synchronized and transactions block are exclusive. I thought that a basic way to support concurrent access is to open a database multiple times but it only works on iOS as Android reuses the same database object. I also thought a native thread could be a potential future solution however on android accessing the database in another thread is blocked while in a transaction...
  • Currently INTEGER are limited to -2^63 to 2^63 - 1 (although Android supports bigger ones)

More

0.13.0

  • Add support for continueOrError for batches

0.12.0

  • iOS objective C prefix added to prevent conflict
  • on iOS create the directory of the database if it does not exist

0.11.2

  • add Database.isOpen which becomes false once the database is closed

0.11.1

  • add Sqlflite.hex to allow querying on blob fields

0.11.0

  • add getDatabasesPath to use as the base location to create a database
  • Warning: database are now single instance by default (based on path), to use the old behavior use singleInstance = kfalse when opening a database
  • dart2 stable support

0.10.0

  • Preparing for 1.0
  • Remove deprecated methods (re-entrant transactions)
  • Add Transaction.batch
  • Show developer warning to prevent deadlock

0.9.0

  • Support for in-memory database (:memory: path)
  • Support for single instance
  • new database factory for handling the new options

0.8.9

  • Upgrade to sdk 27

0.8.8

  • Allow testing for constraint exception

0.8.6

  • better sql error report
  • catch android native errors
  • no longer print an error when deleting a database fails

0.8.4

  • Add read-only support using openReadOnlyDatabase

0.8.3

  • Allow running a batch during a transaction using Transaction.applyBatch
  • Restore Batch.commit to use outside a transaction

0.8.2

  • Although already in a transaction, allow creating nested transactions during open

0.8.1

  • New Transaction mechanism not using Zone (old one still supported for now)
  • Start using Batch.apply instead of Batch.commit
  • Deprecate Database.inTransaction and Database.synchronized so that Zones are not used anymore

0.7.1

  • add Batch.query, Batch.rawQuery and Batch.execute
  • pack query result as colums/rows instead of List<Map>

0.7.0

  • Add support for --preview-dart-2

0.6.2+1

  • Add longer description to pubspec.yaml

0.6.2

  • Fix travis warning

0.6.1

  • Add Flutter SDK constraint to pubspec.yaml

0.6.0

  • add support for onConfigure to allow for database configuration

0.5.0

  • Escape table and column name when needed in insert/update/query/delete
  • Export ConflictAlgorithm, escapeName, unescapeName in new sql.dart

0.4.0

  • Add support for Batch (insert/update/delete)

0.3.1

  • Remove temp concurrency experiment

0.3.0

2018/01/04

  • Breaking change. Upgraded to Gradle 4.1 and Android Studio Gradle plugin 3.0.1. Older Flutter projects need to upgrade their Gradle setup as well in order to use this version of the plugin. Instructions can be found here.

0.2.4

  • Dependency on synchronized updated to >=1.1.0

0.2.3

  • Make Android sends the reponse in the same thread then the caller to prevent unexpected behavior when an error occured

0.2.2

  • Fix unchecked warning on Android

0.2.0

  • Use NSOperationQueue for all db operation on iOS
  • Use ThreadHandler for all db operation on Android

0.0.3

  • Add exception handling

0.0.2

  • Add sqlite helpers based on Razvan Lung suggestions

0.0.1

  • Initial experimentation

example/README.md

sqflite_example

Demonstrates how to use the sqflite plugin.

Quick test

flutter run

Specific app entry point

flutter run -t lib/main.dart

Getting Started

For help getting started with Flutter, view the online documentation.

Use this package as a library

1. Depend on it

Add this to your package's pubspec.yaml file:


dependencies:
  sqflite: ^0.13.0

2. Install it

You can install packages from the command line:

with Flutter:


$ flutter packages get

Alternatively, your editor might support flutter packages get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:


import 'package:sqflite/sqflite.dart';
  
Version Uploaded Documentation Archive
0.13.0 Dec 5, 2018 Go to the documentation of sqflite 0.13.0 Download sqflite 0.13.0 archive
0.12.2+1 Oct 11, 2018 Go to the documentation of sqflite 0.12.2+1 Download sqflite 0.12.2+1 archive
0.12.2 Oct 11, 2018 Go to the documentation of sqflite 0.12.2 Download sqflite 0.12.2 archive
0.12.1 Sep 20, 2018 Go to the documentation of sqflite 0.12.1 Download sqflite 0.12.1 archive
0.12.0 Sep 14, 2018 Go to the documentation of sqflite 0.12.0 Download sqflite 0.12.0 archive
0.11.2+4 Sep 13, 2018 Go to the documentation of sqflite 0.11.2+4 Download sqflite 0.11.2+4 archive
0.11.2+3 Sep 13, 2018 Go to the documentation of sqflite 0.11.2+3 Download sqflite 0.11.2+3 archive
0.11.2+2 Aug 29, 2018 Go to the documentation of sqflite 0.11.2+2 Download sqflite 0.11.2+2 archive
0.11.2+1 Aug 29, 2018 Go to the documentation of sqflite 0.11.2+1 Download sqflite 0.11.2+1 archive
0.11.2 Aug 29, 2018 Go to the documentation of sqflite 0.11.2 Download sqflite 0.11.2 archive

All 51 versions...

Popularity:
Describes how popular the package is relative to other packages. [more]
99
Health:
Code health derived from static analysis. [more]
100
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
100
Overall:
Weighted score of the above. [more]
100
Learn more about scoring.

We analyzed this package on Dec 6, 2018, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.1.0
  • pana: 0.12.7
  • Flutter: 1.0.0

Platforms

Detected platforms: Flutter

References Flutter, and has no conflicting libraries.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.0.0 <3.0.0
flutter 0.0.0
path >=1.5.1 <3.0.0 1.6.2
synchronized >=1.5.1 <3.0.0 1.5.3
Transitive dependencies
collection 1.14.11
meta 1.1.6
sky_engine 0.0.99
typed_data 1.1.6
vector_math 2.0.8
Dev dependencies
flutter_test