Struct pg_embed::postgres::PgEmbed

pub struct PgEmbed {
    pub pg_settings: PgSettings,
    pub fetch_settings: FetchSettings,
    pub process: Option<Child>,
    pub db_uri: String,
}

Embedded postgresql database

If the PgEmbed instance is dropped / goes out of scope and postgresql is still running, the postgresql process will be killed and depending on the PgSettings::persistent setting, file and directories will be cleaned up.

Fields

pg_settings: PgSettings

Postgresql settings

fetch_settings: FetchSettings

Download settings

process: Option<Child>

The postgresql process

Some(process) if process is running, otherwise None

db_uri: String

Implementations

impl PgEmbed

pub fn new(pg_settings: PgSettings, fetch_settings: FetchSettings) -> Self

Create a new PgEmbed instance

pub fn clean(&self) -> Result<(), PgEmbedError>

Clean up created files and directories.

Remove created directories containing the postgresql executables, the database and the password file.

pub async fn setup(&self) -> Result<(), PgEmbedError>

Setup postgresql for execution

Download, unpack, create password file and database

pub async fn aquire_postgres(&self) -> Result<(), PgEmbedError>

Download and unpack postgres binaries

pub async fn init_db(&self) -> Result<bool, PgEmbedError>

Initialize postgresql database

Returns Ok(bool) on success (false if the database directory already exists, true if it needed to be created), otherwise returns an error.

pub async fn start_db(&mut self) -> Result<(), PgEmbedError>

Start postgresql database

Returns Ok(()) on success, otherwise returns an error.

pub fn stop_db(&mut self) -> Result<(), PgEmbedError>

Stop postgresql database

Returns Ok(()) on success, otherwise returns an error.

pub async fn create_password_file(&self) -> Result<(), PgEmbedError>

Create a database password file

Returns Ok(()) on success, otherwise returns an error.

pub async fn create_database(&self, db_name: &str) -> Result<(), PgEmbedError>

Create a database

pub async fn drop_database(&self, db_name: &str) -> Result<(), PgEmbedError>

Drop a database

pub async fn database_exists(&self, db_name: &str) -> Result<bool, PgEmbedError>

Check database existance

pub fn full_db_uri(&self, db_name: &str) -> String

The full database uri

(postgres://{username}:{password}@localhost:{port}/{db_name})

pub async fn migrate(&self, db_name: &str) -> Result<(), PgEmbedError>

Run migrations

Trait Implementations

impl Drop for PgEmbed

fn drop(&mut self)

Executes the destructor for this type.