Struct PgEnvCfg 

pub struct PgEnvCfg {

    pub version_req: Option<String>,
    pub port: Option<u16>,
    pub superuser: Option<String>,
    pub password: Option<String>,
    pub data_dir: Option<Utf8PathBuf>,
    pub runtime_dir: Option<Utf8PathBuf>,
    pub locale: Option<String>,
    pub encoding: Option<String>,
    pub binary_cache_dir: Option<Utf8PathBuf>,
    pub embed_root: Option<Utf8PathBuf>,
    pub max_connections: Option<u32>,
    pub extensions: Option<String>,
    pub extensions_manifest: Option<String>,
    pub extensions_manifest_sha256: Option<String>,
    pub extensions_cache_dir: Option<Utf8PathBuf>,
}

Captures PostgreSQL settings supplied via environment variables.

Examples

use pg_embedded_setup_unpriv::PgEnvCfg;

let cfg = PgEnvCfg::default();
assert!(cfg.port.is_none());

Fields

version_req: Option<String>

Optional semver requirement that constrains the PostgreSQL version.

port: Option<u16>

Port assigned to the embedded PostgreSQL server.

superuser: Option<String>

Name of the administrative user created for the cluster.

password: Option<String>

Password provisioned for the administrative user.

data_dir: Option<Utf8PathBuf>

Directory used for PostgreSQL data files when provided.

runtime_dir: Option<Utf8PathBuf>

Directory containing the PostgreSQL binaries when provided.

locale: Option<String>

Locale applied to initdb when specified.

encoding: Option<String>

Encoding applied to initdb when specified.

binary_cache_dir: Option<Utf8PathBuf>

Directory for sharing downloaded PostgreSQL binaries across test runs.

When Some, this explicit path is used directly by TestCluster, bypassing the automatic resolution chain. When None, the cache directory is resolved in the following order:

1. PG_BINARY_CACHE_DIR environment variable (if set and non-empty)
2. $XDG_CACHE_HOME/pg-embedded/binaries (if XDG_CACHE_HOME is set)
3. $HOME/.cache/pg-embedded/binaries (if HOME is set)
4. /tmp/pg-embedded/binaries (final fallback)

embed_root: Option<Utf8PathBuf>

Base directory under which the default install and data directories are created (PG_EMBED_ROOT).

When unset the base is /var/tmp/pg-embed-{uid}, which every project on a host shares per user. Set it to give a project or a test run its own tree. PG_RUNTIME_DIR and PG_DATA_DIR still override the two leaves individually.

max_connections: Option<u32>

max_connections for the server (PG_MAX_CONNECTIONS).

Test clusters default to 20; set this when parallel test runners need more. Applied to every bootstrap, test or not. Values below MIN_MAX_CONNECTIONS are rejected when the settings are built.

extensions: Option<String>

Comma-separated extension names to install before the server starts (PG_EXTENSIONS, for example vector). Empty or unset disables the extension hook.

extensions_manifest: Option<String>

Location of the extension manifest (PG_EXTENSIONS_MANIFEST): an https:// URL, a loopback http:// URL, or a filesystem path, which is the rule the archives it names go through. Required when extensions is set.

extensions_manifest_sha256: Option<String>

Lower-case hex SHA-256 of the manifest bytes (PG_EXTENSIONS_MANIFEST_SHA256). Required for a URL manifest, loopback included; optional for a filesystem path.

extensions_cache_dir: Option<Utf8PathBuf>

Directory holding verified extension archives between runs (PG_EXTENSIONS_CACHE_DIR). Defaults to $XDG_CACHE_HOME/pg-embedded/extensions with the same fallbacks as binary_cache_dir.

Implementations

impl PgEnvCfg

pub fn load() -> Result<Self, ConfigError>

Loads configuration from environment variables without parsing CLI arguments.

Errors

Returns an error when environment parsing fails or derived configuration cannot be represented using UTF-8 paths.

pub fn to_settings(&self) -> Result<Settings>

Converts the configuration into a complete postgresql_embedded::Settings object.

Applies version, connection, path, and locale settings from the current configuration. Returns an error if the version requirement is invalid. This variant does not apply test-specific worker limits.

Examples

use pg_embedded_setup_unpriv::PgEnvCfg;

let cfg = PgEnvCfg::default();
let settings = cfg.to_settings()?;

Returns

A fully configured Settings instance on success, or an error if configuration fails.

Errors

Returns an error when the semantic version requirement cannot be parsed, or when PG_MAX_CONNECTIONS is below MIN_MAX_CONNECTIONS.

pub fn to_settings_for_tests(&self) -> Result<Settings>

Converts the configuration into Settings, applying test-only worker limits.

Use this helper for ephemeral test clusters where resource limits are desirable.

Examples

use pg_embedded_setup_unpriv::PgEnvCfg;

let cfg = PgEnvCfg::default();
let settings = cfg.to_settings_for_tests()?;

Errors

Returns an error when the semantic version requirement cannot be parsed, or when PG_MAX_CONNECTIONS is below MIN_MAX_CONNECTIONS.

pub fn to_settings_with_context(&self, for_tests: bool) -> Result<Settings>

Converts the configuration into Settings, optionally applying test limits.

Set for_tests to true to apply the worker limits intended for ephemeral test clusters.

Examples

use pg_embedded_setup_unpriv::PgEnvCfg;

let cfg = PgEnvCfg::default();
let settings = cfg.to_settings_with_context(true)?;

Errors

Returns an error when the semantic version requirement cannot be parsed, or when PG_MAX_CONNECTIONS is below MIN_MAX_CONNECTIONS.

Trait Implementations

impl Clone for PgEnvCfg

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PgEnvCfg

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

Formats the value using the given formatter.

impl Default for PgEnvCfg

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for PgEnvCfg

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl OrthoConfig for PgEnvCfg

fn load_from_iter<I, T>(iter: I) -> OrthoResult<Self>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Loads configuration from the provided iterator of command-line arguments.

fn prefix() -> &'static str

Prefix used for environment variables and subcommand configuration.

fn load() -> Result<Self, Arc<OrthoError>>

Loads configuration from command-line arguments, environment variables and configuration files using the standard precedence rules.

impl Serialize for PgEnvCfg

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.