create example. update dependencies, etc.

Author: hpoul

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 codeux.design / Herbert Poul
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,22 +1,17 @@
-A library for Dart developers.
+A few utilities to make it easier to work with postgresql database.
 
-Created from templates made available by Stagehand under a BSD-style
-[license](https://github.com/dart-lang/stagehand/blob/master/LICENSE).
+Uses the pub [postgres](https://pub.dev/packages/postgres) package internally
 
 ## Usage
 
-A simple usage example:
+see [example/lib/main.dart](example/lib/main.dart).
 
-```dart
-import 'package:postgres_utils/postgres_utils.dart';
+## Examples
 
-main() {
-  var awesome = new Awesome();
-}
-```
+Check out https://github.com/authpass/authpass-cloud for a project using this package.
 
 ## Features and bugs
 
 Please file feature requests and bugs at the [issue tracker][tracker].
 
-[tracker]: http://example.com/issues/replaceme
+[tracker]: https://github.com/authpass/postgres_utils.dart/issues

example/lib/main.dart

@@ -0,0 +1,64 @@
+import 'package:postgres/postgres.dart';
+import 'package:postgres_utils/postgres_utils.dart';
+
+class DatabaseTransaction extends DatabaseTransactionBase<MyTables> {
+  DatabaseTransaction(PostgreSQLExecutionContext conn, MyTables tables)
+      : super(conn, tables);
+}
+
+class DatabaseAccess extends DatabaseAccessBase<DatabaseTransaction, MyTables> {
+  DatabaseAccess({
+    required DatabaseConfig config,
+  }) : super(
+          config: config,
+          tables: MyTables(),
+          migrations: MyMigrationsProvider(),
+        );
+
+  @override
+  DatabaseTransaction createDatabaseTransaction(
+      PostgreSQLExecutionContext conn, MyTables tables) {
+    return DatabaseTransaction(conn, tables);
+  }
+}
+
+class MyTables extends TablesBase {
+  MyTables();
+
+  late final UserTable user = UserTable();
+  @override
+  List<TableBase> get tables => [
+        user,
+      ];
+}
+
+class UserTable extends TableBase {
+  UserTable();
+
+  static const TABLE_USER = 'user';
+
+  @override
+  List<String> get tables => [
+        TABLE_USER,
+      ];
+
+  Future<void> createTables(DatabaseTransaction db) async {
+    await db.execute('''
+    CREATE TABLE $TABLE_USER (id uuid primary key, username varchar)
+    ''');
+  }
+}
+
+class MyMigrationsProvider
+    extends MigrationsProvider<DatabaseTransaction, MyTables> {
+  @override
+  List<Migrations<DatabaseTransaction, MyTables>> get migrations {
+    return [
+      Migrations(
+          id: 1,
+          up: (conn) async {
+            await conn.tables.user.createTables(conn);
+          }),
+    ];
+  }
+}

example/pubspec.yaml

@@ -0,0 +1,12 @@
+name: example
+description: Example app
+# version: 1.0.0
+# homepage: https://www.example.com
+
+environment:
+  sdk: '>=2.12.0 <3.0.0'
+
+dependencies:
+  postgres: ^2.4.1+2
+  postgres_utils:
+    path: ../

lib/src/config.g.dart

@@ -1,7 +1,8 @@
 name: postgres_utils
-description: A starting point for Dart libraries or applications.
-# version: 1.0.0
-# homepage: https://www.example.com
+description: A few utils for working with postgresql databases.
+version: 1.0.0
+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'
@@ -15,7 +16,7 @@ dependencies:
   json_annotation: ^4.0.1
 
 dev_dependencies:
-  json_serializable: ^4.1.0
+  json_serializable: ^5.0.0
   pedantic: ^1.11.0
   test: ^1.16.8
-  build_runner: ^1.10.0
+  build_runner: ^2.1.2