drift/extras/drift_postgres
Simon Binder 417d1f59d9 Fix generating variables with custom types 2023-12-10 14:23:19 +01:00
..
example Fix generating variables with custom types 2023-12-10 14:23:19 +01:00
lib Update to postgres 3.0.0 2023-11-15 11:35:45 +01:00
test Update to postgres 3.0.0 2023-11-15 11:35:45 +01:00
.gitignore PostgreSQL support (#1507) 2021-11-11 14:40:41 +01:00
CHANGELOG.md Update to postgres 3.0.0 2023-11-15 11:35:45 +01:00
LICENSE Prepare to publish drift postgres 2023-10-20 12:04:14 +02:00
README.md Update to postgres 3.0.0 2023-11-15 11:35:45 +01:00
analysis_options.yaml Fix lints and warnings added in Dart 3.0 2023-05-12 22:42:21 +02:00
pubspec.yaml Update to postgres 3.0.0 2023-11-15 11:35:45 +01:00

README.md

package:drift_postgres extends drift to support talking to PostgreSQL databases by using the postgres package.

Using this

For general notes on using drift, see this guide.

To use drift_postgres, add this to your pubspec.yaml

dependencies:
  drift: "$latest version"
  drift_postgres: ^0.1.0

To connect your drift database class to postgres, use a PgDatabase from package:drift_postgres/postgres.dart:

final database = AppDatabase(PgDatabase(
  endpoint: PgEndpoint(
    host: 'localhost',
    database: 'postgres',
    username: 'postgres',
    password: 'postgres',
  ),
));

Running tests

To test this package, first run

docker run -p 5432:5432 -e POSTGRES_USER=postgres -e POSTGRES_PASSWORD=postgres postgres

It can then be tested with dart test -j 1 (concurrency needs to be disabled since tests are using the same database).