Struct PgAccess

pub struct PgAccess {
    pub cache_dir: PathBuf,
    pub database_dir: PathBuf,
    pub pg_ctl_exe: PathBuf,
    pub init_db_exe: PathBuf,
    pub pw_file_path: PathBuf,
    pub zip_file_path: PathBuf,
    /* private fields */
}

Access to pg_ctl, initdb, database directory and cache directory

Fields

cache_dir: PathBuf

Cache directory path

database_dir: PathBuf

Database directory path

pg_ctl_exe: PathBuf

Postgresql pg_ctl executable path

init_db_exe: PathBuf

Postgresql initdb executable path

pw_file_path: PathBuf

Password file path

zip_file_path: PathBuf

Postgresql binaries zip file path

Implementations

impl PgAccess

pub async fn new( fetch_settings: &PgFetchSettings, database_dir: &PathBuf, ) -> Result<Self, PgEmbedError>

Create a new instance

Directory structure for cached postgresql binaries will be created

pub async fn pg_executables_cached(&self) -> PgResult<bool>

Check if postgresql executables are already cached

pub async fn db_files_exist(&self) -> PgResult<bool>

Check if database files exist

pub async fn pg_version_file_exists(db_dir: &PathBuf) -> PgResult<bool>

Check if database version file exists

pub async fn mark_acquisition_in_progress(&self) -> PgResult<()>

Mark postgresql binaries acquisition in progress

Used while acquiring postgresql binaries, so that no two instances of PgEmbed try to acquire the same resources

pub async fn mark_acquisition_finished(&self) -> PgResult<()>

Mark postgresql binaries acquisition finished

Used when acquiring postgresql has finished, so that other instances of PgEmbed don’t try to reacquire resources

pub async fn acquisition_status(&self) -> PgAcquisitionStatus

Check postgresql acquisition status

pub async fn acquisition_needed(&self) -> PgResult<bool>

Determine if postgresql binaries acquisition is needed

pub async fn write_pg_zip(&self, bytes: &[u8]) -> PgResult<()>

Write pg binaries zip to postgresql cache directory

pub fn clean(&self) -> PgResult<()>

Clean up created files and directories.

Remove created directories containing the database and the password file.

pub async fn purge() -> PgResult<()>

Purge postgresql executables

Remove all cached postgresql executables

pub async fn clean_up(database_dir: PathBuf, pw_file: PathBuf) -> PgResult<()>

Clean up database directory and password file

pub async fn create_password_file(&self, password: &[u8]) -> PgResult<()>

Create a database password file

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

pub fn stop_db_command_sync(&self, database_dir: &PathBuf) -> PgCommandSync

Create synchronous pg_ctl stop command