Rust Tiny Orm

一个基于sqlx的极简orm，本项目将sql代码以derive属性方式和结构体进行关联，并自动生成相关CRUD相关API，可根据需要实现任意复杂度的数据获取。

本项目开发主要原因：

1. 目前rust的orm产品都太大而全了，习惯了Python Django的自动化的实现，对DSL相当不习惯，个人觉得太繁琐了；
2. 实际orm就是api和sql的转换，因为orm的实现限制，sql的复杂查询的实现都比较别扭，为了与数据库交互还得额外学习大量orm dsl的用法，有点舍本求木了！

因此，是否可以将数据查询的sql和rust结合，由程序员自行控制sql的表现，这样在rust的高性能助力下，我们可以写成性能超级赞的数据库应用。

特性

根据你的数据库类型选择不同特性，缺省为mysql

1. mysql
2. postgres
3. sqlite
4. mssql
5. any

派生宏说明

• #[derive(TinyOrm)]
  • 为结构体自动实现数据库模型
• #[ormtablename_pref = "core"]
  • 自动生成的数据库表名称前缀
  • 未设置则表名称为结构名称的蛇形命名,如TestUser转换为coretestuser
• #[ormtablename = "coreuser"]
  • 自定义数据库表名称，可选
  • 未设置则表名称为结构名称的蛇形命名,如TestUser转换为testuser
• #[ormselectfield = "id, name"]
  • 设置查询返回字段SQL，可选，默认为*
• #[ormselectjoin = "JOIN usertype ON usertype.id = user.type_id"]
  • 设置查询表join的SQL，可选，默认为空白
• #[ormselectbyidwhere = "id = ? "]
  • 设置按照某id字段查询where的SQL，可选，默认为id=?
• #[ormexistwhere = "id = ?"]
  • 设置记录是否存在的where部分sql，可选，默认为id=?
• #[orminsertfieldandvalue = "(name,mobilephone,password,usertypeid,orgid) VALUES (?,?,?,?,?)"]
  • 设置insert sql的field和value部分，可选，默认为空白
• #[ormdeletewhere = "id = ?"]
  • 设置删除记录的where部分sql，可选，默认为id=?
• #[ormupdateset = "ip = ? , port = ?"]
  • 设置更新记录的set部分sql，可选，默认为空白
• #[ormupdatewhere = "id = ?"]
  • 设置更新记录的where部分sql，可选，默认为空白
• #[ormquery(
  • name = "nameandtel",
  • sqlwhere = "user.name = ? and mobilephone = ?",
  • args = "name:&str,mobilephone:&str",
  • doc = "根据姓名和手机号查询用户"
  • )]
  • 自动生成ormqueryby查询方法，生成后的函数定义如下: ignore /// 根据姓名和手机号查询用户 pub async fn orm_query_by_name_and_tel(pool: &TinyOrmDbPool, name:&str,mobile_phone:&str) ->Result<Vec<Self>> { let sql = Self::DB_META.build_select_sql("name = ? and mobile_phone = ?"); let query = Self::db_query(&sql) .bind(name) .bind(mobile_phone); Self::db_fetch_all(pool,query,Self::orm_row_map).await }

添加依赖

修改Cargo.toml，增加

``` [dependencies] async-trait = "^0.1" tinyormmacro_derive="^0.2"

[dependencies.tinyormcore] version = "^0.2" features = [ "mysql", ]

```

示例代码

``` //! 数据库模型的测试 use sqlx::mysql::MySqlPoolOptions; use sqlx::Row; use tinyormcore::prelude::*;

use super::*;

[derive(Debug,PartialEq, Eq)]

pub struct UserType { /// 类型编号 pub id: Option, /// 类型名称 pub name: String, /// 中断短信模板 pub template: String, } impl UserType { /// 完整创建器 /// /// # 参数说明 /// /// * id 类型编号 /// * name 类型名称 /// * template 中断短信模板 pub fn new(id: u32, name: &str, template: &str) -> Self { UserType { id: Some(id), name: name.into(), template: template.into(), } } } /// 测试用户

[allow(dead_code)]

[derive(TinyOrm, TinyOrmQuery, Debug, PartialEq, Eq)]

[ormtablename_pref = "core"]

[ormtablename = "user"]

[ormselectfield = "user.*,usertype.name as usertypename, usertype.template"]

[ormselectjoin = "JOIN usertype ON usertype.id = usertypeid"]

[ormselectbyidwhere = "user.id = ? "]

[ormdeletewhere = "id = ? "]

/// 自动生成ormqueryby查询方法，生成后的函数定义如下 /// /// 根据姓名和手机号查询用户 /// pub async fn ormquerybynameandtel(pool: &TinyOrmDbPool, name:&str,mobilephone:&str) ->Result> { /// let sql = Self::DBMETA.buildselectsql("name = ? and mobilephone = ?"); /// let query = Self::dbquery(&sql) /// .bind(name) /// .bind(mobilephone); /// Self::dbfetchall(pool,query,Self::ormrowmap).await /// }

[orm_query(

name = "name_and_tel",
sql_where = "user.name = ? and mobile_phone = ?",
args = "name:&str,mobile_phone:&str",
doc = "根据姓名和手机号查询用户"

)]

[orm_query(

name = "name",
sql_where = "user.name = ?",
args = "name:&str",
doc = "根据姓名查询用户"

)] pub struct TestUser { /// 类型编号 pub id: Option, /// 类型名称 pub name: String, /// 手机号码 pub mobilephone: String, /// 密码 password: String, /// 用户类型 pub usertype: UserType, }

impl TestUser { /// 完整创建器 /// /// # 参数说明 /// /// * id 编号 /// * name 姓名 /// * mobilephone 手机 /// * password 密码 /// * usertype 用户类型 /// * org 对应机构 pub fn new( id: u32, name: &str, mobilephone: &str, password: &str, usertype: UserType, ) -> Self { Self { id: Some(id), name: name.into(), mobilephone: mobilephone.into(), password: password.into(), usertype, } } } /// 实现数据获取接口 impl TinyOrmData for TestUser { /// 将sql返回数据映射为TestUser fn ormrowmap(row: TinyOrmSqlRow) -> Self { TestUser::new( row.get::("id"), row.get("name"), row.get("mobilephone"), row.get("password"), UserType::new( row.get::("usertypeid"), row.get("usertypename"), row.get("template"), ), ) } }

async fn getpool() -> Result { let username = "netguard"; let password = "netguard@20220806"; let ip = "localhost"; let port = 3306; let dbname = "abcnetguard"; let pool = MySqlPoolOptions::new() .maxconnections(1) .connect(&format!( "mysql://{}:{}@{}:{}/{}", username, password, ip, port, dbname )) .await?; Ok(pool) }

/// .测试SQL生成

[test]

fn testuser() { println!("user sql : \n{}", TestUser::DBMETA.select_sql); }

/// .测试SQL生成

[test]

fn testdbquery() { tokio::runtime::Builder::newcurrentthread() .enableall() .build() .unwrap() .blockon(async { let pool = getpool().await.unwrap(); let data = TestUser::ormget_all(&pool).await.unwrap(); dbg!(data); }); }

/// 测试根据id获取用户

[test]

fn testormgetbyid() { tokio::runtime::Builder::newcurrentthread() .enableall() .build() .unwrap() .blockon(async { let pool = getpool().await.unwrap(); let user = TestUser::ormgetbyid(&pool, 1).await.unwrap(); dbg!(user); }); } /// 测试根据姓名和手机获取用户

[test]

fn testormquerybynameandmobile() { tokio::runtime::Builder::newcurrentthread() .enableall() .build() .unwrap() .blockon(async { let pool = getpool().await.unwrap(); let user = TestUser::ormquerybynameandtel(&pool, "张三", "1850703xxxx") .await .unwrap(); dbg!(user); }); }

/// 测试根据姓名和手机获取用户

[test]

fn testormquerybyname() { tokio::runtime::Builder::newcurrentthread() .enableall() .build() .unwrap() .blockon(async { let pool = getpool().await.unwrap(); let user = TestUser::ormquerybyname(&pool, "张三") .await .unwrap(); dbg!(user); }); } /// 测试是否存在

[test]

fn testormexists() { tokio::runtime::Builder::newcurrentthread() .enableall() .build() .unwrap() .blockon(async { let pool = getpool().await.unwrap(); let isexist = TestUser::ormexists(&pool, 1).await.unwrap(); dbg!(isexist); }); }

/// 测试是否存在

[test]

fn testormdelete() { tokio::runtime::Builder::newcurrentthread() .enableall() .build() .unwrap() .blockon(async { let pool = getpool().await.unwrap(); TestUser::ormdelete(&pool, 6).await.unwrap(); }); }

/// 测试filter

[test]

fn testdbfilter() { tokio::runtime::Builder::newcurrentthread() .enableall() .build() .unwrap() .blockon(async { let pool = getpool().await.unwrap(); let sql = TestUser::DBMETA.buildselectsql("name like ? "); println!("{sql}"); let key = String::from("%黄%"); let data = TestUser::ormfilterwith_sql(&pool, &sql, &key) .await .unwrap(); dbg!(data); }); }

```