upgrade to postgres v3

Author: hpoul

CHANGELOG.md

@@ -1,3 +1,7 @@
+## 2.0.0-rc.1
+
+- Migrate to `postgres` v3.
+
 ## 1.0.0
 
 - Initial version.

example/lib/main.dart

@@ -2,16 +2,16 @@ import 'package:logging/logging.dart';
 import 'package:logging_appenders/logging_appenders.dart';
 import 'package:postgres/postgres.dart';
 import 'package:postgres_utils/postgres_utils.dart';
+import 'package:uuid/data.dart';
+import 'package:uuid/rng.dart';
 import 'package:uuid/uuid.dart';
-import 'package:uuid/uuid_util.dart';
 
 final _logger = Logger('main');
 
-const Uuid _uuid = Uuid(options: <String, dynamic>{'grng': UuidUtil.cryptoRNG});
+final Uuid _uuid = Uuid(goptions: GlobalOptions(CryptoRNG()));
 
 class DatabaseTransaction extends DatabaseTransactionBase<MyTables> {
-  DatabaseTransaction(PostgreSQLExecutionContext conn, MyTables tables)
-      : super(conn, tables);
+  DatabaseTransaction(TxSession conn, MyTables tables) : super(conn, tables);
 }
 
 class DatabaseAccess extends DatabaseAccessBase<DatabaseTransaction, MyTables> {
@@ -25,7 +25,7 @@ class DatabaseAccess extends DatabaseAccessBase<DatabaseTransaction, MyTables> {
 
   @override
   DatabaseTransaction createDatabaseTransaction(
-      PostgreSQLExecutionContext conn, MyTables tables) {
+      TxSession conn, MyTables tables) {
     return DatabaseTransaction(conn, tables);
   }
 }

example/pubspec.yaml

@@ -7,8 +7,8 @@ environment:
   sdk: '>=2.12.0 <3.0.0'
 
 dependencies:
-  postgres: ^2.4.1+2
-  uuid: ^3.0.4
+  postgres: ^3.2.0
+  uuid: ^4.4.0
   logging_appenders: ^1.0.0
   postgres_utils:
     path: ../

lib/src/database_access.dart

@@ -2,6 +2,8 @@ import 'package:clock/clock.dart';
 import 'package:logging/logging.dart';
 import 'package:meta/meta.dart';
 import 'package:postgres/postgres.dart';
+// ignore: implementation_imports
+import 'package:postgres/src/types/type_registry.dart' show TypeRegistryExt;
 import 'package:postgres_utils/src/config.dart';
 import 'package:postgres_utils/src/tables/base_tables.dart';
 import 'package:postgres_utils/src/tables/migration_tables.dart';
@@ -26,7 +28,7 @@ abstract class OnConflictAction {
 class DatabaseTransactionBase<TABLES extends TablesBase> {
   DatabaseTransactionBase(this._conn, this.tables);
 
-  final PostgreSQLExecutionContext _conn;
+  final TxSession _conn;
   final TABLES tables;
   static final columnNamePattern = RegExp(r'^[a-z_]+$');
 
@@ -155,14 +157,13 @@ class DatabaseTransactionBase<TABLES extends TablesBase> {
       _logger.finest('Executing query: $fmtString with values: $values');
 
       final int result;
-      if (useExtendedQuery) {
-        final sqlResult = await _conn.query(fmtString,
-            substitutionValues: values, timeoutInSeconds: timeoutInSeconds);
-        result = sqlResult.affectedRowCount;
-      } else {
-        result = await _conn.execute(fmtString,
-            substitutionValues: values, timeoutInSeconds: timeoutInSeconds);
-      }
+      final sqlResult = await query(
+        fmtString,
+        values: values,
+        timeoutInSeconds: timeoutInSeconds,
+        queryMode: useExtendedQuery ? QueryMode.extended : null,
+      );
+      result = sqlResult.affectedRows;
       if (expectedResultCount != null && result != expectedResultCount) {
         throw StateError(
             'Expected result: $expectedResultCount but got $result. '
@@ -176,17 +177,22 @@ class DatabaseTransactionBase<TABLES extends TablesBase> {
     }
   }
 
-  Future<PostgreSQLResult> query(String fmtString,
-      {Map<String, Object?>? values,
-      bool allowReuse = true,
-      int? timeoutInSeconds}) async {
+  Future<Result> query(
+    String fmtString, {
+    Map<String, Object?>? values,
+    bool allowReuse = true,
+    int? timeoutInSeconds,
+    QueryMode? queryMode,
+  }) async {
     assert(_assertCorrectValues(values));
     try {
       // _logger.finest('QUERY: $fmtString');
-      return _conn.query(fmtString,
-          substitutionValues: values,
-          allowReuse: allowReuse,
-          timeoutInSeconds: timeoutInSeconds);
+      return _conn.execute(Sql.named(fmtString),
+          parameters: values,
+          queryMode: queryMode,
+          timeout: timeoutInSeconds == null
+              ? null
+              : Duration(seconds: timeoutInSeconds));
     } catch (e, stackTrace) {
       _logger.warning(
           'Error while running statement $fmtString', e, stackTrace);
@@ -196,29 +202,30 @@ class DatabaseTransactionBase<TABLES extends TablesBase> {
 }
 
 class CustomBind {
-  CustomBind(this._bind, this.value, {this.type});
+  CustomBind(this._bind, this.value, {Type? type}) : _type = type;
   final String _bind;
   final Object value;
-  final PostgreSQLDataType? type;
+  final Type? _type;
 
   String formatString(String bindName) => _bind;
 }
 
 class CustomTypeBind extends CustomBind {
-  factory CustomTypeBind(PostgreSQLDataType type, Object value) {
+  factory CustomTypeBind(Type type, Object value) {
     // _bindCount.to
     return CustomTypeBind._(
       '',
       value,
       type,
     );
   }
-  CustomTypeBind._(String bind, Object value, PostgreSQLDataType type)
+  CustomTypeBind._(String bind, Object value, Type type)
       : super(bind, value, type: type);
 
   @override
-  String formatString(String bindName) =>
-      '${PostgreSQLFormat.id(bindName)}::jsonb';
+  String formatString(String bindName) => _type == null
+      ? '@$bindName'
+      : '@$bindName::${TypeRegistry().lookupTypeName(_type)}';
 }
 
 abstract class DatabaseAccessBase<TX extends DatabaseTransactionBase<TABLES>,
@@ -233,20 +240,19 @@ abstract class DatabaseAccessBase<TX extends DatabaseTransactionBase<TABLES>,
   final DatabaseConfig config;
   final MigrationsProvider<TX, TABLES> migrations;
 
-  PostgreSQLConnection? _conn;
+  Connection? _conn;
 
-  Future<PostgreSQLConnection> _connection() async {
+  Future<Connection> _connection() async {
     if (_conn != null) {
       return _conn!;
     }
-    final conn = PostgreSQLConnection(
-      config.host,
-      config.port,
-      config.databaseName,
+    final conn = await Connection.open(Endpoint(
+      host: config.host,
+      port: config.port,
+      database: config.databaseName,
       username: config.username,
       password: config.password,
-    );
-    await conn.open();
+    ));
     return _conn = conn;
   }
 
@@ -273,15 +279,17 @@ abstract class DatabaseAccessBase<TX extends DatabaseTransactionBase<TABLES>,
       });
 
   Future<T> _transaction<T>(
-      Future<T> Function(PostgreSQLExecutionContext conn) queryBlock) async {
+      Future<T> Function(TxSession conn) queryBlock) async {
     final conn = await _connection();
-    final dynamic result = await conn.transaction(queryBlock);
-    if (result is T) {
-      return result;
-    }
-    throw Exception(
-        'Error running in transaction, $result (${result.runtimeType})'
-        ' is not ${T.runtimeType}');
+    return conn.runTx((session) async {
+      final dynamic result = await queryBlock(session);
+      if (result is T) {
+        return result;
+      }
+      throw Exception(
+          'Error running in transaction, $result (${result.runtimeType})'
+          ' is not ${T.runtimeType}');
+    });
   }
 
   Future<void> prepareDatabase() async {
@@ -362,7 +370,7 @@ abstract class DatabaseAccessBase<TX extends DatabaseTransactionBase<TABLES>,
   }
 
   @protected
-  TX createDatabaseTransaction(PostgreSQLExecutionContext conn, TABLES tables);
+  TX createDatabaseTransaction(TxSession conn, TABLES tables);
 }
 
 //extension on SqlClientBase {

lib/src/tables/base_tables.dart

@@ -7,7 +7,7 @@ abstract class TableBase {
   List<String> get types => const [];
 }
 
-abstract class TableConstants {
+abstract mixin class TableConstants {
   final columnId = 'id';
   String get specColumnIdPrimaryKey => '$columnId uuid primary key';
 
@@ -23,15 +23,14 @@ abstract class TableConstants {
       'DEFAULT CURRENT_TIMESTAMP';
 }
 
-extension FuturePostgreSQL on Future<PostgreSQLResult> {
-  Future<T?> singleOrNull<T>(
-          FutureOr<T?> Function(PostgreSQLResultRow row) cb) =>
+extension FuturePostgreSQL on Future<Result> {
+  Future<T?> singleOrNull<T>(FutureOr<T?> Function(ResultRow row) cb) =>
       then((value) => value.singleOrNull<FutureOr<T?>>(cb));
-  Future<PostgreSQLResultRow> get single => then((value) => value.single);
+  Future<ResultRow> get single => then((value) => value.single);
 }
 
-extension PostgreSQLResultExt on PostgreSQLResult {
-  T? singleOrNull<T>(T Function(PostgreSQLResultRow row) cb) {
+extension PostgreSQLResultExt on Result {
+  T? singleOrNull<T>(T Function(ResultRow row) cb) {
     if (isEmpty) {
       return null;
     }

pubspec.yaml

@@ -1,22 +1,22 @@
 name: postgres_utils
 description: A few utils for working with postgresql databases.
-version: 1.0.0
+version: 2.0.0-rc.1
 homepage: https://github.com/authpass/postgres_utils.dart
 issue_tracker: https://github.com/authpass/postgres_utils.dart/issues
 
 environment:
-  sdk: '>=2.12.0 <3.0.0'
+  sdk: '>=3.3.0 <4.0.0'
 
 dependencies:
   quiver: ^3.0.0
   meta: ^1.3.0
   clock: ^1.1.0
   logging: ^1.0.0
-  postgres: ^2.3.0
+  postgres: ^3.2.0
   json_annotation: ^4.0.1
 
 dev_dependencies:
-  json_serializable: ^5.0.0
+  json_serializable: ^6.8.0
   pedantic: ^1.11.0
   test: ^1.16.8
   build_runner: ^2.1.2