Struct TemporaryDatabase 

pub struct TemporaryDatabase { /* private fields */ }

RAII guard that drops a database when it goes out of scope.

The guard stores the database name and connection URL rather than borrowing a connection, avoiding lifetime issues and allowing reconnection in Drop.

Examples

use pg_embedded_setup_unpriv::TestCluster;

let cluster = TestCluster::new()?;

// Create a temporary database that is dropped when the guard is dropped
let temp_db = cluster.connection().temporary_database("my_temp_db")?;

// Use the database
let url = temp_db.url();
// ... run queries ...

// Database is dropped automatically when temp_db goes out of scope
drop(temp_db);

Implementations

impl TemporaryDatabase

pub fn name(&self) -> &str

Returns the database name.

pub fn url(&self) -> &str

Returns the connection URL for this database.

pub fn drop_database(self) -> BootstrapResult<()>

Drops the database, failing if connections exist.

This mirrors PostgreSQL’s native behaviour where DROP DATABASE fails if there are active connections to the database.

Errors

Returns an error if:

• The database has active connections
• The database does not exist
• The connection to the admin database fails

Examples

use pg_embedded_setup_unpriv::TestCluster;

let cluster = TestCluster::new()?;
let temp_db = cluster.connection().temporary_database("my_temp_db")?;

// Explicitly drop (consumes the guard)
temp_db.drop_database()?;

pub fn force_drop(self) -> BootstrapResult<()>

Drops the database, terminating any active connections first.

This is useful when you need to ensure the database is dropped even if there are lingering connections (e.g., from connection pools that haven’t been drained).

Errors

Returns an error if:

• The database does not exist
• The connection to the admin database fails
• Terminating connections fails

Examples

use pg_embedded_setup_unpriv::TestCluster;

let cluster = TestCluster::new()?;
let temp_db = cluster.connection().temporary_database("my_temp_db")?;

// Force drop even if connections exist
temp_db.force_drop()?;

Trait Implementations

impl Debug for TemporaryDatabase

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

Formats the value using the given formatter.

impl Drop for TemporaryDatabase

fn drop(&mut self)

Executes the destructor for this type.