rusql-alchemy 0.3.0-rc

Rust Alchemy is Django ORM like lib for Rust
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

/// This module contains the macros used in the crate.
#[macro_use]
mod macros;

/// This module contains the database-related functionality.
pub mod db;

/// This module contains the prelude for the crate.
pub mod prelude;

/// This module contains the custom types used in the crate.
pub mod types;

/// The placeholder for the database query.
pub use db::models::PLACEHOLDER;
pub use utils::*;

mod utils;

/// Alias for the database connection pool.
pub type Connection = sqlx::Pool<sqlx::Any>;

use sqlx::any::{install_default_drivers, AnyPoolOptions};

async fn establish_connection(url: String) -> Connection {
    install_default_drivers();
    AnyPoolOptions::new()
        .max_connections(5)
        .connect(&url)
        .await
        .unwrap()
}

/// Represents a database.
pub struct Database {
    /// The connection pool for the database.
    pub conn: Connection,
}

impl Database {
    /// Creates a new instance of `Database`.
    ///
    /// # Returns
    ///
    /// Returns a new `Database` instance.
    ///
    /// # Example
    /// ```rust
    /// use rusql_alchemy::Database;
    ///
    /// #[tokio::main]
    /// async fn main() {
    ///     let db = Database::new().await;
    /// }
    /// ```
    pub async fn new() -> Self {
        dotenv::dotenv().ok();
        let database_url =
            std::env::var("DATABASE_URL").expect("-> Pls set the DATABASE_ULR in `.env`");
        Self {
            conn: establish_connection(database_url).await,
        }
    }
}