#orm #scylla-db #queries #cassandra #macro #table #mapping

catalytic_macro

Scylla ORM宏,完全兼容Apache Cassandra™

23个版本

0.1.24 2023年12月29日
0.1.20 2023年10月26日
0.1.14 2023年7月9日
0.1.12 2023年1月31日
0.1.0 2022年1月20日

过程宏 中排名570

Download history 9/week @ 2024-03-09 45/week @ 2024-03-30 14/week @ 2024-04-06

每月下载量366

MIT授权

88KB
2K SLoC

Catalytic:ScyllaDB和Cassandra对象关系映射器

Latest Version Build Status

此库包含以下功能的一些crate
  • 自动将表映射到Rust structcatalytic_table_to_struct。请参阅用法。生成的代码可在生成目录中找到。
  • 编译时检查查询:catalytic_macro (catalytic_macro::query)。请参阅用法
  • 用于生成业务逻辑的插件派生宏:catalytic_macro (catalytic_macro::mirror)
  • 自动JSON映射。当存在类型为text的列时,你可以实现Transformer特质并将其映射到实现了serde::Serializeserde::Deserialize的类型
  • 所有查询都作为预处理语句执行
  • 支持物化视图(如果列相同,则支持与基本表的映射)

由于https://github.com/scylladb/scylla-rust-driver/issues/104,目前尚不支持所有类型

查询类型

根据查询,可以派生一定类型的查询。这些类型可以在这里找到。以下是常用查询类型

  • SelectMultiple:可以用作迭代器来遍历行
  • SelectUnique:通过完整主键选择一个可选的唯一行
  • SelectUniqueExpect:与SelectUnique相同,但行不存在时将失败
  • SelectUniqueExpect使用Count作为实体类型:具有特殊的select_count方法,用于查询如"select count(*) from ..."

还有用于CRUD操作的struct

用法

自动将表映射到Rust

您可以在example目录中看到如何生成Rust struct的示例。

  • 在build.rs文件中实现了并使用了Transformer特质进行JSON映射
  • 在生成的目录中您可以查看生成的struct

如何自己实现它(模拟example包的逐步指南)

  • 添加build依赖项:catalytic_table_to_struct = "0.1"
  • 创建一个build.rs文件
  • 可选实现Tranformer特质(或使用DefaultTransformer
  • 调用catalytic_table_to_struct::generate
  • 构建项目

以下是表'child'生成代码结构的示例

  • Child:一个包含自持值的struct。可以转换为ChildRef、PrimaryKey和PrimaryKeyRef
  • ChildRef:一个值都是借用值的struct。此struct可以进行插入操作。可以转换为Child、PrimaryKey和PrimaryKeyRef
  • PrimaryKey:一个包含Child主键字段自持值的struct。可以转换为PrimaryKeyRef。
  • PrimaryKeyRef:一个值都是借用值的struct。此struct可以进行更新、删除和选择操作。可以转换为PrimaryKey
  • UpdatableColumn:一个包含可以更新列的自持值枚举变体的enum。可以转换为UpdatableColumnRef。
  • UpdatableColumnRef:一个值都是借用值的enum。此用于PrimaryKeyRef的更新。可以转换为UpdatableColumn。

Crate catalytic_macro包含多个宏,可用于确保编译/类型检查查询。有关如何使用的示例,请参阅lib.rs中的方法qmd

如何自己实现它

  • 添加依赖项:catalytic_macro = "0.1"
  • query宏返回给定查询的正确查询类型
  • query_base_table宏将select查询转换为物化视图表,转换为基本表的select查询
  • mirrorprimary_key可用于其他derive宏

在生产中使用

https://www.beezleapp.com/ - Beezle Social允许用户连接附近的用户,发现当地活动

依赖关系

~13–25MB
~349K SLoC