Struct migra::clients::PostgresClient

pub struct PostgresClient { /* fields omitted */ }

Predefined Postgres client.

Note: Requires enabling postgres feature.

Implementations

impl Client

#[must_use]

pub fn conn(&self) -> &PostgresClient

Provide access to the original database connection.

Trait Implementations

impl BatchExecute for Client

fn batch_execute(&mut self, sql: &str) -> StdResult<()>

Executes sql via original database client

impl Debug for Client

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

Formats the value using the given formatter.

impl ManageMigrations for Client

fn create_migrations_table(&mut self) -> MigraResult<()>

Creates migration table.

fn insert_migration(&mut self, name: &str) -> MigraResult<u64>

Inserts new migration to table.

fn delete_migration(&mut self, name: &str) -> MigraResult<u64>

Deletes migration from table.

fn get_applied_migrations(&mut self) -> MigraResult<List>

Get applied migrations from table.

fn apply_sql(&mut self, sql: &str) -> MigraResult<()>

Applies SQL. Similar to BatchExecute, but returns migra Error.

fn run_upgrade_migration(
    &mut self,
    name: &str,
    content: &str
) -> MigraResult<()>

Applies SQL to upgrade database schema and inserts new migration to table.

fn run_downgrade_migration(
    &mut self,
    name: &str,
    content: &str
) -> MigraResult<()>

Applies SQL to downgrade database schema and deletes migration from table.

impl ManageTransaction for Client

fn begin_transaction(&mut self) -> MigraResult<()>

Opens transaction in database connection.

fn rollback_transaction(&mut self) -> MigraResult<()>

Cancels (Rollbacks) transaction in database connection.

fn commit_transaction(&mut self) -> MigraResult<()>

Apply (Commit) transaction in database connection.

impl OpenDatabaseConnection for Client

fn manual(
    connection_string: &str,
    migrations_table_name: &str
) -> MigraResult<Self>

Open database connection manually with additional migration table name parameter.

fn new(connection_string: &str) -> MigraResult<Self>

Open database connection with predefined migrations table name.

impl Client for Client