pg-embed

Run a Postgresql database locally on Linux, MacOS or Windows as part of another Rust application or test.

The currently supported async runtime for pg-embed is tokio.

Support for async-std and actix is planned and will be available soon.

Usage

Add pg-embed to your Cargo.toml

Library without sqlx migration support

# Cargo.toml
[dependencies]
pg-embed = { version = "0.3", default-features = false, features = ["rt_tokio"] }

Library with sqlx migration support

# Cargo.toml
[dependencies]
pg-embed = "0.3"

A postgresql instance can be created using PgEmbed::new(PgSettings, FetchSettings)

Examples

use pg_embed::postgres::{PgEmbed, PgSettings};
use pg_embed::fetch;
use pg_embed::fetch::{OperationSystem, Architecture, FetchSettings, PG_V13};
use std::time::Duration;

/// Postgresql settings
let pg_settings = PgSettings{
    /// Where to store the postgresql executables
    executables_dir: "data/postgres".to_string(),
    /// Where to store the postgresql database
    database_dir: "data/db".to_string(),
    port: 5432,
    user: "postgres".to_string(),
    password: "password".to_string(),
    /// If persistent is false clean up files and directories on drop, otherwise keep them
    persistent: false,
    start_timeout: Duration::from_secs(15),
    /// If migration sql scripts need to be run, the directory containing those scripts can be
    /// specified here with `Some(path_to_dir), otherwise `None` to run no migrations.
    /// The library `feature = ["migrate"]` needs to be set to enable this functionality.
    migration_dir: None,
};

/// Postgresql binaries download settings
let fetch_settings = FetchSettings{
    host: "https://repo1.maven.org".to_string(),
    operating_system: OperationSystem::Darwin,
    architecture: Architecture::Amd64,
    version: PG_V13
};

/// Create a new instance
let mut pg = PgEmbed::new(pg_settings, fetch_settings);

/// async block only to show that these methods need to be executed in an async context
async {
    /// Download, unpack, create password file and database cluster
    pg.setup().await;

    /// start postgresql database
    pg.start_db().await;

    /// create a new database
    /// library `feature = ["migrate"]` needs to be set
    # pg.create_database("database_name").await;

    /// drop a new database
    /// library `feature = ["migrate"]` needs to be set
    # pg.drop_database("database_name").await;

    /// check database existence
    /// library `feature = ["migrate"]` needs to be set
    # pg.database_exists("database_name").await;

    /// run migration sql scripts
    /// library `feature = ["migrate"]` needs to be set
    # pg.migrate("database_name").await;
};
    /// get the base postgresql uri
    /// `postgres://{username}:{password}@localhost:{port}`
    let pg_uri: &str = &pg.db_uri;

    /// get a postgresql database uri
    /// `postgres://{username}:{password}@localhost:{port}/{specified_database_name}`
    let pg_db_uri: String = pg.full_db_uri("database_name");

    /// stop postgresql database
    pg.stop_db();

Recent Breaking Changes

pg-embed follows semantic versioning, so breaking changes should only happen upon major version bumps. The only exception to this rule is breaking changes that happen due to implementation that was deemed to be a bug, security concerns, or it can be reasonably proved to affect no code. For the full details, see CHANGELOG.md.

License

pg-embed is licensed under the MIT license. Please read the LICENSE-MIT file in this repository for more information.

Notes