pg_setup/
lib.rs

1/*!
2
3[![Crates.io](https://img.shields.io/crates/v/pg-setup)](https://crates.io/crates/pg-setup)
4[![](https://docs.rs/pg-setup/badge.svg)](https://docs.rs/pg-setup)
5[![License](https://img.shields.io/crates/l/pg-setup?color=informational&logo=mit)](/LICENSE.md)
6
7Simple helper to create and drop Postgres databases. Useful for tests.
8
9This uses either the psql command line utility (default) or the sqlx and sqlx-cli (which makes use of sqlx migrations).
10Use the `sqlx` feature for that.
11
12Example:
13```rust
14# use pg_setup::{PostgresDBBuilder, Result};
15#
16# #[tokio::main]
17# async fn main() -> Result<()> {
18    let db_uri = "postgres://localhost:5432/pg_setup_example";
19
20    let db = PostgresDBBuilder::new(db_uri)
21        .schema("public")
22        // optionally keep db
23        .keep_db()
24        .start()
25        .await?;
26
27    // optionally create a table
28    db.create_table("users", |t| {
29        t.add_column("id", "uuid", |c| c.primary_key());
30        t.add_column("name", "text", |c| c.not_null());
31        t.add_column("email", "text", |c| c.not_null());
32        t.add_column("created_at", "timestamp", |c| c.not_null());
33    })
34    .await?;
35
36    // execute sql
37    db.execute("SELECT table_schema,table_name, table_type FROM information_schema.tables WHERE table_schema = 'public';").await?;
38
39    // db will be dropped at the end of the scope, unless `keep_db` is called!
40
41#    Ok(())
42# }
43```
44
45In case you want to keep the db around for debugging you can call [`PostgresDB::keep_db`].
46
47Will use the `public` schema by default but you can set this with [`PostgresDB::schema`].
48
49*/
50
51mod db;
52mod db_cmd_strategy;
53mod db_url;
54mod error;
55mod shell;
56
57#[cfg(feature = "sqlx")]
58mod db_sqlx_strategy;
59mod table_builder;
60
61pub use db::{PostgresDB, PostgresDBBuilder};
62pub use error::{Error, Result};
63
64#[macro_use]
65extern crate tracing;
66
67#[macro_use]
68extern crate async_trait;
pg_setup/lib.rs

pg_setup/
lib.rs
