11 releases

0.3.8	Sep 29, 2023
0.3.7	Sep 29, 2023
0.2.9	Sep 14, 2023
0.2.7	Aug 31, 2023
0.0.0	~~Nov 22, 2021~~

#334 in Database interfaces

MIT/Apache

255KB
6.5K SLoC

Arel

Install

// Cargo.toml
serde = { version = "1.0", features = ["derive"] }
arel = { version = "0.3", features = ["runtime-tokio-native-tls", "sqlite"] } // sqlte | mysql | postgres

Demo

use arel::prelude::*;
#[arel]
struct User {
  #[arel(primary_key)]
  id: i64,
  name: String,
  #[arel(rename = "type")]
  r#type: String,
  expired_at: Option<chrono::DateTime<chrono::FixedOffset>>,
}
impl Arel for User {}

// init db from Environment
std::env::set_var("DATABASE_URL", "sqlite::memory:");
arel::db::visitor::init().await?;
// or init db from code
arel::db::visitor::get_or_init(|| Box::pin(async { arel::db::DatabasePoolOptions::new().max_connections(5).connect("sqlite::memory:").await })).await?;

// total count
let count = User::query().select_sql("COUNT(*)").fetch_count().await?;
println!("total: {}", count);

// create
let mut user = User {
  name: Set("n1"),
  ..Default::default()
};
user.save().await?;

// select
let user = User::query().r#where("id", 1).fetch_one().await?;
let uesrs: Vec<User> = User::query().where_range("id", ..=10).fetch_all().await?;

// update
let mut user: User = User::query().fetch_one().await?;
// active_user.name.set("n-1");
user.assign(&User {
    name: Set("n-1"),
    ..Default::default()
});
user.save().await?;

// destroy
user.destroy().await?;

Query

select

User::query().select(vec!(["id", "name"])).to_sql();

where

let sql = User::query().r#where("name", "n1").r#where("id", 1).to_sql();
// where_not
let sql = User::query().where_not(id: vec![1, 2, 3]).to_sql();
// where_range
let sql = User::query().where_range("age", 18..25).to_sql();

joins

let sql = User::query().join::<Wallet>(arel::JoinConst::InnerJoin).to_sql();
let sql = User::query().join_sql("INNER JOIN wallet on user.id = wallet.user_id").to_sql();

lock

// should use in transaction
let user: User = User::query().r#where("name", "n1").lock().fetch_one_with_exec(tx);

group & having

let sql = User::query().group(vec!["name"]).having("age", 18..).to_sql();

order

let sql = User::query().order("created_at", arel::SortConst::Desc).to_sql();
let sql = User::query().order_asc().to_sql();
let sql = User::query().order_desc().to_sql();

limit & offset

let sql = User::query().limit(10).to_sql();
let sql = User::query().offset(10)();
let sql = User::query().paginate(1, 10).to_sql();

Insert

transaction

User::with_transaction(|tx| {
  Box::pin(async move {
    // for entry in 1i32..=100 {
    //   sqlx::query("INSERT INTO user (name) VALUES ($1)")
    //       .bind(format!("name-{}", entry))
    //       .bind("Admin")
    //       .execute(tx.as_mut())
    //       .await?;
    // }
    let mut user = User {
      name: Set("n1"),
      r#type: Set("ADMIN"),
      ..Default::default()
    };
    user.save_with_tx(tx).await?;
    Ok(None)
  })
})
.await?;

Update

increment

let user = User::query().r#where("id", 1).fetch_one().await?;
user.increment("lock_version", 5).await?;

Dependencies

~11–30MB
~468K SLoC