Skip to main content

sqltrail_macros/
lib.rs

1//! # sqltrail-macros
2//!
3//! `#[derive(DbSchema)]` 过程宏:解析 `#[db_table(...)]` 与 `#[db_column(...)]`
4//! 属性,把 Rust 结构体转换为 `sqltrail_core::TableModel` 的构造代码。
5//!
6//! 过程宏只解析代码并生成模型,不连接数据库,也不直接生成或执行迁移 SQL。
7//! 对不支持或有歧义的属性会给出编译错误(见 `attrs` 模块)。
8
9use proc_macro::TokenStream;
10use syn::parse_macro_input;
11
12mod attrs;
13mod codegen;
14
15/// 派生数据库结构模型。
16///
17/// ```rust
18/// use sqltrail_core::DBSchema;
19///
20/// #[derive(sqltrail_macros::DbSchema)]
21/// #[db_table(schema = "auth", name = "employees")]
22/// struct Employee {
23///     #[db_column(primary_key)]
24///     id: i64,
25///     #[db_column(sql_type = "varchar(64)", unique)]
26///     employee_no: String,
27///     #[db_column(default = "now()", comment = "创建时间")]
28///     created_at: String,
29///     avatar: Option<String>,
30/// }
31///
32/// let table = Employee::table();
33/// assert_eq!(table.schema, "auth");
34/// ```
35///
36/// 支持的属性详见 `attrs` 模块文档。
37#[proc_macro_derive(DbSchema, attributes(db_table, db_column))]
38pub fn derive_db_schema(input: TokenStream) -> TokenStream {
39    let input = parse_macro_input!(input as syn::DeriveInput);
40    match codegen::expand(input) {
41        Ok(tokens) => tokens.into(),
42        // 解析或生成失败时,把错误转换成编译错误输出
43        Err(e) => e.to_compile_error().into(),
44    }
45}