Flutter数据库管理插件sqlite_flutter_pcl的使用

Flutter数据库管理插件sqlite_flutter_pcl的使用

SQLiteConnection 提供了在 Dart 中与 SQLite 数据库交互的简化接口，支持各种操作如搜索、插入、更新、删除等。

特性

• 搜索操作：不区分大小写、特定列、多列搜索。
• 插入操作：单条和批量插入。
• 更新操作：单条和批量更新，并处理冲突。
• 删除操作：单条和批量删除。
• 高级查询：分组、分页和随机行检索。
• 数据库管理：表创建、删除和备份。

开始使用

在 pubspec.yaml 文件中添加该包：

dependencies:
  sqlite_flutter_pcl: ^1.0.0

基本用法

初始化

首先，创建一个实现 ISQLiteItem 接口的类来表示数据库表。

import 'package:sqlite_flutter_pcl/sqlite_connection.dart';

class SqlModel implements ISQLiteItem {
  static const String tableName = 'sql_model';
  static const String tableId = 'id';
  static const String tableTitle = 'title';
  static const String tableValue = 'value';

  int? id;
  String? title;
  String? value;

  SqlModel({this.id, this.title, this.value});

  @override
  String getTableName() {
    return tableName;
  }

  @override
  int getPrimaryKey() {
    return id ?? 0;
  }

  @override
  Map<String, dynamic> toMap() {
    return {
      tableId: id,
      tableTitle: title,
      tableValue: value,
    };
  }

  @override
  String getPrimaryKeyName() {
    return tableId;
  }

  @override
  ISQLiteItem fromMap(Map<String, dynamic> map) {
    return SqlModel(
      id: map[tableId],
      title: map[tableTitle],
      value: map[tableValue],
    );
  }
}

创建 SQLiteConnection 实例：

// 初始化 SQLiteConnection 库（如果未初始化）
SQLiteConnection.initDatabaseLib();

// 获取临时数据库文件路径
final databasePath = await getTemporaryDatabaseFilePath();

// 创建 SQLiteConnection 实例
final connection = SQLiteConnection(path: databasePath);

// 创建表
connection.createTable(SqlModel());

// 插入新项
var newItem = SqlModel(title: 'Title 1', value: 'Value 1');
await connection.insert(newItem);

// 检索项
var isqliteItems = await connection.toList(SqlModel());

// 转换为类型列表
var items = isqliteItems.whereType<SqlModel>().toList();
var items = isqliteItems.cast<SqlModel>().toList();

// 更新项
for (var item in items) {
  item.value = 'Updated';
  await connection.update(item);
}

// 或者批量更新
await connection.updateAll(items);

// 删除项
await connection.deleteAll(items);

// 查询单个值
var queryItems = await connection.toListWhere(SqlModel(), 'title', 'Title 1');

// 按值查询项
var queryItems = await connection.searchColumns(SqlModel(), 'title', 'Title 1');

// 返回标题为 'title1' 和 'title2' 的项，使用批处理查询提高效率
var results = await connection.toListWhereValuesAre(SqlModel(), 'title', ['title1', 'title2']);

// 跨多个列搜索
var columnNames = ['word', 'number', 'lemma', 'xlit', 'pronounce', 'description'];
var items = await db.toListColumns(Strongs(), columnNames, query);

// 删除所有表记录
connection.deleteRecords(SqlModel());

// 删除表
connection.dropTable(SqlModel());

Future<String> getTemporaryDatabaseFilePath() async {
  final directory = await getTemporaryDirectory();
  final path = join(directory.path, 'your_database.db');
  print(path);
  return path;
}

插入数据

单条数据

final id = await connection.insert(sqlItem);

多条数据

final totalInserted = await connection.insertAll(sqlItems);

更新数据

单条数据

await connection.update(sqlItem);

多条数据

final totalUpdated = await connection.updateAll(sqlItems);

删除数据

单条数据

final rowsDeleted = await connection.delete(sqlItem);

多条数据

final totalDeleted = await connection.deleteAll(sqlItems);

搜索数据

单列搜索

final results = await connection.search(sqlItem, 'columnName', 'searchQuery');

多列搜索

final results = await connection.searchColumns(
  sqlItem,
  ['column1', 'column2'],
  'searchQuery',
);

精确匹配

final result = await connection.whereColumnHasValue(sqlItem, 'columnName', value);

查询数据

获取所有行

final items = await connection.toList(sqlItem);

过滤行

final items = await connection.toListWhereColumnHasValue(sqlItem, 'columnName', value);

分页行

final items = await connection.paginate(sqlItem, limit: 10, offset: 20);

分组行

final items = await connection.groupBy(
  sqlItem,
  ['column1', 'column2'],
  'groupByColumn',
  orderByColumn: 'orderByColumn',
);

工具函数

• 备份数据库

await connection.backupDatabase('/path/to/backup.db');

• 删除表

await connection.dropTable(sqlItem);

• 清理数据库

await connection.vacuum(sqlItem);

• 统计行数

final count = await connection.count(sqlItem);

• 获取表列

final columns = await connection.tableColumns('tableName');