Struct Pgrx

pub struct Pgrx { /* private fields */ }

Implementations

impl Pgrx

pub fn new(base_port: u16, base_testing_port: u16) -> Self

pub fn from_config() -> Result<Self>

pub fn push(&mut self, pg_config: PgConfig)

pub fn iter( &self, which: PgConfigSelector<'_>, ) -> impl Iterator<Item = Result<PgConfig>>

Returns an iterator of all “configured” PgConfigs we know about.

If the which argument is PgConfigSelector::All and the environment variable PGRX_PG_CONFIG_AS_ENV is set to a value that isn’t "false"then this function will return a one-element iterator that represents that single “pg_config”.

Otherwise, we’ll follow the rules of PgConfigSelector::All being everything in $PGRX_HOME/config.toml, PgConfigSelector::Specific being that specific version from $PGRX_HOME/config.toml, and PgConfigSelector::Environment being the one described in the environment.

pub fn get(&self, label: &str) -> Result<PgConfig>

pub fn is_feature_flag(&self, label: &str) -> bool

Returns true if the specified label represents a Postgres version number feature flag, such as pg14 or pg15

pub fn home() -> Result<PathBuf, PgrxHomeError>

pub fn postmaster_stub_dir() -> Result<PathBuf, Error>

Get the postmaster stub directory

We isolate postmaster stubs to an independent directory instead of alongside the postmaster because in the case of cargo pgrx install the pg_config may not necessarily be one managed by pgrx.

pub fn config_toml() -> Result<PathBuf, Error>

Trait Implementations

impl Debug for Pgrx

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

Formats the value using the given formatter.

impl Default for Pgrx

fn default() -> Self

Returns the “default value” for a type.