Flutter数据库连接插件postgres_fork的使用

Flutter数据库连接插件postgres_fork的使用

postgres_fork 是一个用于在 Flutter 中连接和查询 PostgreSQL 数据库的库。该库是从 postgresql-dart 分支出来的，并添加了一些新功能。

功能特性

• 支持改变连接的字符编码，如从默认的 UTF8 改为 win1252 或 iso8859。
• 实现了使用问号占位符风格执行预编译语句，类似于 PHP PDO。

final results = await connection.query(
    'SELECT * FROM public.table_example LIMIT ?',
    substitutionValues: [2000], 
    placeholderIdentifier: PlaceholderIdentifier.onlyQuestionMark);

使用方法

创建和打开连接

首先，创建一个 PostgreSQLConnection 并打开它：

var connection = PostgreSQLConnection("localhost", 5432, "dart_test",
    username: "dart", password: "dart");
await connection.open();

执行查询

你可以通过 query 方法执行查询：

List<List<dynamic>> results = await connection.query("SELECT a, b FROM table WHERE a = @aValue",
    substitutionValues: {"aValue": 3});

for (final row in results) {
  var a = row[0];
  var b = row[1];
}

返回行作为包含表和列名称的映射

List<Map<String, Map<String, dynamic>>> results = await connection.mappedResultsQuery(
    "SELECT t.id, t.name, u.name FROM t LEFT OUTER JOIN u ON t.id=u.t_id");

for (final row in results) {
  var tID = row["t"]["id"];
  var tName = row["t"]["name"];
  var uName = row["u"]["name"];
}

在事务中执行查询

await connection.transaction((ctx) async {
    var result = await ctx.query("SELECT id FROM table");
    await ctx.query("INSERT INTO table (id) VALUES (@a:int4)",
        substitutionValues: {"a": result.last[0] + 1});
});

完整示例

以下是一个完整的示例，展示了如何使用 postgres_fork 插件进行数据库操作：

import 'package:postgres_fork/postgres.dart';

void main() async {
  // 创建连接
  final connection = PostgreSQLConnection(
    'localhost',
    5432,
    'data_base',
    username: 'postgres',
    password: 'pass',
    encoding: Windows1252Codec(allowInvalid: false),
  );

  // 打开连接
  await connection.open();
  
  // 设置客户端编码
  await connection.query('''SET client_encoding = 'win1252';''');

  final now1 = DateTime.parse(DateTime.now().toIso8601String());

  // 执行插入操作
  final res = await connection.query('''INSERT INTO public.favorites
  (id, date_register, description)
  VALUES (10, ?, ?) returning id''',
      substitutionValues: [now1, 'City Hall of São Paulo - Brazil'],
      placeholderIdentifier: PlaceholderIdentifier.onlyQuestionMark);

  print('result: $res');

  // 在事务中执行查询
  final res2 = await connection.transaction((ctx) {
    return ctx.query('SELECT * FROM public.favorites WHERE id=?',
        substitutionValues: [res.first.first],
        allowReuse: true,
        timeoutInSeconds: 10,
        placeholderIdentifier: PlaceholderIdentifier.onlyQuestionMark);
  });

  print('result: $res2');

  // 执行查询并返回映射结果
  final res3 = await connection.mappedResultsQuery(
      'SELECT * FROM public.favorites ORDER BY id desc LIMIT @limite',
      substitutionValues: {'limite': 10},
      placeholderIdentifier: PlaceholderIdentifier.atSign);

  print('result: $res3');

  // 关闭连接
  await connection.close();
}