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 245 246 247
//! A single connection abstraction to a SQL database.
use crate::{
ast,
connector::{self, impl_default_TransactionCapable, ConnectionInfo, IsolationLevel, Queryable, TransactionCapable},
};
use async_trait::async_trait;
use std::{fmt, sync::Arc};
#[cfg(feature = "sqlite-native")]
use std::convert::TryFrom;
#[cfg(feature = "native")]
use crate::connector::NativeConnectionInfo;
/// The main entry point and an abstraction over a database connection.
#[derive(Clone)]
pub struct Quaint {
inner: Arc<dyn Queryable>,
connection_info: Arc<ConnectionInfo>,
}
impl fmt::Debug for Quaint {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
write!(f, "{:?}", self.connection_info)
}
}
impl_default_TransactionCapable!(Quaint);
impl Quaint {
/// Create a new connection to the database. The connection string
/// follows the specified format:
///
/// `connector_type://user:password@host/database?parameters`
///
/// Connector type can be one of the following:
///
/// - `file` opens an SQLite connection
/// - `mysql` opens a MySQL connection
/// - `postgres`/`postgresql` opens a PostgreSQL connection
///
/// All parameters should be given in the query string format:
/// `?key1=val1&key2=val2`. All parameters are optional.
///
/// As a special case, Microsoft SQL Server connections use the JDBC URI
/// format:
///
/// `jdbc:sqlserver://host\instance:port;key1=val1;key2=val2;`
///
/// SQLite:
///
/// - `user`/`password` do not do anything and can be emitted.
/// - `host` should point to the database file.
/// - `db_name` parameter should give a name to the database attached for
/// query namespacing.
/// - `socket_timeout` defined in seconds. Acts as the busy timeout in
/// SQLite. When set, queries that are waiting for a lock to be released
/// will return the `Timeout` error after the defined value.
///
/// PostgreSQL:
///
/// - `sslmode` either `disable`, `prefer` or `require`. [Read more](https://docs.rs/tokio-postgres/0.5.0-alpha.1/tokio_postgres/config/enum.SslMode.html)
/// - `sslcert` should point to a PEM certificate file.
/// - `sslidentity` should point to a PKCS12 certificate database.
/// - `sslpassword` the password to open the PKCS12 database.
/// - `sslaccept` either `strict` or `accept_invalid_certs`. If strict, the
/// certificate needs to be valid and in the CA certificates.
/// `accept_invalid_certs` accepts any certificate from the server and can
/// lead to weakened security. Defaults to `strict`.
/// - `schema` the default search path.
/// - `host` additionally the host can be given as a parameter, typically in
/// cases when connectiong to the database through a unix socket to
/// separate the database name from the database path, such as
/// `postgresql:///dbname?host=/var/run/postgresql`.
/// - `socket_timeout` defined in seconds. If set, a query will return a
/// `Timeout` error if it fails to resolve before given time.
/// - `connect_timeout` defined in seconds (default: 5). Connecting to a
/// database will return a `ConnectTimeout` error if taking more than the
/// defined value.
/// - `pgbouncer` either `true` or `false`. If set, allows usage with the
/// pgBouncer connection pool in transaction mode. Additionally a transaction
/// is required for every query for the mode to work. When starting a new
/// transaction, a deallocation query `DEALLOCATE ALL` is executed right after
/// `BEGIN` to avoid possible collisions with statements created in other
/// sessions.
/// - `statement_cache_size`, number of prepared statements kept cached.
/// Defaults to 500, which means caching is off. If `pgbouncer` mode is enabled,
/// caching is always off.
/// - `options` Specifies command-line options to send to the server at connection start. [Read more](https://www.postgresql.org/docs/current/libpq-connect.html#LIBPQ-CONNECT-OPTIONS)
///
/// MySQL:
///
/// - `sslcert` should point to a PEM certificate file.
/// - `sslidentity` should point to a PKCS12 certificate database.
/// - `sslpassword` the password to open the PKCS12 database.
/// - `sslaccept` either `strict` or `accept_invalid_certs`. If strict, the
/// certificate needs to be valid and in the CA certificates.
/// `accept_invalid_certs` accepts any certificate from the server and can
/// lead to weakened security. Defaults to `strict`.
/// - `socket` needed when connecting to MySQL database through a unix
/// socket. When set, the host parameter is dismissed.
/// - `socket_timeout` defined in seconds. If set, a query will return a
/// `Timeout` error if it fails to resolve before given time.
/// - `connect_timeout` defined in seconds (default: 5). Connecting to a
/// database will return a `ConnectTimeout` error if taking more than the
/// defined value.
///
/// Microsoft SQL Server:
///
/// - `encrypt` if set to `true` encrypts all traffic over TLS. If `false`, only
/// the login details are encrypted. A special value `DANGER_PLAINTEXT` will
/// disable TLS completely, including sending login credentials as plaintext.
/// - `user` sets the login name.
/// - `password` sets the login password.
/// - `database` sets the database to connect to.
/// - `trustServerCertificate` if set to `true`, accepts any kind of certificate
/// from the server.
/// - `socketTimeout` defined in seconds. If set, a query will return a
/// `Timeout` error if it fails to resolve before given time.
/// - `connectTimeout` defined in seconds (default: 5). Connecting to a
/// database will return a `ConnectTimeout` error if taking more than the
/// defined value.
/// - `connectionLimit` defines the maximum number of connections opened to the
/// database.
/// - `schema` the name of the lookup schema. Only stored to the connection,
/// must be used in every query to be effective.
/// - `isolationLevel` the transaction isolation level. Possible values:
/// `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, `SNAPSHOT`,
/// `SERIALIZABLE`.
#[cfg(feature = "native")]
#[allow(unreachable_code)]
pub async fn new(url_str: &str) -> crate::Result<Self> {
let inner = match url_str {
#[cfg(feature = "sqlite-native")]
s if s.starts_with("file") => {
let params = connector::SqliteParams::try_from(s)?;
let sqlite = connector::Sqlite::new(¶ms.file_path)?;
Arc::new(sqlite) as Arc<dyn Queryable>
}
#[cfg(feature = "mysql-native")]
s if s.starts_with("mysql") => {
let url = connector::MysqlUrl::new(url::Url::parse(s)?)?;
let mysql = connector::Mysql::new(url).await?;
Arc::new(mysql) as Arc<dyn Queryable>
}
#[cfg(feature = "postgresql-native")]
s if s.starts_with("postgres") || s.starts_with("postgresql") => {
let url = connector::PostgresUrl::new(url::Url::parse(s)?)?;
let psql = connector::PostgreSql::new(url).await?;
Arc::new(psql) as Arc<dyn Queryable>
}
#[cfg(feature = "mssql-native")]
s if s.starts_with("jdbc:sqlserver") | s.starts_with("sqlserver") => {
let url = connector::MssqlUrl::new(s)?;
let psql = connector::Mssql::new(url).await?;
Arc::new(psql) as Arc<dyn Queryable>
}
_ => unimplemented!("Supported url schemes: file or sqlite, mysql, postgresql or jdbc:sqlserver."),
};
let connection_info = Arc::new(ConnectionInfo::from_url(url_str)?);
Self::log_start(&connection_info);
Ok(Self { inner, connection_info })
}
#[cfg(feature = "sqlite-native")]
/// Open a new SQLite database in memory.
pub fn new_in_memory() -> crate::Result<Quaint> {
use crate::connector::sqlite::DEFAULT_SQLITE_DATABASE;
Ok(Quaint {
inner: Arc::new(connector::Sqlite::new_in_memory()?),
connection_info: Arc::new(ConnectionInfo::Native(NativeConnectionInfo::InMemorySqlite {
db_name: DEFAULT_SQLITE_DATABASE.to_owned(),
})),
})
}
/// Info about the connection and underlying database.
pub fn connection_info(&self) -> &ConnectionInfo {
&self.connection_info
}
#[cfg(feature = "native")]
fn log_start(info: &ConnectionInfo) {
let family = info.sql_family();
let pg_bouncer = if info.pg_bouncer() { " in PgBouncer mode" } else { "" };
tracing::info!("Starting a {} connection{}.", family, pg_bouncer);
}
}
#[async_trait]
impl Queryable for Quaint {
async fn query(&self, q: ast::Query<'_>) -> crate::Result<connector::ResultSet> {
self.inner.query(q).await
}
async fn query_raw(&self, sql: &str, params: &[ast::Value<'_>]) -> crate::Result<connector::ResultSet> {
self.inner.query_raw(sql, params).await
}
async fn query_raw_typed(&self, sql: &str, params: &[ast::Value<'_>]) -> crate::Result<connector::ResultSet> {
self.inner.query_raw_typed(sql, params).await
}
async fn execute(&self, q: ast::Query<'_>) -> crate::Result<u64> {
self.inner.execute(q).await
}
async fn execute_raw(&self, sql: &str, params: &[ast::Value<'_>]) -> crate::Result<u64> {
self.inner.execute_raw(sql, params).await
}
async fn execute_raw_typed(&self, sql: &str, params: &[ast::Value<'_>]) -> crate::Result<u64> {
self.inner.execute_raw_typed(sql, params).await
}
async fn raw_cmd(&self, cmd: &str) -> crate::Result<()> {
self.inner.raw_cmd(cmd).await
}
async fn version(&self) -> crate::Result<Option<String>> {
self.inner.version().await
}
fn is_healthy(&self) -> bool {
self.inner.is_healthy()
}
fn begin_statement(&self) -> &'static str {
self.inner.begin_statement()
}
async fn set_tx_isolation_level(&self, isolation_level: IsolationLevel) -> crate::Result<()> {
self.inner.set_tx_isolation_level(isolation_level).await
}
fn requires_isolation_first(&self) -> bool {
self.inner.requires_isolation_first()
}
}