Struct OliphauntBuilder 

pub struct OliphauntBuilder { /* private fields */ }

Builder for opening persistent or temporary Oliphaunt databases.

Implementations

impl OliphauntBuilder

pub fn new() -> Self

Create a builder. Call path, app_id, or temporary before open.

pub fn path(self, root: impl Into<PathBuf>) -> Self

Open a persistent database rooted at root.

pub fn app( self, qualifier: impl Into<String>, organization: impl Into<String>, application: impl Into<String>, ) -> Self

Open a persistent database under the platform data directory.

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

Open a persistent database under the platform data directory.

pub fn temporary(self) -> Self

Open an ephemeral database removed when the instance is dropped.

Temporary databases use the process-local template cluster cache by default, avoiding repeated initdb work in test suites.

pub fn template_cache(self, enabled: bool) -> Self

Control whether new databases are cloned from the process-local or embedded PGDATA template cache.

pub fn fresh_temporary(self) -> Self

Open an ephemeral database with a fresh initdb.

This is a compatibility alias for temporary().template_cache(false). Fresh initdb uses the bundled split WASIX initdb module; cached temporary databases remain the production fast path.

pub fn postgres_config( self, name: impl Into<String>, value: impl Into<String>, ) -> Self

Set a PostgreSQL startup GUC for this embedded backend.

pub fn postgres_configs<K, V>( self, settings: impl IntoIterator<Item = (K, V)>, ) -> Self

where K: Into<String>, V: Into<String>,

Set multiple PostgreSQL startup GUCs for this embedded backend.

pub fn username(self, username: impl Into<String>) -> Self

Connect as a PostgreSQL role. The role must already exist in the cluster.

pub fn database(self, database: impl Into<String>) -> Self

Connect to a PostgreSQL database. The database must already exist in the cluster.

pub fn debug_level(self, level: DebugLevel) -> Self

Enable PostgreSQL debug logging level 0..=5 for the embedded backend.

pub fn relaxed_durability(self, enabled: bool) -> Self

Use lower durability settings for ephemeral or cacheable local workloads.

pub fn startup_arg(self, arg: impl Into<String>) -> Self

Append an advanced PostgreSQL startup argument. Prefer postgres_config for GUCs.

pub fn startup_args( self, args: impl IntoIterator<Item = impl Into<String>>, ) -> Self

Append advanced PostgreSQL startup arguments.

pub fn load_data_dir_archive(self, archive: impl Into<Vec<u8>>) -> Self

Load a previously dumped PGDATA tar archive before opening the database.

pub fn open(self) -> Result<Oliphaunt>

Install, initialize, and start the selected database.

Trait Implementations

impl Clone for OliphauntBuilder

fn clone(&self) -> OliphauntBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OliphauntBuilder

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

Formats the value using the given formatter.

impl Default for OliphauntBuilder

fn default() -> Self

Returns the “default value” for a type.