Struct pgdb::PostgresClient

source ·
pub struct PostgresClient<'a> { /* private fields */ }
Expand description

A virtual client for a running postgres.

Contains credentials and enough information to connect to its parent instance.

Implementations§

source§

impl<'a> PostgresClient<'a>

source

pub fn psql(&self, database: &str) -> Command

Runs a psql command against the database.

Creates a command that runs psql -h (host) -p (port) -U (username) -d (database) with PGPASSWORD set.

source

pub fn load_sql<P: AsRef<Path>>( &self, database: &str, filename: P ) -> Result<(), Error>

Runs the given SQL commands from an input file via psql.

source

pub fn run_sql(&self, database: &str, sql: &str) -> Result<(), Error>

Runs the given SQL command through psql.

source

pub fn create_database(&self, database: &str, owner: &str) -> Result<(), Error>

Creates a new database with the given owner.

This typically requires superuser credentials, see Postgres::as_superuser.

source

pub fn create_user(&self, username: &str, password: &str) -> Result<(), Error>

Creates a new user on the system that is allowed to login.

This typically requires superuser credentials, see Postgres::as_superuser.

source

pub fn instance(&self) -> &Postgres

Returns the Postgres instance associated with this client.

source

pub fn username(&self) -> &str

Returns the username used by this client.

source

pub fn uri(&self, database: &str) -> String

Returns a libpq-style connection URI.

source

pub fn password(&self) -> &str

Returns the password used by this client.

Trait Implementations§

source§

impl<'a> Debug for PostgresClient<'a>

source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'a> Freeze for PostgresClient<'a>

§

impl<'a> RefUnwindSafe for PostgresClient<'a>

§

impl<'a> Send for PostgresClient<'a>

§

impl<'a> Sync for PostgresClient<'a>

§

impl<'a> Unpin for PostgresClient<'a>

§

impl<'a> UnwindSafe for PostgresClient<'a>

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

source§

fn vzip(self) -> V