Struct PostgreSQL

pub struct PostgreSQL { /* private fields */ }

PostgreSQL server

Implementations

impl PostgreSQL

PostgreSQL server methods

pub fn new(settings: Settings) -> Self

Create a new PostgreSQL instance

pub fn status(&self) -> Status

Get the status of the PostgreSQL server

pub fn settings(&self) -> &Settings

Get the settings of the PostgreSQL server

pub async fn setup(&mut self) -> Result<()>

Set up the database by extracting the archive and initializing the database. If the installation directory already exists, the archive will not be extracted. If the data directory already exists, the database will not be initialized.

Errors

If the installation fails, an error will be returned.

pub async fn start(&mut self) -> Result<()>

Start the database and wait for the startup to complete. If the port is set to 0, the database will be started on a random port.

Errors

If the database fails to start, an error will be returned.

pub async fn stop(&self) -> Result<()>

Stop the database gracefully (smart mode) and wait for the shutdown to complete.

Errors

If the database fails to stop, an error will be returned.

pub async fn create_database<S>(&self, database_name: S) -> Result<()>

where S: AsRef<str> + Debug,

Create a new database with the given name.

Errors

If the database creation fails, an error will be returned.

pub async fn database_exists<S>(&self, database_name: S) -> Result<bool>

where S: AsRef<str> + Debug,

Check if a database with the given name exists.

Errors

If the query fails, an error will be returned.

pub async fn drop_database<S>(&self, database_name: S) -> Result<()>

where S: AsRef<str> + Debug,

Drop a database with the given name.

Errors

If the database does not exist or if the drop command fails, an error will be returned.

Trait Implementations

impl Clone for PostgreSQL

fn clone(&self) -> PostgreSQL

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PostgreSQL

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

Formats the value using the given formatter.

impl Default for PostgreSQL

Default PostgreSQL server

fn default() -> Self

Returns the “default value” for a type.

impl Drop for PostgreSQL

Stop the PostgreSQL server and remove the data directory if it is marked as temporary.

fn drop(&mut self)

Executes the destructor for this type.