SQLite with sqflite package in Flutter

Introduction

SQLite lets your app save data on the device. The sqflite package helps Flutter apps use SQLite easily.

You want to save user notes or settings locally on the phone.

You need to keep a list of items that the user can add or remove.

Your app should work offline and store data persistently.

You want to organize data in tables with rows and columns.

You need fast access to structured data without internet.

Syntax

Flutter

import 'package:sqflite/sqflite.dart';

// Open or create a database
final database = await openDatabase(
  'my_db.db',
  version: 1,
  onCreate: (db, version) async {
    await db.execute('CREATE TABLE items(id INTEGER PRIMARY KEY, name TEXT)');
  },
);

// Insert data
await database.insert('items', {'name': 'Item 1'});

// Query data
final List<Map<String, dynamic>> items = await database.query('items');

Use openDatabase to create or open a database file.

Use SQL commands inside execute to create tables.

Examples

Open a database file named 'app.db'. If it doesn't exist, it will be created.

Flutter

final db = await openDatabase('app.db');

Create a table called 'users' with columns for id and name.

Flutter

await db.execute('CREATE TABLE users(id INTEGER PRIMARY KEY, name TEXT)');

Add a new user named Alice to the 'users' table.

Flutter

await db.insert('users', {'name': 'Alice'});

Get all rows from the 'users' table as a list of maps.

Flutter

final users = await db.query('users');

Sample App

This Flutter app creates a local SQLite database using sqflite. It makes a table called 'items', inserts one item, and shows the list on screen.

Flutter

import 'package:flutter/material.dart';
import 'package:sqflite/sqflite.dart';
import 'package:path/path.dart';

void main() {
  runApp(const MyApp());
}

class MyApp extends StatefulWidget {
  const MyApp({super.key});

  @override
  State<MyApp> createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> {
  late Database database;
  List<Map<String, dynamic>> items = [];

  @override
  void initState() {
    super.initState();
    initDb();
  }

  Future<void> initDb() async {
    database = await openDatabase(
      join(await getDatabasesPath(), 'demo.db'),
      version: 1,
      onCreate: (db, version) async {
        await db.execute('CREATE TABLE items(id INTEGER PRIMARY KEY AUTOINCREMENT, name TEXT)');
      },
    );
    await insertItem('First Item');
    await loadItems();
  }

  Future<void> insertItem(String name) async {
    await database.insert('items', {'name': name});
  }

  Future<void> loadItems() async {
    final data = await database.query('items');
    setState(() {
      items = data;
    });
  }

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(title: const Text('SQLite with sqflite')),
        body: ListView.builder(
          itemCount: items.length,
          itemBuilder: (context, index) {
            return ListTile(
              title: Text(items[index]['name'] ?? ''),
            );
          },
        ),
      ),
    );
  }
}

Important Notes

Always close the database when done to free resources (not shown here for simplicity).

Use getDatabasesPath() and join() from path package to get a safe file path.

Database operations are async, so use await and async properly.

Summary

sqflite lets Flutter apps use SQLite databases easily.

Open or create a database, then create tables with SQL commands.

Insert, query, update, and delete data using provided methods.

Practice

1. What is the primary purpose of the sqflite package in Flutter?

easy

A. To handle network requests and APIs

B. To manage SQLite databases for storing app data locally

C. To create user interfaces with widgets

D. To manage app navigation between screens

Solution

1. Step 1: Understand sqflite package role

   The sqflite package is designed to work with SQLite databases in Flutter apps.

2. Step 2: Identify main functionality

   It helps create, open, and manage local databases for storing app data persistently.

3. Final Answer:

   To manage SQLite databases for storing app data locally -> Option B

4. Quick Check:

   sqflite = SQLite database management [OK]

Hint: sqflite = SQLite database helper in Flutter [OK]

Common Mistakes:

• Confusing sqflite with UI or navigation packages
• Thinking sqflite handles network or API calls
• Assuming sqflite is for animations or gestures

2. Which of the following is the correct way to open a database using sqflite?

easy

A. db.open('my_db.db');

B. openDB('my_db.db');

C. await openDatabase('my_db.db');

D. Database.open('my_db.db');

Solution

1. Step 1: Recall sqflite openDatabase syntax

   The sqflite package provides an async function called openDatabase to open or create a database.

2. Step 2: Match correct syntax

   The correct usage is: await openDatabase('filename'); other options are not valid sqflite methods.

3. Final Answer:

   await openDatabase('my_db.db'); -> Option C

4. Quick Check:

   openDatabase is async and correct method [OK]

Hint: Use await openDatabase('filename') to open DB [OK]

Common Mistakes:

• Using non-existent methods like openDB or Database.open
• Forgetting to await the async openDatabase call
• Calling openDatabase without parentheses

3. Given this code snippet, what will be the output printed?

var db = await openDatabase('test.db');
await db.execute('CREATE TABLE IF NOT EXISTS users(id INTEGER PRIMARY KEY, name TEXT)');
await db.insert('users', {'id': 1, 'name': 'Alice'});
var result = await db.query('users');
print(result);

medium

A. SyntaxError

B. []

C. null

D. [{'id': 1, 'name': 'Alice'}]

Solution

1. Step 1: Analyze database operations

   The code opens a database, creates a table if missing, inserts one user, then queries all users.

2. Step 2: Understand query result

   The query returns a list of maps representing rows. Since one user was inserted, result contains one map with id and name.

3. Final Answer:

   [{'id': 1, 'name': 'Alice'}] -> Option D

4. Quick Check:

   Insert then query returns inserted row [OK]

Hint: Insert then query returns list with inserted rows [OK]

Common Mistakes:

• Expecting empty list if table was just created
• Confusing query result with null or error
• Not awaiting async calls causing runtime errors

4. What is wrong with this sqflite code snippet?

var db = await openDatabase('app.db');
await db.execute('CREATE TABLE users(id INTEGER PRIMARY KEY, name TEXT)');
await db.insert('users', {'id': 1, 'name': 'Bob'});
await db.insert('users', {'id': 1, 'name': 'Carol'});

medium

A. It tries to insert two rows with the same primary key, causing a conflict error

B. The table creation SQL syntax is incorrect

C. The insert method requires a third argument for conflictAlgorithm

D. openDatabase must be called with a version number

Solution

1. Step 1: Check table and inserts

   The table has id as PRIMARY KEY. Two inserts use the same id=1.

2. Step 2: Understand primary key constraint

   Inserting duplicate primary keys causes a conflict error unless handled explicitly.

3. Final Answer:

   It tries to insert two rows with the same primary key, causing a conflict error -> Option A

4. Quick Check:

   Duplicate primary keys cause insert conflict error [OK]

Hint: Primary key must be unique; duplicates cause errors [OK]

Common Mistakes:

• Assuming insert silently overwrites existing rows
• Thinking version is mandatory for openDatabase
• Believing insert always needs conflictAlgorithm argument

5. You want to update a user's name in the database using sqflite. Which code snippet correctly updates the user with id = 2 to have the name 'David'?

hard

A. await db.update('users', {'name': 'David'}, where: 'id = ?', whereArgs: [2]);

B. await db.insert('users', {'id': 2, 'name': 'David'});

C. await db.execute('UPDATE users SET name = 'David' WHERE id = 2');

D. await db.update('users', {'name': 'David'}, where: 'id = 2');

Solution

1. Step 1: Understand update method parameters

   The update method requires the table name, values map, and a where clause with arguments to avoid SQL injection.

2. Step 2: Check correct usage of where and whereArgs

   await db.update('users', {'name': 'David'}, where: 'id = ?', whereArgs: [2]); uses where: 'id = ?' and whereArgs: [2], which is the safe and correct way.

3. Final Answer:

   await db.update('users', {'name': 'David'}, where: 'id = ?', whereArgs: [2]); -> Option A

4. Quick Check:

   Use whereArgs with ? placeholders for safe updates [OK]

Hint: Use where with ? and whereArgs list for updates [OK]

Common Mistakes:

• Using raw SQL string without parameter binding
• Using insert instead of update to change data
• Omitting whereArgs causing errors or unsafe queries