Flutter文档数据库管理插件docdb的使用

Flutter 文档数据库管理插件 DocDB 的使用

DocDB 是一个为 Flutter 设计的简单文档数据库，它将文档元数据存储在一个表中，并将键值对存储在每个数据类型的单独表中。它不是 SQLite 的 ORM。

安装

在 pubspec.yaml 文件中添加 DocDB 作为依赖项：

dependencies:
  docdb:

然后运行 flutter pub get 来安装该包。

使用

连接到数据库

在使用 DocDB 之前，你需要连接到数据库。可以使用 connect 方法来实现：

import 'package:docdb/docdb.dart';

final db = DocDB();
await db.connect(dbName: 'mydb.db');

connect 方法会在数据库文件不存在时创建它，并打开与数据库的连接。

存储文档

要存储文档，创建一个 Doc 对象并为其添加字段：

final doc = Doc();
doc['title'] = '我的文档';
doc['content'] = 'Lorem ipsum dolor sit amet...';
await db.insert(doc);

insert 方法将文档添加到数据库并返回文档 ID。

检索文档

要检索文档，使用 get 方法：

final docId = 1; // 要检索的文档的 ID
final doc = await db.get(docId);
print(doc['title']); // 打印文档的标题

get 方法返回具有指定 ID 的 Doc 对象。

更新文档

要更新文档，使用 get 方法检索文档，修改其字段，然后调用 update 方法：

final docId = 1; // 要更新的文档的 ID
final doc = await db.get(docId);
doc['title'] = '新标题';
await db.update(doc);

update 方法保存更改到数据库。

删除文档

要删除文档，使用 delete 方法：

final docId = 1; // 要删除的文档的 ID
await db.delete(docId);

delete 方法从数据库中移除文档及其关联的键值对。

筛选文档

可以使用 filter 方法按特定字段值筛选文档：

final docs = await db.filter('title', '我的文档');
print(docs.length); // 打印具有指定标题的文档数量

filter 方法返回符合指定条件的 Doc 对象列表。

查询文档

可以使用 query 方法根据多个过滤器和日期约束查询文档：

List<Doc> docs = await db.query(
  {'_collection': 'xyz', 'status': 'active'},
  dateField: 'created',
  olderThan: DateTime.now().subtract(const Duration(days: 3)),
);

query 方法返回符合指定条件和日期约束的 Doc 对象列表。

示例代码

以下是一个完整的示例代码，展示了如何使用 DocDB 插件进行基本操作：

import 'package:docdb/doc.dart';
import 'package:docdb/docdb.dart';

void main() async {
  // 初始化 DocDB 实例并连接到数据库
  final db = DocDB();
  await db.connect(dbName: 'example.db');

  // 插入一个文档
  final doc = Doc();
  doc['title'] = '示例文档';
  doc['content'] = '这是一个示例文档。';
  await db.insert(doc);

  // 检索文档
  Doc retrievedDoc = await db.get(doc.id);
  print('检索到的文档: ${retrievedDoc.toMap()}');

  // 更新文档
  doc['title'] = '更新后的示例文档';
  await db.update(doc);

  // 检索更新后的文档
  final updatedDoc = await db.get(doc.id);
  print('更新后的文档: ${updatedDoc.toMap()}');

  // 删除文档
  await db.delete(doc.id);

  // 检查文档是否已删除
  final deletedDoc = await db.get(doc.id);
  print('删除后的文档: ${deletedDoc?.toMap()}');
}