Flutter纯 Dart 实现的 PostgreSQL 驱动程序插件dargres的探索使用

简介

dargres 是一个纯 Dart 实现的 PostgreSQL 驱动程序，旨在移植 Tony Locke 的 pg8000 Python 库。它受到多个开源项目的启发，并支持多种功能和特性。

主要特性

• 认证方式: 支持明文密码、MD5 密码和 SASL SCRAM-SHA-256。
• 连接方式: 支持无 SSL 和带 SSL 连接。
• 查询语句: 支持简单查询、未命名预处理语句和命名预处理语句。
• 事务: 支持 PHP PDO 风格和闭包风格的事务。
• 通知和消息: 支持数据库的通知和消息。
• 字符集支持: 支持 latin1、utf8、ascii 和 win1252。

示例代码

创建带有 SSL 的连接并执行简单查询

import 'dart:io';
import 'package:dargres/dargres.dart';

void main() async {
  var sslContext = SslContext.createDefaultContext();

  var con = CoreConnection(
    'user',
    database: 'dataBaseTest',
    host: 'localhost',
    port: 5432,
    password: '123456',    
    sslContext: sslContext,   
  );

  await con.connect();

  var results = await con.querySimple('select 1');
  print('results: $results');
  //results: [[1]]
  await con.close();
}

创建连接并执行简单查询

import 'package:dargres/dargres.dart';

void main() async {
  var con = CoreConnection(
    'user',
    database: 'dataBaseTest',
    host: 'localhost',
    port: 5432,
    password: '123456',       
  );

  await con.connect();

  var results = await con.querySimple('select 1');
  print('results: $results');
  //result [[1]]
  await con.close();
}

创建连接并执行查询（包括未命名预处理语句和简单查询）

import 'dart:io';
import 'package:dargres/dargres.dart';

void main() async {
  var sslContext = SslContext.createDefaultContext();

  var con = CoreConnection(
    'username', 
    database: 'dataBaseTest',
    host: 'localhost', 
    port: 5432,
    password: '123456', 
    allowAttemptToReconnect: false,
    sslContext: sslContext,
  );
  
  await con.connect();
  await con.execute('DROP SCHEMA IF EXISTS myschema CASCADE;');
  await con.execute('CREATE SCHEMA IF NOT EXISTS myschema;');
  await con.execute('SET search_path TO myschema;');

  await con.execute('''
        CREATE TABLE "myschema"."test_arrays" ( 
            name NAME,
            varchar_array_type varchar[], 
            int8_array_type int8[],
            int2_array_type int2[],
            names_array_type NAME[]  
        );
        ''');

  await con.queryUnnamed(r'''
INSERT INTO test_arrays
(name, varchar_array_type,int8_array_type, int2_array_type, names_array_type)
 VALUES 
($1, $2, $3, $4, $5);
''', ['Vagner',["João",'''Isaque Sant'Ana'''],[1,2,3],[1,2,3],['name1']]);

  var results = await con.querySimple(r'''SELECT * FROM test_arrays;''');

  for (var row in results) {
    print(row.toColumnMap());
    //Result: {name: Vagner, varchar_array_type: [João, Isaque Sant'Ana], int8_array_type: [1, 2, 3], int2_array_type: [1, 2, 3], names_array_type: [name1]}
  } 

  await con.close();
  exit(0);
}

执行 PHP PDO 风格的事务

import 'package:dargres/dargres.dart';

void main() async {
  var con = CoreConnection(
    'user',
    database: 'dataBaseTest',
    host: 'localhost',
    port: 5432,
    password: '123456',       
  );

  await con.connect();

  final transaction = await con.beginTransaction();
  try {
    await transaction.querySimple(
      """INSERT INTO "people" ("name", "dateRegister") VALUES ('Alex', '2022-11-30 16:22:03') returning id""");
    await con.commit(transaction);
  } catch (e) {
    await con.rollBack(transaction);
  }

  await con.close();
}

使用闭包执行事务

import 'package:dargres/dargres.dart';

void main() async {
  var con = CoreConnection(
    'user',
    database: 'dataBaseTest',
    host: 'localhost',
    port: 5432,
    password: '123456',       
  );

  await con.connect();

  await con.runInTransaction((ctx) async {
    return ctx.querySimple(
      """INSERT INTO "people" ("name", "dateRegister") VALUES ('Alex', '2022-11-30 16:22:03') returning id""");
  });

  await con.close();
}

监听数据库通知

import 'dart:async';
import 'package:dargres/dargres.dart';

void main() async {
  var con = CoreConnection(
    'user',
    database: 'dataBaseTest',
    host: 'localhost',
    port: 5432,
    password: '123456',       
  );

  await con.connect();

  con.notifications.listen((event) async {
    print('$event');
    //Result: {backendPid: 9188, channel: db_change_event, payload: This is the payload}
  });
  
  await con.execute('LISTEN "db_change_event"');
  Timer.periodic(Duration(seconds: 2), (t) async {
    await con.execute("NOTIFY db_change_event, 'This is the payload'");
  });

  await con.close();
}

总结

dargres 是一个功能丰富的 PostgreSQL 驱动程序，适用于 Dart 开发者在 Flutter 或其他 Dart 项目中与 PostgreSQL 数据库进行交互。通过上述示例，您可以快速上手并实现各种数据库操作。