Struct MySqlConnection 

pub struct MySqlConnection { /* private fields */ }

Available on crate feature mysql only.

A connection to a MySQL database.

Trait Implementations

impl<'c> Acquire<'c> for &'c mut MySqlConnection

type Database = MySql

type Connection = &'c mut <MySql as Database>::Connection

fn acquire( self, ) -> Pin<Box<dyn Future<Output = Result<<&'c mut MySqlConnection as Acquire<'c>>::Connection, Error>> + Send + 'c>>

fn begin( self, ) -> Pin<Box<dyn Future<Output = Result<Transaction<'c, MySql>, Error>> + Send + 'c>>

impl AnyConnectionBackend for MySqlConnection

fn name(&self) -> &str

The backend name.

fn close( self: Box<MySqlConnection>, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send>>

Explicitly close this database connection.

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

Checks if a connection to the database is still valid.

fn begin( &mut self, statement: Option<SqlStr>, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + '_>>

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

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

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

fn start_rollback(&mut self)

fn get_transaction_depth(&self) -> usize

Returns the current transaction depth.

fn shrink_buffers(&mut self)

Forward to Connection::shrink_buffers().

fn as_migrate(&mut self) -> Result<&mut (dyn Migrate + Send + 'static), Error>

Available on crate feature migrate only.

fn fetch_many( &mut self, query: SqlStr, persistent: bool, arguments: Option<AnyArguments>, ) -> Pin<Box<dyn Stream<Item = Result<Either<AnyQueryResult, AnyRow>, Error>> + Send + '_>>

fn fetch_optional( &mut self, query: SqlStr, persistent: bool, arguments: Option<AnyArguments>, ) -> Pin<Box<dyn Future<Output = Result<Option<AnyRow>, Error>> + Send + '_>>

fn prepare_with<'c, 'q>( &'c mut self, sql: SqlStr, _parameters: &[AnyTypeInfo], ) -> Pin<Box<dyn Future<Output = Result<AnyStatement, Error>> + Send + 'c>>

where 'q: 'c,

fn describe( &mut self, sql: SqlStr, ) -> Pin<Box<dyn Future<Output = Result<Describe<Any>, Error>> + Send + '_>>

Available on crate feature offline only.

fn is_in_transaction(&self) -> bool

Checks if the connection is currently in a transaction.

fn cached_statements_size(&self) -> usize

The number of statements currently cached in the connection.

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

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

impl Connection for MySqlConnection

type Database = MySql

type Options = MySqlConnectOptions

async fn close(self) -> Result<(), Error>

Explicitly close this database connection.

async fn ping(&mut self) -> Result<(), Error>

Checks if a connection to the database is still valid.

fn cached_statements_size(&self) -> usize

The number of statements currently cached in the connection.

async fn clear_cached_statements(&mut self) -> Result<(), Error>

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

fn begin( &mut self, ) -> impl Future<Output = Result<Transaction<'_, <MySqlConnection as Connection>::Database>, Error>> + Send

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

fn begin_with( &mut self, statement: impl SqlSafeStr, ) -> impl Future<Output = Result<Transaction<'_, <MySqlConnection as Connection>::Database>, Error>> + Send

where MySqlConnection: Sized,

Begin a new transaction with a custom statement.

fn shrink_buffers(&mut self)

Restore any buffers in the connection to their default capacity, if possible.

fn is_in_transaction(&self) -> bool

Returns true if the connection is currently in a transaction.

fn transaction<'a, F, R, E>( &'a mut self, callback: F, ) -> impl Future<Output = Result<R, E>> + Send + 'a

where F: for<'c> FnOnce(&'c mut Transaction<'_, Self::Database>) -> Pin<Box<dyn Future<Output = Result<R, E>> + Send + 'c>> + 'a + for<'c> Send + for<'c> Sync, Self: Sized, R: Send, E: From<Error> + Send,

Execute the function inside a transaction.

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

where Self: Sized,

Establish a new database connection.

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

where Self: Sized,

Establish a new database connection with the provided options.

impl Debug for MySqlConnection

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

Formats the value using the given formatter.

impl<'c> Executor<'c> for &'c mut MySqlConnection

type Database = MySql

fn fetch_many<'e, 'q, E>( self, query: E, ) -> Pin<Box<dyn Stream<Item = Result<Either<MySqlQueryResult, MySqlRow>, Error>> + Send + 'e>>

where 'c: 'e, 'q: 'e, E: Execute<'q, <&'c mut MySqlConnection as Executor<'c>>::Database> + 'q,

Execute multiple queries and return the generated results as a stream from each query, in a stream.

fn fetch_optional<'e, 'q, E>( self, query: E, ) -> Pin<Box<dyn Future<Output = Result<Option<MySqlRow>, Error>> + Send + 'e>>

where 'c: 'e, 'q: 'e, E: Execute<'q, <&'c mut MySqlConnection as Executor<'c>>::Database> + 'q,

Execute the query and returns at most one row.

fn prepare_with<'e>( self, sql: SqlStr, _parameters: &'e [MySqlTypeInfo], ) -> Pin<Box<dyn Future<Output = Result<MySqlStatement, Error>> + Send + 'e>>

where 'c: 'e,

Prepare the SQL query, with parameter type information, to inspect the type information about its parameters and results.

fn execute<'e, 'q, E>( self, query: E, ) -> Pin<Box<dyn Future<Output = Result<<Self::Database as Database>::QueryResult, Error>> + Send + 'e>>

where 'q: 'e, 'c: 'e, E: 'q + Execute<'q, Self::Database>,

Execute the query and return the total number of rows affected.

fn execute_many<'e, 'q, E>( self, query: E, ) -> Pin<Box<dyn Stream<Item = Result<<Self::Database as Database>::QueryResult, Error>> + Send + 'e>>

where 'q: 'e, 'c: 'e, E: 'q + Execute<'q, Self::Database>,

Execute multiple queries and return the rows affected from each query, in a stream.

fn fetch<'e, 'q, E>( self, query: E, ) -> Pin<Box<dyn Stream<Item = Result<<Self::Database as Database>::Row, Error>> + Send + 'e>>

where 'q: 'e, 'c: 'e, E: 'q + Execute<'q, Self::Database>,

Execute the query and return the generated results as a stream.

fn fetch_all<'e, 'q, E>( self, query: E, ) -> Pin<Box<dyn Future<Output = Result<Vec<<Self::Database as Database>::Row>, Error>> + Send + 'e>>

where 'q: 'e, 'c: 'e, E: 'q + Execute<'q, Self::Database>,

Execute the query and return all the generated results, collected into a Vec.

fn fetch_one<'e, 'q, E>( self, query: E, ) -> Pin<Box<dyn Future<Output = Result<<Self::Database as Database>::Row, Error>> + Send + 'e>>

where 'q: 'e, 'c: 'e, E: 'q + Execute<'q, Self::Database>,

Execute the query and returns exactly one row.

fn prepare<'e>( self, query: SqlStr, ) -> Pin<Box<dyn Future<Output = Result<<Self::Database as Database>::Statement, Error>> + Send + 'e>>

where 'c: 'e,

Prepare the SQL query to inspect the type information of its parameters and results.

impl Migrate for MySqlConnection

fn create_schema_if_not_exists<'e>( &'e mut self, schema_name: &'e str, ) -> Pin<Box<dyn Future<Output = Result<(), MigrateError>> + Send + 'e>>

Create a database schema with the given name if it does not already exist.

fn ensure_migrations_table<'e>( &'e mut self, table_name: &'e str, ) -> Pin<Box<dyn Future<Output = Result<(), MigrateError>> + Send + 'e>>

fn dirty_version<'e>( &'e mut self, table_name: &'e str, ) -> Pin<Box<dyn Future<Output = Result<Option<i64>, MigrateError>> + Send + 'e>>

fn list_applied_migrations<'e>( &'e mut self, table_name: &'e str, ) -> Pin<Box<dyn Future<Output = Result<Vec<AppliedMigration>, MigrateError>> + Send + 'e>>

fn lock( &mut self, ) -> Pin<Box<dyn Future<Output = Result<(), MigrateError>> + Send + '_>>

fn unlock( &mut self, ) -> Pin<Box<dyn Future<Output = Result<(), MigrateError>> + Send + '_>>

fn apply<'e>( &'e mut self, table_name: &'e str, migration: &'e Migration, ) -> Pin<Box<dyn Future<Output = Result<Duration, MigrateError>> + Send + 'e>>

fn revert<'e>( &'e mut self, table_name: &'e str, migration: &'e Migration, ) -> Pin<Box<dyn Future<Output = Result<Duration, MigrateError>> + Send + 'e>>

fn skip<'e>( &'e mut self, table_name: &'e str, migration: &'e Migration, ) -> Pin<Box<dyn Future<Output = Result<(), MigrateError>> + Send + 'e>>