[−][src]Trait sqlx::Connection

pub trait Connection: Send {
    type Database: Database;
    type Options: ConnectOptions;
    fn close(
        self
    ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + 'static + Send, Global>>;

    fn ping(
        &mut self
    ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send, Global>>;

    fn begin(
        &mut self
    ) -> Pin<Box<dyn Future<Output = Result<Transaction<'_, Self::Database>, Error>> + Send, Global>>;

    fn transaction<'c, 'f, T, E, F, Fut>(
        &'c mut self, 
        f: F
    ) -> Pin<Box<dyn Future<Output = Result<T, E>> + 'f + Send, Global>>
    where
        'c: 'f,
        E: From<Error> + Send,
        F: FnOnce(&mut <Self::Database as Database>::Connection) -> Fut + Send + 'f,
        Fut: Future<Output = Result<T, E>> + Send,
        T: Send,
    { ... }

    fn cached_statements_size(&self) -> usize
    where
        Self::Database: HasStatementCache,
    { ... }

    fn clear_cached_statements(
        &mut self
    ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send, Global>>
    where
        Self::Database: HasStatementCache,
    { ... }

    fn connect(
        url: &str
    ) -> Pin<Box<dyn Future<Output = Result<Self, Error>> + 'static + Send, Global>> { ... }

    fn connect_with(
        options: &Self::Options
    ) -> Pin<Box<dyn Future<Output = Result<Self, Error>> + Send, Global>> { ... }
}

Represents a single database connection.

Associated Types

type Database: Database

type Options: ConnectOptions

Loading content...

Required methods

fn close(
    self
) -> Pin<Box<dyn Future<Output = Result<(), Error>> + 'static + Send, Global>>

Explicitly close this database connection.

This method is not required for safe and consistent operation. However, it is recommended to call it instead of letting a connection drop as the database backend will be faster at cleaning up resources.

fn ping(
    &mut self
) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send, Global>>

Checks if a connection to the database is still valid.

fn begin(
    &mut self
) -> Pin<Box<dyn Future<Output = Result<Transaction<'_, Self::Database>, Error>> + Send, Global>>

Begin a new transaction or establish a savepoint within the active transaction.

Returns a Transaction for controlling and tracking the new transaction.

Loading content...

Provided methods

fn transaction<'c, 'f, T, E, F, Fut>(
    &'c mut self,
    f: F
) -> Pin<Box<dyn Future<Output = Result<T, E>> + 'f + Send, Global>> where
    'c: 'f,
    E: From<Error> + Send,
    F: FnOnce(&mut <Self::Database as Database>::Connection) -> Fut + Send + 'f,
    Fut: Future<Output = Result<T, E>> + Send,
    T: Send, 

Execute the function inside a transaction.

If the function returns an error, the transaction will be rolled back. If it does not return an error, the transaction will be committed.

fn cached_statements_size(&self) -> usize where
    Self::Database: HasStatementCache, 

The number of statements currently cached in the connection.

fn clear_cached_statements(
    &mut self
) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send, Global>> where
    Self::Database: HasStatementCache, 

Removes all statements from the cache, closing them on the server if needed.

fn connect(
    url: &str
) -> Pin<Box<dyn Future<Output = Result<Self, Error>> + 'static + Send, Global>>

Establish a new database connection.

A value of Options is parsed from the provided connection string. This parsing is database-specific.

fn connect_with(
    options: &Self::Options
) -> Pin<Box<dyn Future<Output = Result<Self, Error>> + Send, Global>>

Establish a new database connection with the provided options.

Loading content...

Implementors

impl Connection for AnyConnection[src]

type Database = Any

type Options = AnyConnectOptions

impl Connection for MssqlConnection[src]

type Database = Mssql

type Options = MssqlConnectOptions

impl Connection for MySqlConnection[src]

type Database = MySql

type Options = MySqlConnectOptions

impl Connection for PgConnection[src]

type Database = Postgres

type Options = PgConnectOptions

impl Connection for SqliteConnection[src]

type Database = Sqlite

type Options = SqliteConnectOptions

Loading content...