#sqlx #crud #orm #sql

bin+lib co-orm

Implement Create, Read, Update, and Delete (CRUD) methods for sqlx

13 releases

0.3.9 Mar 18, 2024
0.3.3 Dec 15, 2023
0.3.2 Nov 27, 2023
0.2.5 Dec 19, 2022
0.2.3 Oct 24, 2022

#613 in Database interfaces

Download history 54/week @ 2024-02-23 13/week @ 2024-03-01 20/week @ 2024-03-08 553/week @ 2024-03-15 73/week @ 2024-03-22 19/week @ 2024-03-29 6/week @ 2024-04-05

119 downloads per month

MIT/Apache

19KB
77 lines

Implement Create, Read, Update, and Delete (CRUD) methods for sqlx.

Use

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

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


  • features: mysql, postgres, sqlite, mssql

Examples

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


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;
    println!("get {:?}", u);
    let u = User::get_by(&pool, "where id=?", args!(1)).await;
    println!("get_by {:?}", u);
    let u = User::query_by_name(&pool, "plucky".into()).await;
    println!("query_by_name {:?}", u);
    let u =User::query(&pool).await;
    println!("list {:?}",u);

    // u.update(&pool).await;
    // u.insert(&pool).await;
    // u.delete(&pool).await

    // let list = vec![User::new(0, "lusy3", "123456"),User::new(0, "lusy5", "123456")];
    // let r =User::insert_all(&pool, list).await;
    // println!("list: {:?}",r);
    
    
}

#[derive(Crud)]

generate method: get, get_by, query, query_by, update, delete, insert, insert_all, query_page_by

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(skip_insert)]

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 qet_by_field, query_by_field, update_by_field, delete_by_field.

#[derive(FromRow)]

impl sqlx::FromRow trait.

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

if using sqlx::FromRow, if have #[co_orm(skip)] add #[sqlx(skip)] .

macro_export

args

 let args = args!(&name, age);

query

query!("insert into users (name, password) values (?,?)", name, password).execute(&pool).await

query_as

query_as!(User, "select * from users where name = ?", name).fetch_one(&pool).await

Dependencies

~145KB