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

发布于 1周前 作者 nodeper 来自 Flutter

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

标题

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

内容

PostgreSQL gateway for migrant.

Example:

import 'package:migrant/migrant.dart';
import 'package:migrant/testing.dart';
import 'package:migrant_db_postgresql/migrant_db_postgresql.dart';
import 'package:postgres/postgres.dart';

Future<void> main() async {
  // 这些是迁移。我们使用简单的的内存源，但您可以从其他来源读取它们：本地文件系统、网络等。
  // 更多选项请参阅 https://pub.dev/packages/migrant
  final migrations = InMemory([
    Migration('0001', ['CREATE TABLE foo (id TEXT NOT NULL PRIMARY KEY);']),
    Migration('0002', ['ALTER TABLE foo ADD COLUMN message TEXT;']),
    // 尝试在这里添加更多内容并再次运行此示例。
  ]);

  // PostgreSQL连接。要使其工作，您需要实际的服务器。
  // 尝试使用Docker:
  // docker run -d -p 5432:5432 --name my-postgres -e POSTGRES_PASSWORD=postgres postgres
  final connection = await Connection.open(
      Endpoint(
        host: 'localhost',
        database: 'postgres',
        username: 'postgres',
        password: 'postgres',
      ),
      settings: ConnectionSettings(sslMode: SslMode.disable));

  // 该gateway由此包提供。
  final gateway = PostgreSQLGateway(connection);

  // 应用迁移。
  await Database(gateway).upgrade(migrations);

  // 此时表“foo”已准备好。我们完成了。
  await connection.close();
}

示例代码

import 'package:migrant/migrant.dart';
import 'package:migrant/testing.dart';
import 'package:migrant_db_postgresql/migrant_db_postgresql.dart';
import 'package:postgres/postgres.dart';

Future<void> main() async {
  // 这些是迁移。我们使用简单内存源，但您可以从其他来源读取它们：本地文件系统、网络等。
  // 更多选项请参阅 https://pub.dev/packages/migrant
  final migrations = InMemory([
    Migration('0001', ['CREATE table foo (id text not null primary key);']),
    Migration('0002', ['alter table foo add column message text;']),
    // 尝试在这里添加更多内容并再次运行此示例。
  ]);

  // PostgreSQL连接。要使其工作，您需要实际的服务器。
  // 尝试使用Docker:
  // docker run -d -p 5432:5432 --name my-postgres -e POSTGRES_PASSWORD=postgres postgres
  final connection = await Connection.open(
      Endpoint(
        host: 'localhost',
        database: 'postgres',
        username: 'postgres',
        password: 'postgres',
      ),
      settings: ConnectionSettings(sslMode: SslMode.disable));

  // 该gateway由此包提供。
  final gateway = PostgreSQLGateway(connection);

  // 应用迁移。
  await Database(gateway).upgrade(migrations);

  // 此时表“foo”已准备好。我们完成了。
  await connection.close();
}

完整示例demo

import 'package:migrant/migrant.dart';
import 'package:migrant/testing.dart';
import 'package:migrant_db_postgresql/migrant_db_postgresql.dart';
import 'package:postgres/postgres.dart';

Future<void> main() async {
  // 这些是迁移。我们使用简单内存源，但您可以从其他来源读取它们：本地文件系统、网络等。
  // 更多选项请参阅 https://pub.dev/packages/migrant
  final migrations = InMemory([
    Migration('0001', ['create table foo (id text not null primary key);']),
    Migration('0002', ['alter table foo add column message text;']),
    // 尝试在这里添加更多内容并再次运行此示例。
  ]);

  // PostgreSQL连接。要使其工作，您需要实际的服务器。
  // 尝试使用Docker:
  // docker run -d -p 5432:5432 --name my-postgres -e POSTGRES_PASSWORD=postgres postgres
  final connection = await Connection.open(
      Endpoint(
        host: 'localhost',
        database: 'postgres',
        username: 'postgres',
        password: 'postgres',
      ),
      settings: ConnectionSettings(sslMode: SslMode.disable));

  // 该gateway由此包提供。
  final gateway = PostgreSQLGateway(connection);

  // 应用迁移。
  await Database(gateway).upgrade(migrations);

  // 此时表“foo”已准备好。我们完成了。
  await connection.close();
}

更多关于Flutter数据库管理插件migrant_db_postgresql的使用的实战系列教程也可以访问 https://www.itying.com/category-92-b0.html

Harmonyos Next教程
1 回复

更多关于Flutter数据库管理插件migrant_db_postgresql的使用的实战系列教程也可以访问 https://www.itying.com/category-92-b0.html


当然，以下是如何在Flutter项目中使用migrant_db_postgresql插件进行数据库管理的示例代码。migrant_db_postgresql是一个用于Flutter的PostgreSQL数据库管理插件，它允许你执行数据库迁移和查询操作。

首先，确保你已经在pubspec.yaml文件中添加了migrant_db_postgresql依赖：

dependencies:
  flutter:
    sdk: flutter
  migrant_db_postgresql: ^最新版本号  # 替换为实际的最新版本号

然后，运行flutter pub get来获取依赖项。

初始化数据库连接

在你的Flutter项目中，你需要初始化PostgreSQL数据库连接。以下是一个示例代码：

import 'package:flutter/material.dart';
import 'package:migrant_db_postgresql/migrant_db_postgresql.dart';

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

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: Text('Migrant DB PostgreSQL Example'),
        ),
        body: Center(
          child: FutureBuilder<void>(
            future: initDatabase(),
            builder: (context, snapshot) {
              if (snapshot.connectionState == ConnectionState.waiting) {
                return CircularProgressIndicator();
              } else if (snapshot.hasError) {
                return Text('Error: ${snapshot.error}');
              } else {
                return Text('Database Initialized');
              }
            },
          ),
        ),
      ),
    );
  }

  Future<void> initDatabase() async {
    // PostgreSQL连接配置
    final config = PostgresConfig(
      host: 'your_host',
      port: 5432,
      database: 'your_database',
      username: 'your_username',
      password: 'your_password',
      sslMode: SslMode.disable,  // 根据需要启用SSL
    );

    // 初始化数据库连接
    final db = await MigrantDBPostgresql.connect(config);

    // 检查并执行迁移
    await db.migrate();

    // 你可以在这里执行其他数据库操作
    // 例如，查询数据库版本
    final version = await db.version();
    print('Database version: $version');

    // 关闭数据库连接（通常在实际应用中，你可能希望保持连接打开）
    await db.close();
  }
}

执行数据库迁移

迁移文件通常放在项目的某个目录中，比如migrations/。迁移文件的内容是SQL脚本，用于定义数据库结构的变更。每个迁移文件都需要有一个唯一的版本号和一个描述性的名称。

假设你有以下两个迁移文件：

  • migrations/001_create_users_table.sql

    CREATE TABLE users (
  id SERIAL PRIMARY KEY,
  name VARCHAR(100) NOT NULL,
  email VARCHAR(100) NOT NULL UNIQUE
);

  • migrations/002_add_age_to_users.sql

    ALTER TABLE users ADD COLUMN age INTEGER;

在initDatabase函数中，db.migrate()会自动查找并执行这些迁移文件。

执行查询操作

一旦数据库连接初始化完成并且迁移执行完毕，你就可以执行查询操作了。以下是一个简单的查询示例：

Future<List<Map<String, dynamic>>> fetchUsers() async {
  final db = await MigrantDBPostgresql.connect(config);  // 重新连接数据库（或保持连接打开）

  final result = await db.query('SELECT * FROM users');

  await db.close();  // 关闭数据库连接（如果保持连接打开，则根据需要关闭）

  return result.rows;
}

你可以在UI中调用fetchUsers函数并显示结果：

FutureBuilder<List<Map<String, dynamic>>>(
  future: fetchUsers(),
  builder: (context, snapshot) {
    if (snapshot.connectionState == ConnectionState.waiting) {
      return CircularProgressIndicator();
    } else if (snapshot.hasError) {
      return Text('Error: ${snapshot.error}');
    } else {
      final users = snapshot.data ?? [];
      return ListView.builder(
        itemCount: users.length,
        itemBuilder: (context, index) {
          final user = users[index];
          return ListTile(
            title: Text('${user['name']} (${user['email']})'),
            subtitle: Text('Age: ${user['age'] ?? 'N/A'}'),
          );
        },
      );
    }
  },
)

以上代码展示了如何在Flutter项目中使用migrant_db_postgresql插件进行数据库连接、迁移和查询操作。根据你的实际需求，你可以进一步扩展这些示例代码。

回到顶部