sqflite Documentation

To log database activities, implement a logger function that accepts a SqfliteLoggerEvent and use SqfliteDatabaseFactoryLogger to wrap your existing database factory.

There are 6 types of events you can handle:

• SqfliteLoggerSqlEvent: For individual SQL commands. Access sql, arguments, error, and sw (stopwatch/elapsed time).
• SqfliteLoggerBatchEvent: For batch operations. Iterate through event.operations to access individual operation details.
• SqfliteLoggerDatabaseOpenEvent
• SqfliteLoggerDatabaseCloseEvent
• SqfliteLoggerDatabaseDeleteEvent
• SqfliteLoggerInvokeEvent

Use SqfliteLoggerOptions to configure the logger, setting the log callback and the type (e.g., SqfliteDatabaseFactoryLoggerType.all).

import 'package:sqflite_common/sqflite_logger.dart';
import 'package:sqflite_common_ffi/sqflite_ffi.dart';

// 1. Define your logger function
void _logger(SqfliteLoggerEvent event) {
  if (event is SqfliteLoggerSqlEvent) {
    print('sql: ${event.sql}${event.arguments != null ? ' ${event.arguments}' : ''}');
  } else if (event is SqfliteLoggerBatchEvent) {
    for (var operation in event.operations) {
      print('sql(batch): ${operation.sql}${operation.arguments != null ? ' ${operation.arguments}' : ''}');
    }
  }
}

// 2. Wrap your factory with SqfliteDatabaseFactoryLogger
final factoryWithLogs = SqfliteDatabaseFactoryLogger(
  databaseFactoryFfi, // Your existing factory
  options: SqfliteLoggerOptions(
    log: _logger,
    type: SqfliteDatabaseFactoryLoggerType.all,
  ),
);

// 3. Use the wrapped factory to open databases
var db = await factoryWithLogs.openDatabase(inMemoryDatabasePath);

To use your existing sqflite code in Flutter tests, you must replace the global default Flutter database factory with the FFI implementation. This is typically done within a setUpAll block by initializing FFI and assigning databaseFactoryFfi to databaseFactory.

import 'package:flutter_test/flutter_test.dart';
import 'package:sqflite_common_ffi/sqflite_ffi.dart';
import 'package:sqflite/sqflite.dart';

Future main() async {
  // Setup sqflite_common_ffi for flutter test
  setUpAll(() {
    // Initialize FFI
    sqfliteFfiInit();
    // Change the default factory
    databaseFactory = databaseFactoryFfi;
  });

  test('Simple test', () async {
    var db = await openDatabase(inMemoryDatabasePath, version: 1,
        onCreate: (db, version) async {
      await db
          .execute('CREATE TABLE Test (id INTEGER PRIMARY KEY, value TEXT)');
    });
    // Insert some data
    await db.insert('Test', {'value': 'my_value'});
    // Check content
    expect(await db.query('Test'), [
      {'id': 1, 'value': 'my_value'}
    ]);

    await db.close();
  });
}