GOOD-ORMNING

• 在 crates.io
• 在 docs.rs

Good-ormning可能是一个ORM，概括来说

1. 在build.rs中定义模式和查询
2. Good-ormning生成设置/迁移数据库的函数
3. Good-ormning为每个查询生成函数

你为什么需要它

• 你想要从表定义到查询，跨版本的端到端类型安全
• 你希望在Rust中完成所有事情，你不想需要启动数据库并手动运行SQL

功能

• 无宏
• 无泛型
• 无特质（好吧，只有简单的特质来帮助自定义类型的实现 仅限）
• 无样板代码
• 自动迁移，无迁移-模式不匹配
• 查询参数类型检查 - 无运行时错误由于参数类型、数量或顺序
• 通过查询模拟进行查询逻辑类型检查
• 查询结果类型检查 - 无运行时错误由于结果类型、数量或顺序
• 生成速度快，运行时开销最小

与其他Rust ORM一样，Good-ormning不会从实际数据库工作流程中抽象出来，而是旨在通过正常的SQL增强类型检查。

请参阅下面的比较，了解Good-ormning与其他Rust ORM的不同之处。

当前状态

• 基本功能正常，这对我的基本用途来说足够了
• 中等测试覆盖率
• 缺少高级功能 - 如果您需要某些功能，请告诉我
• 一些易用性问题，接口可能在即将发布的版本中更改

支持数据库

• PostgreSQL（功能 pg）通过 tokio-postgres
• Sqlite（功能 sqlite）通过 rusqlite

入门

第一次

1. 你需要以下运行时依赖项

   • good-ormning-runtime
   • tokio-postgres用于PostgreSQL
   • rusqlite用于Sqlite

   以及build.rs依赖项

   • good-ormning

   并且您必须启用（或多个）以下数据库功能之一

   • pg
   • sqlite

   可能需要添加 chrono 以支持 DateTime。

2. 创建一个 build.rs 文件，并定义您的初始架构版本和查询。

3. 调用 goodormning::generate() 输出生成的代码。

4. 在您的代码中，在创建数据库连接后，调用 migrate。

架构变更

1. 复制您的前一个版本架构，保持旧架构版本不变。根据需要修改新架构和查询。
2. 将旧架构版本和新架构版本都传递给 goodormning::generate()，它会生成新的迁移语句。
3. 在运行时，migrate 调用将确保数据库更新到新的架构版本。

示例

此 build.rs 文件

use std::{
    path::PathBuf,
    env,
};
use good_ormning::sqlite::{
    Version,
    schema::{
        field::*,
        constraint::*,
    },
    query::{
        expr::*,
        select::*,
    },
    *
};

fn main() {
    println!("cargo:rerun-if-changed=build.rs");
    let root = PathBuf::from(&env::var("CARGO_MANIFEST_DIR").unwrap());
    let mut latest_version = Version::default();
    let users = latest_version.table("zQLEK3CT0", "users");
    let id = users.rowid_field(&mut latest_version, None);
    let name = users.field(&mut latest_version, "zLQI9HQUQ", "name", field_str().build());
    let points = users.field(&mut latest_version, "zLAPH3H29", "points", field_i64().build());
    good_ormning::sqlite::generate(&root.join("tests/sqlite_gen_hello_world.rs"), vec![
        // Versions
        (0usize, latest_version)
    ], vec![
        // Latest version queries
        new_insert(&users, vec![(name.clone(), Expr::Param {
            name: "name".into(),
            type_: name.type_.type_.clone(),
        }), (points.clone(), Expr::Param {
            name: "points".into(),
            type_: points.type_.type_.clone(),
        })]).build_query("create_user", QueryResCount::None),

        new_select(&users).where_(Expr::BinOp {
            left: Box::new(Expr::Field(id.clone())),
            op: BinOp::Equals,
            right: Box::new(Expr::Param {
                name: "id".into(),
                type_: id.type_.type_.clone(),
            }),
        }).return_fields(&[&name, &points]).build_query("get_user", QueryResCount::One),

        new_select(&users).return_field(&id).build_query("list_users", QueryResCount::Many)
    ]).unwrap();
}

生成类似的内容

pub fn migrate(db: &mut rusqlite::Connection) -> Result<(), GoodError> {
    // ...
}

pub fn create_user(db: &mut rusqlite::Connection, name: &str, points: i64) -> Result<(), GoodError> {
    // ...
}

pub struct DbRes1 {
    pub name: String,
    pub points: i64,
}

pub fn get_user(db: &mut rusqlite::Connection, id: i64) -> Result<DbRes1, GoodError> {
    // ...
}

pub fn list_users(db: &mut rusqlite::Connection) -> Result<Vec<i64>, GoodError> {
    // ...
}

并可用于

fn main() {
    use sqlite_gen_hello_world as queries;

    let mut db = rusqlite::Connection::open_in_memory().unwrap();
    queries::migrate(&db).unwrap();
    queries::create_user(&db, "rust human", 0).unwrap();
    for user_id in queries::list_users(&db).unwrap() {
        let user = queries::get_user(&db, user_id).unwrap();
        println!("User {}: {}", user_id, user.name);
    }
    Ok(())
}

User 1: rust human

使用说明

功能

• pg - 启用为 PostgreSQL 生成代码
• sqlite - 启用为 Sqlite 生成代码
• chrono - 启用日期时间字段/表达式类型

架构 ID 和 ID

"架构 ID" 是用于匹配不同版本中字段的内部 ID，用于识别重命名、删除等。一旦在某个版本中使用，架构 ID 不应改变。建议使用通过键宏生成的随机 ID。更改架构 ID 将导致先删除后创建。

"ID" 适用于 SQL（字段）和 Rust（参数和返回的数据结构），因此必须在两者中都有效（尽管 Rust 中的 ID 如果与关键字冲突会自动进行一些修改）。根据数据库的不同，您可以在架构版本之间任意更改 ID，但连续版本之间的 ID 交换目前不支持 - 如果需要交换，请通过三个不同的版本进行（例如：v0： A 和 B，v1： A_ 和 B，v2： B 和 A）。

查询、表达式和字段类型

使用 type_* 和 field_* 函数来获取用于表达式/字段的类型构建器。

使用 new_insert/select/update/delete 创建查询构建器。

pub struct MyString(pub String);

impl good_ormning_runtime::pg::GoodOrmningCustomString<MyString> for MyString {
    fn to_sql(value: &MyString) -> &str {
        &value.0
    }

    fn from_sql(s: String) -> Result<MyString, String> {
        Ok(Self(s))
    }
}