Struct temp_postgres::TempPostgres

pub struct TempPostgres { /* private fields */ }

A temporary postgres instance.

All state of the postgres instance is stored in a temporary directory. Unless disabled, the temporary directory is deleted when this object is dropped.

Implementations

impl TempPostgres

pub async fn new() -> Result<Self, Error>

Spawn a new postgres instance with a temporary state directory.

pub fn builder() -> TempPostgresBuilder

Create a builder to customize your TempPostgres.

After configuring the desirec options, run TempPostgresBuilder::spawn().

pub fn process_id(&self) -> u32

Get the PID of the postgres server process.

pub fn directory(&self) -> &Path

Get the path of the temporary state directory.

pub fn log_path(&self) -> &Path

Get the path of the log file.

pub async fn read_log(&self) -> Result<String, Error>

Read the contents of the log file.

pub async fn client(&self) -> Result<Client, Error>

Connect an asycnchronous client to the postgres instance.

pub fn set_clean_on_drop(&mut self, clean_on_drop: bool)

Enable or disable clean-up of the temporary directory when this object is dropped.

pub async fn kill_and_clean(self) -> Result<(), Error>

Kill the server and remove the temporary state directory on the filesystem.

Note that the server will also be killed when this object is dropped, and unless disabled, the temporary state directory will be removed by the Drop implementation too.

This function ignores the value of clean_on_drop. It also allows for better error handling compared to just dropping the object.

pub async fn kill_no_clean(self) -> Result<(), Error>

Kill the server, but leave the temporary state directory on the filesystem.

Note that the server will also be killed when this object is dropped.

This function ignores the value of clean_on_drop. It also allows for better error handling compared to just dropping the object.

Trait Implementations

impl Debug for TempPostgres

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

Formats the value using the given formatter.