1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208
// Copyright (c) 2017 Anatoly Ikorsky
//
// Licensed under the Apache License, Version 2.0
// <LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0> or the MIT
// license <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
// option. All files in the project carrying such notice may not be copied,
// modified, or distributed except according to those terms.
use std::{fmt, ops::Deref};
use crate::{connection_like::Connection, error::*, queryable::Queryable, Conn};
/// Transaction status.
#[derive(Debug, Copy, Clone, Eq, PartialEq)]
#[repr(u8)]
pub enum TxStatus {
/// Connection is in transaction at the moment.
InTransaction,
/// `Transaction` was dropped without explicit call to `commit` or `rollback`.
RequiresRollback,
/// Connection is not in transaction at the moment.
None,
}
impl Conn {
/// Starts a transaction.
pub async fn start_transaction(&mut self, options: TxOpts) -> Result<Transaction<'_>> {
Transaction::new(self, options).await
}
}
/// Transaction options.
///
/// Example:
///
/// ```
/// # use mysql_async::*;
/// # fn main() -> Result<()> {
/// let tx_opts = TxOpts::default()
/// .with_consistent_snapshot(true)
/// .with_isolation_level(IsolationLevel::RepeatableRead);
/// # Ok(()) }
/// ```
#[derive(Eq, PartialEq, Debug, Hash, Clone, Default)]
pub struct TxOpts {
consistent_snapshot: bool,
isolation_level: Option<IsolationLevel>,
readonly: Option<bool>,
}
impl TxOpts {
/// Creates a default instance.
pub fn new() -> TxOpts {
TxOpts::default()
}
/// See [`TxOpts::consistent_snapshot`].
pub fn with_consistent_snapshot(&mut self, value: bool) -> &mut Self {
self.consistent_snapshot = value;
self
}
/// See [`TxOpts::isolation_level`].
pub fn with_isolation_level<T>(&mut self, value: T) -> &mut Self
where
T: Into<Option<IsolationLevel>>,
{
self.isolation_level = value.into();
self
}
/// See [`TxOpts::readonly`].
pub fn with_readonly<T>(&mut self, value: T) -> &mut Self
where
T: Into<Option<bool>>,
{
self.readonly = value.into();
self
}
/// If true, then `START TRANSACTION WITH CONSISTENT SNAPSHOT` will be performed.
/// Defaults to `false`.
pub fn consistent_snapshot(&self) -> bool {
self.consistent_snapshot
}
/// If not `None`, then `SET TRANSACTION ISOLATION LEVEL ..` will be performed.
/// Defaults to `None`.
pub fn isolation_level(&self) -> Option<IsolationLevel> {
self.isolation_level
}
/// If not `None`, then `SET TRANSACTION READ ONLY|WRITE` will be performed.
/// Defaults to `None`.
///
/// Only available since MySql 5.6.5.
pub fn readonly(&self) -> Option<bool> {
self.readonly
}
}
/// Transaction isolation level.
#[derive(PartialEq, Eq, Clone, Copy, Debug, Hash)]
pub enum IsolationLevel {
ReadUncommitted,
ReadCommitted,
RepeatableRead,
Serializable,
}
impl fmt::Display for IsolationLevel {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
match *self {
IsolationLevel::ReadUncommitted => write!(f, "READ UNCOMMITTED"),
IsolationLevel::ReadCommitted => write!(f, "READ COMMITTED"),
IsolationLevel::RepeatableRead => write!(f, "REPEATABLE READ"),
IsolationLevel::Serializable => write!(f, "SERIALIZABLE"),
}
}
}
/// This struct represents MySql transaction.
///
/// `Transaction` is just a sugar for `START TRANSACTION`, `ROLLBACK` and `COMMIT` queries,
/// so please note, that it is easy to mess things up calling this queries manually.
///
/// You should always call either `commit` or `rollback`, otherwise transaction will be rolled
/// back implicitly when corresponding connection is dropped or queried.
#[derive(Debug)]
pub struct Transaction<'a>(pub(crate) Connection<'a, 'static>);
impl<'a> Transaction<'a> {
pub(crate) async fn new<T: Into<Connection<'a, 'static>>>(
conn: T,
options: TxOpts,
) -> Result<Transaction<'a>> {
let TxOpts {
consistent_snapshot,
isolation_level,
readonly,
} = options;
let mut conn = conn.into();
if conn.get_tx_status() != TxStatus::None {
return Err(DriverError::NestedTransaction.into());
}
if readonly.is_some() && conn.server_version() < (5, 6, 5) {
return Err(DriverError::ReadOnlyTransNotSupported.into());
}
if let Some(isolation_level) = isolation_level {
let query = format!("SET TRANSACTION ISOLATION LEVEL {}", isolation_level);
conn.query_drop(query).await?;
}
if let Some(readonly) = readonly {
if readonly {
conn.query_drop("SET TRANSACTION READ ONLY").await?;
} else {
conn.query_drop("SET TRANSACTION READ WRITE").await?;
}
}
if consistent_snapshot {
conn.query_drop("START TRANSACTION WITH CONSISTENT SNAPSHOT")
.await?
} else {
conn.query_drop("START TRANSACTION").await?
};
conn.set_tx_status(TxStatus::InTransaction);
Ok(Transaction(conn))
}
/// Performs `COMMIT` query.
pub async fn commit(mut self) -> Result<()> {
let result = self.0.query_iter("COMMIT").await?;
result.drop_result().await?;
self.0.set_tx_status(TxStatus::None);
Ok(())
}
/// Performs `ROLLBACK` query.
pub async fn rollback(mut self) -> Result<()> {
let result = self.0.query_iter("ROLLBACK").await?;
result.drop_result().await?;
self.0.set_tx_status(TxStatus::None);
Ok(())
}
}
impl Deref for Transaction<'_> {
type Target = Conn;
fn deref(&self) -> &Self::Target {
&*self.0
}
}
impl Drop for Transaction<'_> {
fn drop(&mut self) {
if self.0.get_tx_status() == TxStatus::InTransaction {
self.0.set_tx_status(TxStatus::RequiresRollback);
}
}
}