ensemble 0.0.5

A Laravel-inspired ORM
Documentation 
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

use rbatis::{rbdc::db::Connection as RbdcConnection, RBatis};
#[cfg(feature = "mysql")]
use rbdc_mysql::{driver::MysqlDriver, options::MySqlConnectOptions};
#[cfg(feature = "postgres")]
use rbdc_pg::{driver::PgDriver, options::PgConnectOptions};
use std::sync::OnceLock;
#[cfg(any(feature = "mysql", feature = "postgres"))]
use {rbatis::DefaultPool, std::str::FromStr};

pub type Connection = Box<dyn RbdcConnection>;

static DB_POOL: OnceLock<RBatis> = OnceLock::new();

#[derive(Debug, thiserror::Error)]
pub enum SetupError {
	#[error("The provided database URL is invalid.")]
	UrlError(#[from] rbatis::Error),

	#[cfg(any(feature = "mysql", feature = "postgres"))]
	#[error("The database pool has already been initialized.")]
	AlreadyInitialized,
}

/// Sets up the database pool.
///
/// # Errors
///
/// Returns an error if the database pool has already been initialized, or if the provided database URL is invalid.
#[cfg(any(feature = "mysql", feature = "postgres"))]
pub fn setup(database_url: &str) -> Result<(), SetupError> {
	let rb = RBatis::new();

	#[cfg(feature = "mysql")]
	tracing::info!(
		database_url = database_url,
		"Setting up MySQL database pool..."
	);
	#[cfg(feature = "postgres")]
	tracing::info!(
		database_url = database_url,
		"Setting up PostgreSQL database pool..."
	);

	#[cfg(feature = "mysql")]
	rb.init_option::<MysqlDriver, MySqlConnectOptions, DefaultPool>(
		MysqlDriver {},
		MySqlConnectOptions::from_str(database_url)?,
	)?;
	#[cfg(feature = "postgres")]
	rb.init_option::<PgDriver, PgConnectOptions, DefaultPool>(
		PgDriver {},
		PgConnectOptions::from_str(database_url)?,
	)?;

	DB_POOL
		.set(rb)
		.map_err(|_| SetupError::AlreadyInitialized)?;

	Ok(())
}

#[derive(Debug, thiserror::Error)]
pub enum ConnectError {
	#[error("The database pool has not been initialized.")]
	NotInitialized,

	#[error("An error occurred while connecting to the database.")]
	Connection(#[from] rbatis::Error),
}

/// Returns a connection to the database. Used internally by `ensemble` models.
///
/// # Errors
///
/// Returns an error if the database pool has not been initialized, or if an error occurs while connecting to the database.
pub async fn get() -> Result<Connection, ConnectError> {
	match DB_POOL.get() {
		None => Err(ConnectError::NotInitialized),
		Some(rb) => Ok(rb.get_pool()?.get().await?),
	}
}

pub enum Database {
	MySQL,
	PostgreSQL,
}

impl Database {
	pub const fn is_mysql(&self) -> bool {
		matches!(self, Self::MySQL)
	}

	pub const fn is_postgres(&self) -> bool {
		matches!(self, Self::PostgreSQL)
	}
}

pub const fn which_db() -> Database {
	#[cfg(all(not(feature = "mysql"), not(feature = "postgres")))]
	panic!("Either the `mysql` or `postgres` feature must be enabled to use `ensemble`.");

	#[cfg(all(feature = "mysql", feature = "postgres"))]
	panic!("Both the `mysql` and `postgres` features are enabled. Please enable only one of them.");

	if cfg!(feature = "mysql") {
		Database::MySQL
	} else {
		Database::PostgreSQL
	}
}