Flutter插件stormberry的使用_一个用于在 Dart 类和 PostgreSQL 数据库之间提供简单绑定的强类型 PostgreSQL ORM

Stormberry

一个用于在 Dart 类和 PostgreSQL 数据库之间提供简单绑定的强类型 PostgreSQL ORM。它支持所有类型的关系而无需任何复杂的配置。

快速开始

添加依赖

首先，在你的 pubspec.yaml 文件中添加 stormberry 作为依赖，并添加 build_runner 作为开发依赖：

dart pub add stormberry
dart pub add build_runner --dev

定义模型

在你的代码中，指定一个抽象类来表示表：

// 这个文件是 "model.dart"
import 'package:stormberry/stormberry.dart';

// 将由 stormberry 自动生成
part 'model.schema.dart';

@Model()
abstract class User {
  @PrimaryKey()
  String get id;

  String get name;
}

生成数据库代码

运行以下命令以生成数据库代码：

dart run build_runner build

提示：每次修改模型时，都需要重新运行代码生成。在开发过程中，可以使用 watch 自动监视更改：

dart pub run build_runner watch

这将生成一个 .schema.dart 文件，你应该将其作为 part 添加到原始模型文件中。

迁移数据库

在运行应用程序之前，必须迁移数据库。为此，请运行：

dart run stormberry migrate

这将提示你输入 PostgreSQL 数据库的连接详细信息，然后通过添加 users 表来迁移数据库模式。

访问数据库

要从应用程序访问数据库，请创建一个 Database 实例并使用 users 仓库：

void main() async {
  var db = Database(
    // 连接参数
  );

  // 向 'users' 表中添加一个用户
  await db.users.insertOne(UserInsertRequest(id: 'abc', name: 'Alex'));

  // 根据 'id' 查找用户
  var user = await db.users.queryUser('abc');

  assert(user.name == 'Alex');
}

完整文档

查看完整的文档 在这里 或直接跳转到你需要的部分：

• 模型
• 视图
• 数据库
• 仓库
• 查询与操作
• 迁移

示例代码

下面是完整的示例代码：

import 'package:stormberry/stormberry.dart';

import 'models/account.dart';
import 'models/address.dart';
import 'models/company.dart';
import 'models/latlng.dart';

Future<void> main() async {
  var db = Database(
    port: 2222,
    database: 'dart_test',
    username: 'postgres',
    password: 'postgres',
    useSSL: false,
  );

  db.debugPrint = true;

  await db.companies.deleteOne('abc');

  await db.companies.insertOne(CompanyInsertRequest(
    id: 'abc',
    name: 'Minga',
    addresses: [],
  ));

  await db.accounts.deleteMany([0, 1, 2]);

  var accountId = await db.accounts.insertOne(AccountInsertRequest(
    firstName: 'Test',
    lastName: 'User',
    location: LatLng(1, 2),
    billingAddress: BillingAddress(
      name: 'Test User',
      street: 'SomeRoad 1',
      city: 'New York',
      postcode: '123',
    ),
    companyId: 'abc',
  ));

  var account = await db.accounts.queryUserView(accountId);

  print(account!.id);

  var company = await db.companies.queryFullView('abc');

  print(company!.id);

  await db.close();
}