cql

CQL：编译查询语言

什么是cql？

CQL 最初是 BaDaaS 的一部分，它允许轻松安全地持久化和查询对象。

它构建在 gorm 之上，gorm 是一个实际上提供 ORM 功能的库：将对象映射到 SQL 数据库中的表。虽然 gorm 通过自动迁移很好地完成了这项工作，但对这些对象执行查询有些限制，迫使我们在复杂时直接编写 SQL 查询。 CQL 试图通过一个查询系统来解决这些限制：

• 编译时安全：查询在编译时进行验证，以避免错误，例如比较不同类型的属性、尝试使用属性或导航不存在的关系、使用查询中未包含的表中的信息等.;确保不会引发运行时错误。
• 易于使用：使用其查询系统不需要数据库、SQL 语言或复杂概念的知识。编写查询只需要用 Go 编程，结果很容易阅读。
• 专为实际应用程序而设计：查询系统旨在在查询复杂、需要导航多个关系、执行多次比较等的实际情况下正常工作。
• 其设计使开发人员可以专注于业务模型：它的查询允许轻松检索模型关系以将业务逻辑应用于模型，并且它提供了避免由于从数据库加载信息时出现错误而导致业务逻辑错误的机制。
• 它是为高性能而设计的：查询系统尽可能避免使用反射，并旨在通过对数据库的单个查询来检索所有必要的模型数据。

语言	询问
SQL	选择城市。* FROM 城市 INNER JOIN 国家 ON 国家/地区.id = 城市.国家/地区 ID AND 国家.名称=“法国” WHERE 城市.name = "巴黎"
戈尔姆	db.Where( "城市.名称 = ?", “巴黎”， ). 加入( “国家”， db.Where( "国家.名称 = ?", “法国”， ), ).查找(&城市)
CQL	cql.Query[模型.城市]( 分贝， conditions.City.Name.Is().Eq("巴黎"), 条件.城市.国家( conditions.Country.Name.Is().Eq("法国"), ), ).FindOne()

cql 是 gorm-gen 的副本吗？

确实，其目标似乎是相同的：

100% 类型安全的 DAO API，无接口{}

尽管 gorm-gen 提供了比 gorm 更结构化的 API 来执行查询，但提供了以下方法：

 Where ( conds ... gen . Condition ) IUserDo

从这个签名中我们可以看出，例如，Where 方法接收 gen.Condition 类型的参数。通过这种方式，来自不同模型的条件可以混合而不会产生编译错误：

 u := query . User
c := query . Company
user , err := u . Where ( c . Name . Eq ( "franco" )). First ()

这会在执行生成的 SQL 期间生成运行时错误：

 SELECT * FROM `users` WHERE `companies`.`name` = "franco"
no such column: companies.name

因此，cql 决定在类型安全方面更进一步，检查条件是否属于正确的模型、比较的值是否属于同一类型、模型是否包含在查询中等等，以确保不会出现运行时错误不被提高。

文档

https://compiledquerylenguage.readthedocs.io/en/latest/

贡献

请参阅本节以查看 cql 贡献指南。

执照

CQL 根据 Mozilla 公共许可证版本 2.0 获得许可。