一个安全的、可扩展的 Rust ORM 和查询构建器

API 文档： 最新版本 – 主分支

主页

Diesel 去掉了数据库交互的样板代码，消除了运行时错误，同时不牺牲性能。它充分利用 Rust 的类型系统，创建了一个低开销的查询构建器，感觉就像 Rust。

支持数据库

1. PostgreSQL
2. MySQL
3. SQLite

您可以在 Cargo.toml 中配置数据库后端。

[dependencies]
diesel = { version = "<version>", features = ["<postgres|mysql|sqlite>"] }

入门指南

在我们的入门指南中找到详细的入门教程，请访问 https://diesel.rs/guides/getting-started。有关更具体功能的指南即将推出。

获取帮助

如果您遇到问题，Diesel 有一个非常活跃的 Gitter 房间。您可以在 gitter.im/diesel-rs/diesel 上寻求帮助。对于更长时间的问题和关于 Diesel 未来的讨论，请打开 GitHub 讨论区。

使用方法

简单查询

简单查询非常简单。从数据库中加载所有用户

users::table.load(&mut connection)

执行的 SQL

SELECT * FROM users;

加载用户的全部帖子

Post::belonging_to(user).load(&mut connection)

执行的 SQL

SELECT * FROM posts WHERE user_id = 1;

复杂查询

Diesel 强大的查询构建器可以帮助您构建您需要的简单或复杂查询，成本为零。

let versions = Version::belonging_to(krate)
  .select(id)
  .order(num.desc())
  .limit(5);
let downloads = version_downloads
  .filter(date.gt(now - 90.days()))
  .filter(version_id.eq_any(versions))
  .order(date)
  .load::<Download>(&mut conn)?;

执行的 SQL

SELECT version_downloads.*
  WHERE date > (NOW() - '90 days')
    AND version_id = ANY(
      SELECT id FROM versions
        WHERE crate_id = 1
        ORDER BY num DESC
        LIMIT 5
    )
  ORDER BY date

更少的样板代码

Diesel 代码生成器为您生成样板代码。它让您专注于业务逻辑，而不是映射 SQL 行。

这意味着您可以编写这个

#[derive(Queryable, Selectable)]
#[diesel(table_name = downloads)]
pub struct Download {
    id: i32,
    version_id: i32,
    downloads: i32,
    counted: i32,
    date: SystemTime,
}

而不是这个（没有 Diesel）

pub struct Download {
    id: i32,
    version_id: i32,
    downloads: i32,
    counted: i32,
    date: SystemTime,
}

impl Download {
    fn from_row(row: &Row) -> Download {
        Download {
            id: row.get("id"),
            version_id: row.get("version_id"),
            downloads: row.get("downloads"),
            counted: row.get("counted"),
            date: row.get("date"),
        }
    }
}

插入数据

不仅仅是读取数据。Diesel 使使用结构体创建新记录变得容易。

#[derive(Insertable)]
#[diesel(table_name = users)]
struct NewUser<'a> {
    name: &'a str,
    hair_color: Option<&'a str>,
}

let new_users = vec![
    NewUser { name: "Sean", hair_color: Some("Black") },
    NewUser { name: "Gordon", hair_color: None },
];

insert_into(users)
    .values(&new_users)
    .execute(&mut connection);

执行的 SQL

INSERT INTO users (name, hair_color) VALUES
  ('Sean', 'Black'),
  ('Gordon', DEFAULT)

如果您需要插入的行的数据，只需将 execute 更改为 get_result 或 get_results。Diesel 将处理其余部分。

let new_users = vec![
    NewUser { name: "Sean", hair_color: Some("Black") },
    NewUser { name: "Gordon", hair_color: None },
];

let inserted_users = insert_into(users)
    .values(&new_users)
    .get_results::<User>(&mut connection);

执行的 SQL

INSERT INTO users (name, hair_color) VALUES
  ('Sean', 'Black'),
  ('Gordon', DEFAULT)
  RETURNING *

更新数据

柴油的代码生成器可以生成多种更新行的方法，让您以对您的应用程序有意义的方式封装您的逻辑。

修改结构体

post.published = true;
post.save_changes(&mut connection);

一次性批量更改

update(users.filter(email.like("%@spammer.com")))
    .set(banned.eq(true))
    .execute(&mut connection)

使用结构体进行封装

update(Settings::belonging_to(current_user))
    .set(&settings_form)
    .execute(&mut connection)

原始SQL

总会有一些查询写成原始SQL更简单，或者无法用查询构建器表达。即使在这些情况下，Diesel也提供了一个易于使用的API来编写原始SQL。

#[derive(QueryableByName)]
#[diesel(table_name = users)]
struct User {
    id: i32,
    name: String,
    organization_id: i32,
}

// Using `include_str!` allows us to keep the SQL in a
// separate file, where our editor can give us SQL specific
// syntax highlighting.
sql_query(include_str!("complex_users_by_organization.sql"))
    .bind::<Integer, _>(organization_id)
    .bind::<BigInt, _>(offset)
    .bind::<BigInt, _>(limit)
    .load::<User>(&mut conn)?;

行为准则

任何与Diesel在任何空间互动的人，包括但不限于这个GitHub仓库，都必须遵守我们的行为准则。

许可

根据以下之一许可

• Apache许可证第2版（LICENSE-APACHE或https://www.apache.org/licenses/LICENSE-2.0）
• MIT许可证（LICENSE-MIT或https://opensource.org/licenses/MIT）

贡献

在贡献之前，请阅读贡献指南，了解有关在本地设置Diesel、编码风格和常见缩写的有用信息。

除非您明确表示，否则您有意提交给作品作为贡献的内容，根据Apache-2.0许可证的定义，应如上所述双重许可，没有任何额外的条款或条件。