co-orm-macros 0.2.8

Derive macro implement Create, Read, Update, and Delete (CRUD) methods base on sqlx.
Documentation
co-orm-macros-0.2.8 has been yanked.

Rust derive macro implement Create, Read, Update, and Delete (CRUD) methods base on sqlx.

Use

adding the following to your project's Cargo.toml:

[dependencies]
co-orm = { virsion = "0.2", features = ["mysql"] }
sqlx = { version = "0.7", features = ["mysql","runtime-tokio-native-tls"] }

[dev-dependencies]
tokio = { version = "1", features = ["macros"] }

  • features: mysql, postgres, sqlite, mssql

Examples

use co_orm::{Crud, FromRow};
#[derive(Debug, Crud, FromRow)]
#[orm_rename = "users"] // rename table name
struct User {
    // #[orm_pk] // default first field is primary key
    #[orm_seq] // sequence field, insert will ignore this field
    pub id: u64,
    
    #[orm_by] // generate query_by_field,update_by_field,delete_by_field
    //#[orm_rename = "name"] // rename field name
    pub name: String,
    #[orm_update] // generate method update_xxx. 
    pub password: String,
    #[orm_ignore] // ignore field
    pub addr: Option<String>,
    // #[sqlx(default)]
    // pub age: i32,
}


pub async fn get_pool() -> Result<MySqlPool> {
    MySqlPoolOptions::new()
        .connect("mysql://root:password@192.168.1.199:3306/hello").await
}

#[tokio::test]
async fn test_query() {
    let pool=get_pool().await.unwrap();
    let u = User::get(&pool, 1).await.unwrap();
    println!("get {:?}", u);
    let u = User::get_by(&pool, "where id=1").await.unwrap();
    println!("get {:?}", u);
    
}

#[derive(Crud)]

`#[derive(FromRow)]`
generate method: get, get_by, query, query_by, update, delete, insert, insert_all.

attributes:

`#[co_orm(id)]`
default first field is primary key or set.

`#[co_orm(seq)]`
sequence field, auto increment. insert will skip this field.

`#[co_orm(rename="name")]`
rename table name or field name. 
default table name by struct name to_table_case: UserDetail => user_detail. 
default field name by field name to_snake_case: UserDetail => user_detail. 

`#[co_orm(skip)]`
ignore field.

`#[co_orm(update)]`
generate method update_xxx. 

`#[co_orm(by)]`
generate query_by_field,update_by_field,delete_by_field.

#[derive(FromRow)]

`#[derive(FromRow)]`
impl sqlx::FromRow trait.

or use `#[derive(sqlx::FromRow)]` macro or impl `sqlx::FromRow` trait.

if using sqlx::FromRow, change `#[co_orm(skip)]` to `#[sqlx(skip)]` .