Struct pg_embed::pg_access::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,
}

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) -> Result<bool, PgEmbedError>

Check if postgresql executables are already cached

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

Check if database directory exists

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

Write pg binaries zip to postgresql cache directory

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

Clean up created files and directories.

Remove created directories containing the database and the password file.

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

Create a database password file

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

pub fn init_db_command(
    &self,
    database_dir: &PathBuf,
    user: &str,
    auth_method: &PgAuthMethod
) -> Box<Cell<Command>>

Create initdb command

pub fn start_db_command(
    &self,
    database_dir: &PathBuf,
    port: i16
) -> Box<Cell<Command>>

Create pg_ctl start command

pub fn stop_db_command(&self, database_dir: &PathBuf) -> Box<Cell<Command>>

Create pg_ctl stop command