#postgresql #sqlx #testing #helper #database #create #drop

pg-setup

Helper to create and drop postgres DBs. Useful for testing.

4 releases

0.2.0 Oct 7, 2023
0.1.2 May 18, 2023
0.1.1 May 17, 2023
0.1.0 Jan 15, 2023

#1719 in Development tools


Used in pg-taskq

MIT license

21KB
468 lines

pg-setup

Crates.io License

Simple helper to create and drop Postgres databases. Useful for tests.

This uses either the psql command line utility (default) or the sqlx and sqlx-cli (which makes use of sqlx migrations). Use the sqlx feature for that.

Example:

#
    let db_uri = "postgres://localhost:5432/pg_setup_example";

    let db = PostgresDBBuilder::new(db_uri)
        .schema("public")
        // optionally keep db
        .keep_db()
        .start()
        .await?;

    // optionally create a table
    db.create_table("users", |t| {
        t.add_column("id", "uuid", |c| c.primary_key());
        t.add_column("name", "text", |c| c.not_null());
        t.add_column("email", "text", |c| c.not_null());
        t.add_column("created_at", "timestamp", |c| c.not_null());
    })
    .await?;

    // execute sql
    db.execute("SELECT table_schema,table_name, table_type FROM information_schema.tables WHERE table_schema = 'public';").await?;

    // db will be dropped at the end of the scope, unless `keep_db` is called!

In case you want to keep the db around for debugging you can call PostgresDB::keep_db.

Will use the public schema by default but you can set this with PostgresDB::schema.

License: MIT

Dependencies

~12–26MB
~354K SLoC