Struct PgTempDBBuilder 

pub struct PgTempDBBuilder {
    pub temp_dir_prefix: Option<PathBuf>,
    pub db_user: Option<String>,
    pub password: Option<String>,
    pub port: Option<u16>,
    pub dbname: Option<String>,
    pub persist_data_dir: bool,
    pub dump_path: Option<PathBuf>,
    pub load_path: Option<PathBuf>,
    pub server_configs: HashMap<String, String>,
    pub initdb_args: HashMap<String, String>,
    pub bin_path: Option<PathBuf>,
}

Builder struct for PgTempDB.

Fields

temp_dir_prefix: Option<PathBuf>

The directory in which to store the temporary PostgreSQL data directory.

db_user: Option<String>

The cluster superuser created with initdb. Default: postgres

password: Option<String>

The password for the cluster superuser. Default: password

port: Option<u16>

The port the server should run on. Default: random unused port.

dbname: Option<String>

The name of the database to create on startup. Default: postgres.

persist_data_dir: bool

Do not delete the data dir when the PgTempDB is dropped.

dump_path: Option<PathBuf>

The path to dump the database to (via pg_dump) when the PgTempDB is dropped.

load_path: Option<PathBuf>

The path to load the database from (via psql) when the PgTempDB is started.

server_configs: HashMap<String, String>

Other server configuration data to be set in postgresql.conf via initdb -c

initdb_args: HashMap<String, String>

Direct arguments to pass to the initdb binary (e.g. –encoding=UTF8), distinct from postgres configs (-c)

bin_path: Option<PathBuf>

Prefix PostgreSQL binary names (initdb, createdb, and postgres) with this path, instead of searching $PATH

Implementations

impl PgTempDBBuilder

pub fn new() -> PgTempDBBuilder

Create a new PgTempDBBuilder

pub fn from_connection_uri(conn_uri: &str) -> Self

Parses the parameters out of a PostgreSQL connection URI and inserts them into the builder.

pub fn start(self) -> PgTempDB

Creates the temporary data directory and starts the PostgreSQL server with the configured parameters.

If the current user is root, will attempt to run the initdb and postgres commands as the postgres user.

pub async fn start_async(self) -> PgTempDB

Convenience function for calling spawn_blocking(self.start())

pub fn with_data_dir_prefix(self, prefix: impl AsRef<Path>) -> Self

Set the directory in which to put the (temporary) PostgreSQL data directory. This is not the data directory itself: a new temporary directory is created inside this one.

pub fn with_config_param(self, key: &str, value: &str) -> Self

Set an arbitrary PostgreSQL server configuration parameter that will passed to the postgresql process at runtime.

pub fn with_initdb_arg(self, key: &str, value: &str) -> Self

Set an arbitrary argument that will be passed directly to the initdb binary during database initialization. These are direct arguments like –encoding or –locale, not configuration parameters that get written to postgresql.conf (use with_config_param for those).

pub fn with_bin_path(self, path: impl AsRef<Path>) -> Self

Set the directory that contains binaries like initdb, createdb, and postgres.

pub fn with_username(self, username: &str) -> Self

Set the user name

pub fn with_password(self, password: &str) -> Self

Set the user password

pub fn with_port(self, port: u16) -> Self

Set the port

pub fn with_dbname(self, dbname: &str) -> Self

Set the database name

pub fn persist_data(self, persist: bool) -> Self

If set, the postgres data directory will not be deleted when the PgTempDB is dropped.

pub fn dump_database(self, path: &Path) -> Self

If set, the database will be dumped via the pg_dump utility to the given location on drop or upon calling PgTempDB::shutdown.

pub fn load_database(self, path: &Path) -> Self

If set, the database will be loaded via psql from the given script on startup.

pub fn get_user(&self) -> String

Get user if set or return default

pub fn get_password(&self) -> String

Get password if set or return default

pub fn get_port_or_set_random(&mut self) -> u16

Unlike the other getters, this getter will try to open a new socket to find an unused port, and then set it as the current port.

pub fn get_dbname(&self) -> String

Get dbname if set or return default

Trait Implementations

impl Clone for PgTempDBBuilder

fn clone(&self) -> PgTempDBBuilder

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PgTempDBBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for PgTempDBBuilder

fn default() -> PgTempDBBuilder

Returns the “default value” for a type.