Struct PgCommand 

pub struct PgCommand {}

Factories for the three PostgreSQL lifecycle commands.

Implementations

impl PgCommand

pub fn init_db_executor( init_db_exe: &Path, database_dir: &Path, pw_file_path: &Path, user: &str, auth_method: &PgAuthMethod, ) -> Result<AsyncCommandExecutor<PgServerStatus, Error, PgProcessType>>

Creates an AsyncCommandExecutor that runs initdb to initialise a new database cluster.

Arguments

• init_db_exe — Path to the initdb binary.
• database_dir — Target directory for the new cluster.
• pw_file_path — Path to the password file created by crate::pg_access::PgAccess::create_password_file.
• user — Name of the initial superuser.
• auth_method — Authentication method written to pg_hba.conf.

Errors

Returns Error::InvalidPgUrl if any of the path arguments cannot be converted to a UTF-8 string (required for the --pwfile= argument format). Returns Error::PgInitFailure if the process cannot be spawned.

pub fn start_db_executor( pg_ctl_exe: &Path, database_dir: &Path, port: &u16, ) -> Result<AsyncCommandExecutor<PgServerStatus, Error, PgProcessType>>

Creates an AsyncCommandExecutor that runs pg_ctl start.

Arguments

• pg_ctl_exe — Path to the pg_ctl binary.
• database_dir — The cluster directory passed to pg_ctl -D.
• port — TCP port PostgreSQL should listen on.

Errors

Returns Error::InvalidPgUrl if database_dir is not valid UTF-8. Returns Error::PgStartFailure if the process cannot be spawned.

pub fn stop_db_executor( pg_ctl_exe: &Path, database_dir: &Path, ) -> Result<AsyncCommandExecutor<PgServerStatus, Error, PgProcessType>>

Creates an AsyncCommandExecutor that runs pg_ctl stop.

Arguments

• pg_ctl_exe — Path to the pg_ctl binary.
• database_dir — The cluster directory passed to pg_ctl -D.

Errors

Returns Error::InvalidPgUrl if database_dir is not valid UTF-8. Returns Error::PgStopFailure if the process cannot be spawned.