Struct PgEmbed

pub struct PgEmbed {
    pub pg_settings: PgSettings,
    pub fetch_settings: PgFetchSettings,
    pub db_uri: String,
    pub server_status: Arc<Mutex<PgServerStatus>>,
    pub shutting_down: bool,
    pub pg_access: PgAccess,
}

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: PgFetchSettings

Download settings

db_uri: String

Database uri postgres://{username}:{password}@localhost:{port}

server_status: Arc<Mutex<PgServerStatus>>

Postgres server status

shutting_down: bool

pg_access: PgAccess

Postgres files access

Implementations

impl PgEmbed

pub async fn new( pg_settings: PgSettings, fetch_settings: PgFetchSettings, ) -> PgResult<Self>

Create a new PgEmbed instance

pub async fn setup(&mut self) -> PgResult<()>

Setup postgresql for execution

Download, unpack, create password file and database

pub async fn init_db(&mut self) -> PgResult<()>

Initialize postgresql database

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

pub async fn start_db(&mut self) -> PgResult<()>

Start postgresql database

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

pub async fn stop_db(&mut self) -> PgResult<()>

Stop postgresql database

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

pub fn stop_db_sync(&mut self) -> PgResult<()>

Stop postgresql database synchronous

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

pub fn handle_process_io_sync(&self, process: Child) -> PgResult<()>

Handle process logging synchronous

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

Create a database

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

Drop a database

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

Check database existence

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) -> PgResult<()>

Run migrations

Trait Implementations

impl Drop for PgEmbed

fn drop(&mut self)

Executes the destructor for this type.