Akita - Mini orm for rust
This Crate offers:
- MySql database's helper in pure rust;
- SQLite database's helper in pure rust;
- A mini orm framework (With MySQL/SQLite)。
Features:
- Other Database support, i.e. support Oracle, MSSQL...;
- support of named parameters for custom condition;
You may be looking for:
Click to show Cargo.toml. Run this code in the playground.
[dependencies]
# The core APIs, including the Table traits. Always
# required when using Akita. using #[derive(AkitaTable)]
# to make Akita work with structs defined in your crate.
akita = { version = "0.4.0", features = ["akita-mysql"] }
use akita::*;
/// Annotion Support: AkitaTable、table_id、field (name, exist, fill(function, mode))
#[derive(AkitaTable, Clone, Default)]
#[table(name = "t_system_user")]
pub struct User {
#[table_id(name = "id")]
pub pk: i64,
pub id: String,
pub headline: Option<NaiveDateTime>,
/// 状态
pub status: u8,
/// 用户等级 0.普通会员 1.VIP会员
pub level: u8,
/// 生日
pub birthday: Option<NaiveDate>,
/// 性别
pub gender: u8,
#[field(exist = "false", fill="is_org_build")]
pub is_org: bool,
#[field(name = "token", fill(function = "token_build", mode="default"))]
pub url_token: String,
}
static area: &str = "china";
fn is_org_build() -> bool {
area.eq("china")
}
fn token_build() -> String {
// generate the token
todo!()
}
fn main() {
let cfg = AkitaConfig::new(String::from("mysql:https://root:password@localhost:3306/akita"))
.set_connection_timeout(Duration::from_secs(6))
.set_log_level(LogLevel::Info).set_max_size(6);
let akita = Akita::new(cfg).expect("must be ok");
// The Wrapper to build query condition
let wrapper = Wrapper::new()
.eq("username", "ussd") // username = 'ussd'
.gt("age", 1) // age > 1
.lt("age", 10) // age < 10
.inside("user_type", vec!["admin", "super"]) // user_type in ('admin', 'super')
.and(|wrapper| { // or
wrapper.like("username", &name)
.or_direct().like("username", &name)
});
// CRUD with Akita
let insert_id: Option<i32> = akita.save(&User::default()).unwrap();
let _ = akita.save_batch(&[&User::default()]).unwrap();
// Update with wrapper
let res = akita.update(&User::default(), Wrapper::new().eq("name", "Jack")).unwrap();
// Update with primary id
let res = akita.update_by_id(&User::default());
// Query return List
let list: Vec<User> = akita.list(Wrapper::new().eq("name", "Jack")).unwrap();
// Query return Page
let pageNo = 1;
let pageSize = 10;
let page: IPage<User> = akita.page(pageNo, pageSize, Wrapper::new().eq("name", "Jack")).unwrap();
// Remove with wrapper
let res = akita.remove::<User>(Wrapper::new().eq("name", "Jack")).unwrap();
// Remove with primary id
let res = akita.remove_by_id::<User,_>(0).unwrap();
// Get the record count
let count = akita.count::<User>(Wrapper::new().eq("name", "Jack")).unwrap();
// Query with original sql
let user: User = akita.exec_first("select * from t_system_user where name = ? and id = ?", ("Jack", 1)).unwrap();
// Or
let user: User = akita.exec_first("select * from t_system_user where name = :name and id = :id", params! {
"name" => "Jack",
"id" => 1
}).unwrap();
let res = akita.exec_drop("select now()", ()).unwrap();
// Transaction
akita.start_transaction().and_then(|mut transaction| {
let list: Vec<User> = transaction.list(Wrapper::new().eq("name", "Jack"))?;
let insert_id: Option<i32> = transaction.save(&User::default())?;
transaction.commit()
}).unwrap();
}
fn main() {
let cfg = AkitaConfig::new(String::from("mysql:https://root:password@localhost:3306/akita"))
.set_connection_timeout(Duration::from_secs(6))
.set_log_level(LogLevel::Info).set_max_size(6);
let akita = Akita::new(cfg).expect("must be ok");
// CRUD with Entity
let model = User::default();
// insert
let insert_id = model.insert::<Option<i32>, _>(&akita).unwrap();
// update
let res = model.update_by_id::<_>(&akita).unwrap();
// delete
let res = model.delete_by_id::<i32,_>(&akita, 1).unwrap();
// list
let list = User::list::<_>(Wrapper::new().eq("name", "Jack"), &akita).unwrap();
// page
let page = User::page::<_>(pageNo, pageSize, Wrapper::new().eq("name", "Jack"), &akita).unwrap();
}
fn main() {
pub static AK:Lazy<Akita> = Lazy::new(|| {
let mut cfg = AkitaConfig::new("xxxx".to_string()).set_max_size(5).set_connection_timeout(Duration::from_secs(5)).set_log_level(LogLevel::Info);
Akita::new(cfg).unwrap()
});
#[sql(AK,"select * from mch_info where mch_no = ?")]
fn select_example(name: &str) -> Vec<MchInfo> { todo!() }
// or:
#[sql(AK,"select * from mch_info where mch_no = ?")]
fn select_example2(ak: &AKita, name: &str) -> Vec<MchInfo> { todo!() }
// ...
}
let mut wrapper = Wrapper::new().like(true, "column1", "ffff")
.eq(true, "column2", 12)
.eq(true, "column3", "3333")
.inside(true, "column4", vec![1,44,3])
.not_between(true, "column5", 2, 8)
.set(true, "column1", 4);
akita-mysql
- to use mysqlakita-sqlite
- to use sqliteakita-auth
- to use some auth mehodakita-fuse
- to use some fuse feature
AkitaTable
- to make Akita work with structsFromValue
- from value with akitaToValue
- to value with akitatable_id
- to make Table Identfield
- to make struct field with own database.name
- work with column, make the table's field name. default struct' field name.exist
- ignore struct's field with table. default true.
Option<T>
u8, u32, u64
i32, i64
usize
bool
f32, f64
str, String
serde_json::Value
NaiveDate, NaiveDateTime
To setup the development envrionment run cargo run
.
MrPan <[email protected]>
Akita is a personal project. At the beginning, I just like Akita dog because of my hobbies. I hope this project will grow more and more lovely. Many practical database functions will be added in the future. I hope you can actively help this project grow and put forward suggestions. I believe the future will be better and better.
Licensed under either of Apache License, Version 2.0 or MIT license at your option.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in Akita by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.