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 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408
#![warn(warnings)]
#![doc(html_logo_url = "https://elephantry.github.io/logo.png")]
#![cfg_attr(docsrs, feature(doc_cfg))]
/*!
*
* | SQL type | Rust type | Feature |
* |-----------------------------|--------------------------|------------|
* | `bigint`/`int8` | `i64` | |
* | `bit` | `u8` | bit |
* | `bit(n)` | `[u8; n]` | bit |
* | `bit varying` | `bit_vec::BitVec` | bit |
* | `boolean` | `bool` | |
* | `box` | `elephantry::Box` | geo |
* | `bytea` | `elephantry::Bytea` | |
* | `char` | `char` | |
* | `varchar` | `String` | |
* | `cidr` | `ipnetwork::IpNetwork` | net |
* | `circle` | `elephantry::Circle` | geo |
* | `date` | `chrono::NaiveDate` | date |
* | `double precision`/`float8` | `f64` | |
* | `hstore` | `elephantry::Hstore` | |
* | `inet` | `std::net::IpAddr` | net |
* | `integer`/`int4` | `i32` | |
* | `interval` | `elephantry::Interval` | date |
* | `json` | `serde_json::Value` | json |
* | `jsonb` | `elephantry::Jsonb` | json |
* | `line` | `elephantry::Line` | geo |
* | `lquery` | `elephantry::Lquery` | ltree |
* | `lseg` | `elephantry::Segment` | geo |
* | `ltree` | `elephantry::Ltree` | ltree |
* | `ltxtquery` | `elephantry::Ltxtquery` | ltree |
* | `null` | `()` | |
* | `macaddr` | `macaddr::MacAddr6` | net |
* | `macaddr8` | `macaddr::MacAddr8` | net |
* | `money` | `postgres_money::Money` | money |
* | `multirange` | `elephantry::Multirange` | multirange |
* | `numeric` | `bigdecimal::BigDecimal` | numeric |
* | `path` | `elephantry::Path` | geo |
* | `point` | `elephantry::Point` | geo |
* | `polygon` | `elephantry::Polygon` | geo |
* | `real`/`float4` | `f32` | |
* | `record` | `tuple` | |
* | `smallint`/`int2` | `i16` | |
* | `text` | `String` | |
* | `time` | `elephantry::Time` | time |
* | `timetz` | `elephantry::TimeTz` | time |
* | `timestamp` | `chrono::NaiveDateTime` | date |
* | `timestamptz` | `chrono::DateTime` | date |
* | `uuid` | `uuid::Uuid` | uuid |
* | `xml` | `xmltree::Element` | xml |
* | `[x, y)` | `std::ops::Range` | |
* | `[x,)` | `std::ops::RangeFrom` | |
* | `[,y)` | `std::ops::RangeTo` | |
* | `(,)` | `std::ops::RangeFull` | |
*/
pub mod config;
pub mod connection;
pub mod entity;
#[cfg(feature = "inspect")]
#[cfg_attr(docsrs, doc(cfg(feature = "inspect")))]
/** database inspection module. */
pub mod inspect;
/** libpq abstraction layer. */
pub mod pq;
#[cfg(feature = "r2d2")]
#[cfg_attr(docsrs, doc(cfg(feature = "r2d2")))]
pub mod r2d2;
#[cfg(feature = "rocket")]
#[cfg_attr(docsrs, doc(cfg(feature = "rocket")))]
#[doc(hidden)]
pub mod rocket;
pub mod transaction;
mod r#async;
mod errors;
mod from_sql;
mod from_text;
mod model;
mod pager;
mod pool;
mod projectable;
mod projection;
mod rows;
mod sql;
mod structure;
mod to_sql;
mod to_text;
mod tuple;
mod r#where;
pub use crate::config::Config;
pub use connection::Connection;
pub use elephantry_derive::*;
pub use entity::Entity;
pub use errors::*;
pub use from_sql::*;
pub use from_text::*;
pub use model::*;
pub use pager::*;
pub use pool::*;
pub use projectable::*;
pub use projection::*;
pub use r#async::*;
pub use r#where::Where;
pub use rows::*;
pub use sql::*;
pub use structure::*;
pub use to_sql::*;
pub use to_text::*;
pub use transaction::Transaction;
pub use tuple::*;
macro_rules! regex {
($regex:literal) => {{
lazy_static::lazy_static! {
static ref REGEX: regex::Regex = regex::Regex::new($regex).unwrap();
};
®EX
}};
}
pub(crate) use regex;
/**
* Easily create pk argument for where clause, including [`find_by_pk`]
* function.
*
* ```
* # #[macro_use] extern crate elephantry;
* # fn main() {
* # let uuid = "";
* # let name = "";
* pk!(uuid);
* pk![uuid, name];
* pk!{uuid => "uuid", name => "name"};
* # }
* ```
*
* [`find_by_pk`]: crate::Connection::find_by_pk
*/
#[macro_export]
macro_rules! pk {
($($pk:ident),+ $(,)?) => {
$crate::pk!($(
$pk => $pk,
)*)
};
($($key:expr => $value:expr),+ $(,)?) => {{
let mut hash = std::collections::HashMap::new();
$(
hash.insert(stringify!($key), &$value as &dyn $crate::ToSql);
)*
hash
}}
}
/**
* Likes [`pk`] macro but for value argument, including [`update_by_pk`]
* function.
*
* [`pk`]: crate::pk
* [`update_by_pk`]: crate::Connection::update_by_pk
*/
#[macro_export]
macro_rules! values {
($($pk:ident),+ $(,)?) => {
$crate::values!($(
$pk => $pk,
)*)
};
($($key:expr => $value:expr),+ $(,)?) => {{
let mut hash = std::collections::HashMap::new();
$(
hash.insert(stringify!($key).to_string(), &$value as &dyn $crate::ToSql);
)*
hash
}}
}
#[cfg(test)]
mod test {
use std::collections::HashMap;
#[macro_export]
macro_rules! sql_test_from {
($sql_type:ident, $rust_type:ty, $tests:expr) => {
#[test]
fn from_text() -> $crate::Result {
$crate::test::from_text::<$rust_type>(stringify!($sql_type), &$tests)
}
#[test]
fn from_binary() -> $crate::Result {
$crate::test::from_binary::<$rust_type>(stringify!($sql_type), &$tests)
}
};
}
pub(crate) fn from_text<T>(sql_type: &str, tests: &[(&str, T)]) -> crate::Result
where
T: crate::FromSql + crate::ToSql + PartialEq + std::fmt::Debug,
{
let conn = crate::test::new_conn()?;
for (value, expected) in tests {
let result = conn.execute(&format!("select {value}::{sql_type} as actual"))?;
assert_eq!(result.get(0).get::<T>("actual"), *expected, "from_text");
}
Ok(())
}
pub(crate) fn from_binary<T>(sql_type: &str, tests: &[(&str, T)]) -> crate::Result
where
T: crate::FromSql + crate::ToSql + PartialEq + std::fmt::Debug,
{
let conn = crate::test::new_conn()?;
for (value, expected) in tests {
let result = conn.query::<HashMap<String, T>>(
&format!("select {value}::{sql_type} as actual"),
&[],
)?;
assert_eq!(
result.get(0).get("actual").unwrap(),
expected,
"from_binary"
);
}
Ok(())
}
#[macro_export]
macro_rules! sql_test_to {
($sql_type:ident, $rust_type:ty, $tests:expr) => {
#[test]
fn to_text() -> $crate::Result {
$crate::test::to_text::<$rust_type>(stringify!($sql_type), &$tests)
}
#[test]
fn to_binary() -> $crate::Result {
$crate::test::to_binary::<$rust_type>(stringify!($sql_type), &$tests)
}
};
}
pub(crate) fn to_text<T>(sql_type: &str, tests: &[(&str, T)]) -> crate::Result
where
T: crate::Entity + crate::ToSql + PartialEq + std::fmt::Debug,
{
let conn = crate::test::new_conn()?;
for (_, value) in tests {
let result = conn.query::<T>(&format!("select $1::{sql_type}"), &[value]);
assert!(dbg!(&result).is_ok());
assert_eq!(&result.unwrap().get(0), value, "to_text");
}
Ok(())
}
pub(crate) fn to_binary<T>(sql_type: &str, tests: &[(&str, T)]) -> crate::Result
where
T: crate::Entity + crate::ToSql + PartialEq + std::fmt::Debug,
{
let conn = crate::test::new_conn()?;
for (_, value) in tests {
let result: crate::pq::Result = conn
.connection
.lock()
.map_err(|e| crate::Error::Mutex(e.to_string()))?
.exec_params(
&format!("select $1::{sql_type}"),
&[value.ty().oid],
&[value.to_binary()?],
&[crate::pq::Format::Binary],
crate::pq::Format::Binary,
)
.try_into()?;
let rows: crate::Rows<T> = result.into();
assert_eq!(&rows.get(0), value, "to_binary");
}
Ok(())
}
#[macro_export]
macro_rules! sql_test {
($sql_type:ident, $rust_type:ty, $tests:expr) => {
mod $sql_type {
$crate::sql_test_from!($sql_type, $rust_type, $tests);
$crate::sql_test_to!($sql_type, $rust_type, $tests);
}
};
}
pub fn dsn() -> String {
std::env::var("DATABASE_URL").unwrap_or_else(|_| "host=localhost".to_string())
}
pub fn new_conn() -> crate::Result<&'static crate::Connection> {
static INIT: std::sync::Once = std::sync::Once::new();
INIT.call_once(|| {
env_logger::init();
});
static POOL: std::sync::OnceLock<crate::Result<crate::Pool>> = std::sync::OnceLock::new();
let pool = POOL
// @TODO #[feature(once_cell_try)]
.get_or_init(|| {
let pool = crate::Pool::new(&dsn())?;
pool.execute("create extension if not exists hstore")?;
pool.execute("create extension if not exists ltree")?;
pool.execute("set lc_monetary to 'en_US.UTF-8';")?;
pool.execute(
"
do $$
begin
if not exists (select 1 from pg_type where typname = 'compfoo')
then
create type compfoo as (f1 int, f2 text);
end if;
if not exists (select 1 from pg_type where typname = 'mood')
then
create type mood as enum ('Sad', 'Ok', 'Happy');
end if;
if not exists (select 1 from pg_type where typname = 'us_postal_code')
then
create domain us_postal_code as text
check(
value ~ '^\\d{5}$'
or value ~ '^\\d{5}-\\d{4}$'
);
end if;
end$$;
",
)?;
Ok(pool)
})
.as_ref()
.unwrap();
Ok(pool)
}
#[test]
fn test_pk_one() {
let uuid = "1234";
let pk = crate::pk!(uuid);
assert_eq!(pk.len(), 1);
assert!(pk.contains_key("uuid"));
}
#[test]
fn test_pk_multi() {
let uuid = "1234";
let name = "name";
let pk = crate::pk![uuid, name,];
assert_eq!(pk.len(), 2);
assert!(pk.contains_key("uuid"));
assert!(pk.contains_key("name"));
}
#[test]
fn test_pk_hash() {
let pk = crate::pk! {
uuid => "1234",
name => "name",
};
assert_eq!(pk.len(), 2);
assert!(pk.contains_key("uuid"));
assert!(pk.contains_key("name"));
}
#[derive(elephantry_derive::Entity)]
#[elephantry(
internal,
model = "Model",
structure = "Structure",
relation = "entity"
)]
pub struct Entity {
#[elephantry(pk, column = "employee_id")]
pub id: i32,
pub first_name: String,
#[elephantry(default)]
pub last_name: String,
}
}