CANYON-SQL

一个全用 Rust 编写的多数据库 ORM。

Canyon-SQL 是用于同时操作多个数据库的高级抽象层。它基于 async 语言特性，提供高速、高性能的库来处理数据访问。

早期阶段声明

该库仍处于 早期阶段。任何通过 fork + PR 的贡献都将非常感激。目前，我们正在进行项目的非常活跃的开发。

完整文档资源

有一个 work-in-progress 网页，使用 mdBook 构建，包含官方文档。这里您可以找到 Canyon-SQL 的所有技术文档。您可以点击此链接 阅读

最重要的功能

• 异步 默认。几乎所有提供的功能都准备好用于并发消费。
• 使用多个数据源。您可以在同一时间查询多个数据库，甚至不同的数据库！这意味着您将能够在同一个项目中同时查询 PostgreSQL 数据库和 SqlServer 数据库。
• 基于宏。通过一些注解和配置文件，您就可以开始编写数据访问代码。
• 支持 迁移。 Canyon-SQL 随带一个 god-mode，它将为您管理数据库中的每个表。您可以在 Canyon 代码中内部修改表，更改列，设置约束……未来，我们计划允许您以编程方式操作整个服务器，例如创建数据库，更改配置……所有这些都可以通过 Canyon 实现！

支持数据库

Canyon-SQL 目前支持以下数据库

• PostgreSQL（通过tokio-postgres crate）
• SqlServer（通过tiberius crate）

上述列出的每个crate都是一个基于async的crate，符合Canyon-SQL设计指南。

计划增加更多数据库引擎。

示例说明

让我们来看看Canyon代码的样子！

经典的SELECT * FROM {table_name}

let find_all_result: Result<Vec<League>, Box<dyn Error + Send + Sync>> =  League::find_all().await;

// Connection doesn't return an error
assert!(find_all_result.is_ok());
// We retrieved elements from the League table
assert!(!find_all_result.unwrap().is_empty());

在主键列上执行搜索

let find_by_pk_result: Result<Option<League>, Box<dyn Error + Send + Sync>> = League::find_by_pk(&1).await;

assert!(find_by_pk_result.as_ref().unwrap().is_some());

let some_league = find_by_pk_result.unwrap().unwrap();
assert_eq!(some_league.id, 1);
assert_eq!(some_league.ext_id, 100695891328981122_i64);
assert_eq!(some_league.slug, "european-masters");
assert_eq!(some_league.name, "European Masters");
assert_eq!(some_league.region, "EUROPE");
assert_eq!(
    some_league.image_url,
    "http://static.lolesports.com/leagues/EM_Bug_Outline1.png"
);

注意find_by_pk(...)参数的起始引用。这个关联函数接收一个&dyn QueryParameter<'_>作为参数，而不是一个值。

构建更复杂的查询

为了展示Canyon的功能，我们将使用SelectQueryBuilder<T>，它实现了QueryBuilder<T> trait，用于构建更复杂的where子句、过滤数据和连接表。

let mut select_with_joins = LeagueTournament::select_query();
    select_with_joins
        .inner_join("tournament", "league.id", "tournament.league_id")
        .left_join("team", "tournament.id", "player.tournament_id")
        .r#where(LeagueFieldValue::id(&7), Comp::Gt)
        .and(LeagueFieldValue::name(&"KOREA"), Comp::Eq)
        .and_values_in(LeagueField::name, &["LCK", "STRANGER THINGS"]);
    // NOTE: We don't have in the docker the generated relationships
    // with the joins, so for now, we are just going to check that the
    // generated SQL by the SelectQueryBuilder<T> is the spected
    assert_eq!(
        select_with_joins.read_sql(),
        "SELECT * FROM league INNER JOIN tournament ON league.id = tournament.league_id LEFT JOIN team ON tournament.id = player.tournament_id WHERE id > $1 AND name = $2  AND name IN ($2, $3) "
    )

注意：目前，当您使用连接时，您需要创建一个新模型，其中包含两个表中的列（如果您希望在这些列中获取数据），但只需按照CanyonMapper的常规流程进行。它将尝试检索每个声明的字段的数据。如果您没有声明在开放子句中（在这种情况下 (*)）的字段，则该字段将不会被检索。没问题。但是，如果您有无法与数据库中某些列映射的字段，程序将崩溃。

更多示例

如果您想看更多示例，可以查看此存储库根目录下的tests文件夹。每个可用的数据库操作都进行了测试，因此您可以使用它来查找上述文档中描述的操作的用法。

为CANYON-SQL做出贡献

首先，感谢您考虑帮助我们进行项目。您可以查看我们的模板指南。

但是，总结一下：

• 查看已打开的问题，看看是否已经存在或者有人正在处理它。即使如此，您也可以进入并阐述您的观点，甚至帮助完成任务。
• 创建Canyon-SQL的分支
• 如果您创建了问题，从存储库的基本分支（这是默认分支）创建一个分支，并将其指向您的分支
• 完成更改后，向默认分支提交一个PR。尽可能填写提供的模板
• 等待批准。在大多数情况下，在批准您的更改之前，将需要对该功能进行测试

测试怎么办？

通常在Canyon中，隔离单元测试以doc-tests的形式编写，集成测试位于./tests文件夹中。

如果您想运行测试（因为这是您在分支存储库后想做的第一件事），在运行测试之前需要考虑一些事情。

• 您需要在目标机器上安装Docker
• 如果您已安装 Docker 并克隆或分叉了 Canyon-SQL，则可以运行我们的 docker-compose 文件 (docker/docker-compose.yml)，这将初始化一个 PostgreSQL 数据库并在其上放置内容，以便测试能够运行。
• 最后，我们对 MSSQL 进行了一些测试。我们没有找到在 Docker 启动时直接插入数据的好方法，而是运行了一个非常特殊的测试，位于 tests/crud/mod.rs，其名称为 initialize_sql_server_docker_instance。当您运行此测试时，初始数据将被插入到测试运行时创建的表中。（如果您知道更好的方法，请打开 issue 告诉我们，并改进此过程！）