#scylla #cassandra #cql #table-column

scylla_orm_macro

Scylla ORM宏,与Apache Cassandra™完全兼容

1个不稳定版本

0.1.0 2021年11月11日

#16 in #table-column

MIT 协议

84KB
2K SLoC

ScyllaDb/Cassandra 对象关系映射器

Latest Version Build Status

特性

此库包含以下特性的几个crate

  • 自动将表映射到Rust structscylla_orm_table_to_struct。请参阅用法。请参阅生成的代码目录此处
  • 编译时检查查询: scylla_orm_macro (scylla_orm_macro::query)。请参阅用法
  • 用于生成业务逻辑的插件派生宏: scylla_orm_macro (scylla_orm_macro::mirror)
  • 自动JSON映射。当存在类型为text的列时,您可以实现Transformer特质并将其映射到实现serde::Serializeserde::Deserialize的类型
  • 所有查询都以预编译语句的形式执行
  • 支持物化视图(如果列相同,则支持与基础表的映射)

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

查询类型

根据查询,可以派生特定查询类型。这些可以在此处找到。以下是常用查询类型

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

还有用于CRUD操作的struct

用法

自动将表映射到Rust

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

  • 在build.rs文件中实现了Transformer特质,并用于JSON映射
  • 在生成的目录中可以看到生成的struct

如何自行实现(模仿 example 链表的步骤指南)

  • 添加构建依赖:scylla_orm_table_to_struct = "0.1"
  • 创建一个 build.rs 文件
  • 可选实现 Tranformer 特性(或使用 DefaultTransformer
  • 调用 scylla_orm_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。

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

如何自行实现

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

依赖

~19–33MB
~344K SLoC