Struct PgSettings 

pub struct PgSettings {
    pub database_dir: PathBuf,
    pub port: u16,
    pub user: String,
    pub password: String,
    pub auth_method: PgAuthMethod,
    pub persistent: bool,
    pub timeout: Option<Duration>,
    pub migration_dir: Option<PathBuf>,
}

Configuration for a single embedded PostgreSQL instance.

Fields

database_dir: PathBuf

Directory that will hold the PostgreSQL cluster data files.

Created automatically if it does not exist. When Self::persistent is false this directory (and Self::database_dir with a .pwfile extension) is removed when PgEmbed is dropped.

port: u16

TCP port PostgreSQL will listen on.

user: String

Name of the initial database superuser.

password: String

Password for the superuser, written to a temporary password file and passed to initdb via --pwfile.

auth_method: PgAuthMethod

Authentication method written to pg_hba.conf by initdb.

persistent: bool

If false, the cluster directory and password file are deleted when the PgEmbed instance is dropped. Set to true to keep the data across runs.

timeout: Option<Duration>

Maximum time to wait for initdb, pg_ctl start, and pg_ctl stop to complete.

None disables the timeout (the process is waited on indefinitely). Exceeding the timeout returns Error::PgTimedOutError.

migration_dir: Option<PathBuf>

Directory containing .sql migration files.

When Some, PgEmbed::migrate will run all migrations found in this directory via sqlx. None disables migrations. Requires the rt_tokio_migrate feature.