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 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244
use super::{DbError, Row, SimpleQueryMessage, Statement, ToSql, ToStatement}; use tokio_postgres::Client; /// Wrapper over tokio_postgres::Client /// ## Example /// ```edition2018 /// use std::env; /// use orma::{Connection}; /// /// async fn create_connection() -> Connection { /// let connection_string = format!( /// "host={host} port={port} dbname={dbname} user={user} password={password}", /// host = &env::var("INTRARED_DB_HOSTNAME").unwrap_or_else(|_| "localhost".to_string()), /// port = env::var("INTRARED_DB_PORT").unwrap_or_else(|_| "5433".to_string()), /// dbname = env::var("INTRARED_DB_NAME").unwrap_or_else(|_| "pgactix".to_string()), /// user = env::var("INTRARED_DB_USERNAME").unwrap_or_else(|_| "pgactix".to_string()), /// password = env::var("INTRARED_DB_PASSWORD").unwrap_or_else(|_| "pgactix".to_string()), /// ); /// let (client, conn) = tokio_postgres::connect(&connection_string, tokio_postgres::NoTls) /// .await /// .unwrap(); /// tokio::spawn(conn); /// Connection::from(client) /// } /// ``` pub struct Connection { client: Client, transaction_n: u32, } impl From<Client> for Connection { fn from(client: Client) -> Self { Self { client, transaction_n: 0, } } } impl Connection { /// Executes a sequence of SQL statements using the simple query protocol. /// /// Statements should be separated by semicolons. If an error occurs, execution of the /// sequence will stop at that point. This is intended for use when, for example, initializing /// a database schema. pub async fn batch_execute(&self, query: &str) -> Result<(), DbError> { self.client .batch_execute(query) .await .map_err(DbError::from) } /// Executes a statement, returning the number of rows modified. /// /// A statement may contain parameters, specified by $n, where n is the index of the parameter /// of the list provided, 1-indexed. /// /// The statement argument can either be a Statement, or a raw query string. /// If the same statement will be repeatedly executed (perhaps with different query parameters), /// consider preparing the statement up front with the prepare method. /// /// If the statement does not modify any rows (e.g. SELECT), 0 is returned. pub async fn execute<T>( &self, statement: &T, params: &[&(dyn ToSql + Sync)], ) -> Result<u64, DbError> where T: ?Sized + ToStatement, { let statement = &statement.__convert().into_statement(self).await?; self.client .execute(&**statement, params) .await .map_err(DbError::from) } /// Creates a new prepared statement. /// /// Prepared statements can be executed repeatedly, and may contain query parameters /// (indicated by $1, $2, etc), which are set when executed. /// /// Prepared statements can only be used with the connection that created them. pub async fn prepare(&self, query: &str) -> Result<Statement, DbError> { self.client .prepare(query) .await .map(Statement::from) .map_err(DbError::from) } pub async fn simple_query(&self, query: &str) -> Result<Vec<SimpleQueryMessage>, DbError> { self.client .simple_query(query) .await .map(|rows| rows.into_iter().map(SimpleQueryMessage::from).collect()) .map_err(DbError::from) } /// Executes a statement, returning a vector of the resulting rows. /// /// A statement may contain parameters, specified by $n, where n is the index of the /// parameter of the list provided, 1-indexed. /// /// The statement argument can either be a Statement, or a raw query string. /// If the same statement will be repeatedly executed (perhaps with different /// query parameters), consider preparing the statement up front with the prepare method. pub async fn query<T>( &self, statement: &T, params: &[&(dyn ToSql + Sync)], ) -> Result<Vec<Row>, DbError> where T: ?Sized + ToStatement, { let statement = &statement.__convert().into_statement(self).await?; self.client .query(&**statement, params) .await .map(|rows| rows.into_iter().map(Row::from).collect()) .map_err(DbError::from) } /// Executes a statement, returning a single row. /// /// A statement may contain parameters, specified by $n, where n is the index of the /// parameter of the list provided, 1-indexed. /// /// The statement argument can either be a Statement, or a raw query string. /// If the same statement will be repeatedly executed (perhaps with different /// query parameters), consider preparing the statement up front with the prepare method. pub async fn query_one<T>( &self, statement: &T, params: &[&(dyn ToSql + Sync)], ) -> Result<Row, DbError> where T: ?Sized + ToStatement, { let statement = &statement.__convert().into_statement(self).await?; self.client .query_one(&**statement, params) .await .map(Row::from) .map_err(DbError::from) } /// Executes a statement, returning zero or one row. /// /// A statement may contain parameters, specified by $n, where n is the index of the /// parameter of the list provided, 1-indexed. /// /// The statement argument can either be a Statement, or a raw query string. /// If the same statement will be repeatedly executed (perhaps with different /// query parameters), consider preparing the statement up front with the prepare method. pub async fn query_opt<T>( &self, statement: &T, params: &[&(dyn ToSql + Sync)], ) -> Result<Option<Row>, DbError> where T: ?Sized + ToStatement, { let statement = &statement.__convert().into_statement(self).await?; self.client .query_opt(&**statement, params) .await .map(|option_row| match option_row { Some(row) => Some(Row::from(row)), _ => None, }) .map_err(DbError::from) } /// Begins a transaction or creates a savepoint if a transaction already started /// ## Example /// from [dbjoin.rs](../src/orma/dbjoin.rs.html) /// ```disabled /// pub async fn save_items(&self, conn: &mut Connection) -> Result<(), DbError> { /// conn.transaction().await?; /// let result = async { /// match (self.join_table.as_ref(), self.items_fk.as_ref()) { /// (Some(join_table), Some(items_fk)) => { /// self.save_items_table_join(&join_table, &items_fk, conn) /// .await?; /// } /// _ => { /// self.save_items_simple_join(conn).await?; /// } /// }; /// conn.commit().await?; /// Ok(()) /// } /// .await; /// if result.is_err() { /// conn.rollback().await?; /// } /// result /// } /// ``` pub async fn transaction(&mut self) -> Result<(), DbError> { let qry = if self.transaction_n == 0 { // String::from("BEGIN") "BEGIN".into() } else { format!("SAVEPOINT pt{}", self.transaction_n) }; self.batch_execute(&qry).await?; self.transaction_n += 1; Ok(()) } /// Commits a transaction or releases a savepoint pub async fn commit(&mut self) -> Result<(), DbError> { if self.transaction_n == 0 { Err(DbError::new("Not in a transaction", None)) } else { let qry = if self.transaction_n == 1 { String::from("COMMIT") } else { format!("RELEASE pt{}", self.transaction_n - 1) }; self.batch_execute(&qry).await?; self.transaction_n -= 1; Ok(()) } } /// Rolls back a transaction or a savepoint pub async fn rollback(&mut self) -> Result<(), DbError> { if self.transaction_n == 0 { Err(DbError::new("Not in a transaction", None)) } else { let qry = if self.transaction_n == 1 { String::from("ROLLBACK") } else { format!("ROLLBACK TO SAVEPOINT pt{}", self.transaction_n - 1) }; self.batch_execute(&qry).await?; self.transaction_n -= 1; Ok(()) } } }