kite_sql_serde_macros 0.1.2

Derive macros for KiteSQL
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
use darling::ast::Data;
use darling::{FromDeriveInput, FromField, FromMeta};
use proc_macro2::{Span, TokenStream};
use quote::{format_ident, quote};
use std::collections::BTreeSet;
use syn::{parse_quote, DeriveInput, Error, Generics, Ident, LitStr, Type};

#[derive(Debug, FromDeriveInput)]
#[darling(attributes(model), supports(struct_named))]
struct OrmOpts {
    ident: Ident,
    generics: Generics,
    table: Option<String>,
    #[darling(default, multiple, rename = "index")]
    indexes: Vec<OrmIndexOpts>,
    data: Data<(), OrmFieldOpts>,
}

#[derive(Debug, FromMeta)]
struct OrmIndexOpts {
    name: String,
    columns: String,
    #[darling(default)]
    unique: bool,
}

#[derive(Debug, FromField)]
#[darling(attributes(model))]
struct OrmFieldOpts {
    ident: Option<Ident>,
    ty: Type,
    rename: Option<String>,
    varchar: Option<u32>,
    #[darling(rename = "char")]
    char_len: Option<u32>,
    decimal_precision: Option<u8>,
    decimal_scale: Option<u8>,
    #[darling(rename = "default")]
    default_expr: Option<String>,
    #[darling(default)]
    skip: bool,
    #[darling(default)]
    primary_key: bool,
    #[darling(default)]
    unique: bool,
    #[darling(default)]
    index: bool,
}

pub(crate) fn handle(ast: DeriveInput) -> Result<TokenStream, Error> {
    let orm_opts = OrmOpts::from_derive_input(&ast)?;
    let struct_name = &orm_opts.ident;
    let table_name = orm_opts.table.ok_or_else(|| {
        Error::new_spanned(
            struct_name,
            "Model requires #[model(table = \"table_name\")] on the struct",
        )
    })?;
    let table_name_lit = LitStr::new(&table_name, Span::call_site());
    let mut generics = orm_opts.generics.clone();

    let Data::Struct(data_struct) = orm_opts.data else {
        return Err(Error::new_spanned(
            struct_name,
            "Model only supports structs with named fields",
        ));
    };

    let mut assignments = Vec::new();
    let mut params = Vec::new();
    let mut orm_fields = Vec::new();
    let mut orm_columns = Vec::new();
    let mut field_getters = Vec::new();
    let mut column_names = Vec::new();
    let mut placeholder_names = Vec::new();
    let mut create_index_statements = Vec::new();
    let mut create_index_if_not_exists_statements = Vec::new();
    let mut persisted_columns = Vec::new();
    let mut index_names = BTreeSet::new();
    index_names.insert("pk_index".to_string());
    let mut primary_key_type = None;
    let mut primary_key_value = None;
    let mut primary_key_column = None;
    let mut primary_key_placeholder = None;
    let mut primary_key_count = 0usize;

    for field in data_struct.fields {
        let field_name = field.ident.ok_or_else(|| {
            Error::new_spanned(struct_name, "Model only supports named struct fields")
        })?;
        let field_ty = field.ty;

        if field.skip {
            if field.primary_key {
                return Err(Error::new_spanned(
                    field_name,
                    "primary key field cannot be skipped",
                ));
            }
            if field.unique {
                return Err(Error::new_spanned(
                    field_name,
                    "unique field cannot be skipped",
                ));
            }
            if field.index {
                return Err(Error::new_spanned(
                    field_name,
                    "index field cannot be skipped",
                ));
            }
            if field.varchar.is_some() {
                return Err(Error::new_spanned(
                    field_name,
                    "varchar field cannot be skipped",
                ));
            }
            if field.char_len.is_some() {
                return Err(Error::new_spanned(
                    field_name,
                    "char field cannot be skipped",
                ));
            }
            if field.default_expr.is_some() {
                return Err(Error::new_spanned(
                    field_name,
                    "default field cannot be skipped",
                ));
            }
            if field.decimal_precision.is_some() || field.decimal_scale.is_some() {
                return Err(Error::new_spanned(
                    field_name,
                    "decimal field cannot be skipped",
                ));
            }
            continue;
        }

        let varchar_len = field.varchar;
        let char_len = field.char_len;
        let decimal_precision = field.decimal_precision;
        let decimal_scale = field.decimal_scale;
        if varchar_len.is_some() && char_len.is_some() {
            return Err(Error::new_spanned(
                field_name,
                "char and varchar cannot be used together",
            ));
        }
        if decimal_scale.is_some() && decimal_precision.is_none() {
            return Err(Error::new_spanned(
                field_name,
                "decimal_scale requires decimal_precision",
            ));
        }
        let default_expr = field
            .default_expr
            .map(|value| LitStr::new(&value, Span::call_site()));
        let field_name_string = field_name.to_string();
        let column_name = field.rename.unwrap_or_else(|| field_name_string.clone());
        let placeholder_name = format!(":{column_name}");
        let column_name_lit = LitStr::new(&column_name, Span::call_site());
        let placeholder_lit = LitStr::new(&placeholder_name, Span::call_site());
        let is_primary_key = field.primary_key;
        let is_unique = field.unique;
        let is_index = field.index;

        persisted_columns.push((field_name_string, column_name.clone()));
        column_names.push(column_name.clone());
        placeholder_names.push(placeholder_name.clone());

        if is_primary_key {
            primary_key_count += 1;
            primary_key_column = Some(column_name.clone());
            primary_key_placeholder = Some(placeholder_name.clone());
            primary_key_type = Some(quote! { #field_ty });
            primary_key_value = Some(quote! {
                &self.#field_name
            });
        } else {
        }

        generics
            .make_where_clause()
            .predicates
            .push(parse_quote!(#field_ty : ::kite_sql::orm::FromDataValue));
        generics
            .make_where_clause()
            .predicates
            .push(parse_quote!(#field_ty : ::kite_sql::orm::ToDataValue));
        generics
            .make_where_clause()
            .predicates
            .push(parse_quote!(#field_ty : ::kite_sql::orm::ModelColumnType));

        if varchar_len.is_some() || char_len.is_some() {
            generics
                .make_where_clause()
                .predicates
                .push(parse_quote!(#field_ty : ::kite_sql::orm::StringType));
        }
        if decimal_precision.is_some() || decimal_scale.is_some() {
            generics
                .make_where_clause()
                .predicates
                .push(parse_quote!(#field_ty : ::kite_sql::orm::DecimalType));
        }

        let ddl_type = if let Some(varchar_len) = varchar_len {
            quote! { ::std::format!("varchar({})", #varchar_len) }
        } else if let Some(char_len) = char_len {
            quote! { ::std::format!("char({})", #char_len) }
        } else if let Some(decimal_precision) = decimal_precision {
            if let Some(decimal_scale) = decimal_scale {
                quote! { ::std::format!("decimal({}, {})", #decimal_precision, #decimal_scale) }
            } else {
                quote! { ::std::format!("decimal({})", #decimal_precision) }
            }
        } else {
            quote! { <#field_ty as ::kite_sql::orm::ModelColumnType>::ddl_type() }
        };
        let default_expr_tokens = if let Some(default_expr) = &default_expr {
            quote! { Some(#default_expr) }
        } else {
            quote! { None }
        };

        assignments.push(quote! {
            if let Some(value) = ::kite_sql::orm::try_get::<#field_ty>(&mut tuple, schema, #column_name_lit) {
                struct_instance.#field_name = value;
            }
        });
        params.push(quote! {
            (#placeholder_lit, ::kite_sql::orm::ToDataValue::to_data_value(&self.#field_name))
        });
        orm_fields.push(quote! {
            ::kite_sql::orm::OrmField {
                column: #column_name_lit,
                placeholder: #placeholder_lit,
                primary_key: #is_primary_key,
                unique: #is_unique,
            }
        });
        let getter_name = format_ident!("{}", field_name);
        field_getters.push(quote! {
            pub fn #getter_name() -> ::kite_sql::orm::Field<Self, #field_ty> {
                ::kite_sql::orm::Field::new(#table_name_lit, #column_name_lit)
            }
        });
        orm_columns.push(quote! {
            ::kite_sql::orm::OrmColumn {
                name: #column_name_lit,
                ddl_type: #ddl_type,
                nullable: <#field_ty as ::kite_sql::orm::ModelColumnType>::nullable(),
                primary_key: #is_primary_key,
                unique: #is_unique,
                default_expr: #default_expr_tokens,
            }
        });
        if is_unique {
            let unique_index_name_value = format!("uk_{}_index", column_name);
            if !index_names.insert(unique_index_name_value.clone()) {
                return Err(Error::new_spanned(
                    struct_name,
                    format!("duplicate ORM index name: {}", unique_index_name_value),
                ));
            }
        }
        if is_index {
            let index_name = format!("{table_name}_{column_name}_index");
            let index_name_lit = LitStr::new(&index_name, Span::call_site());
            let column_name_for_index = column_name_lit.clone();
            if !index_names.insert(index_name.clone()) {
                return Err(Error::new_spanned(
                    struct_name,
                    format!("duplicate ORM index name: {}", index_name),
                ));
            }
            create_index_statements.push(quote! {
                ::kite_sql::orm::orm_create_index_statement(
                    #table_name_lit,
                    #index_name_lit,
                    &[#column_name_for_index],
                    false,
                    false,
                )
            });
            create_index_if_not_exists_statements.push(quote! {
                ::kite_sql::orm::orm_create_index_statement(
                    #table_name_lit,
                    #index_name_lit,
                    &[#column_name_for_index],
                    false,
                    true,
                )
            });
        }
    }

    for index in orm_opts.indexes {
        if !index_names.insert(index.name.clone()) {
            return Err(Error::new_spanned(
                struct_name,
                format!("duplicate ORM index name: {}", index.name),
            ));
        }

        let mut resolved_columns = Vec::new();
        let mut seen_columns = BTreeSet::new();
        for raw_column in index.columns.split(',') {
            let raw_column = raw_column.trim();
            if raw_column.is_empty() {
                continue;
            }

            let column_name = persisted_columns
                .iter()
                .find_map(|(field_name, column_name)| {
                    if field_name == raw_column || column_name == raw_column {
                        Some(column_name.clone())
                    } else {
                        None
                    }
                })
                .ok_or_else(|| {
                    Error::new_spanned(
                        struct_name,
                        format!(
                            "unknown ORM index column `{}`; use a persisted field name or column name",
                            raw_column
                        ),
                    )
                })?;

            if !seen_columns.insert(column_name.clone()) {
                return Err(Error::new_spanned(
                    struct_name,
                    format!(
                        "duplicate ORM index column `{}` in index `{}`",
                        column_name, index.name
                    ),
                ));
            }

            resolved_columns.push(column_name);
        }

        if resolved_columns.is_empty() {
            return Err(Error::new_spanned(
                struct_name,
                format!(
                    "ORM index `{}` must reference at least one column",
                    index.name
                ),
            ));
        }

        let index_name_lit = LitStr::new(&index.name, Span::call_site());
        let index_columns = resolved_columns
            .iter()
            .map(|column| LitStr::new(column, Span::call_site()))
            .collect::<Vec<_>>();
        let is_unique = index.unique;
        create_index_statements.push(quote! {
            ::kite_sql::orm::orm_create_index_statement(
                #table_name_lit,
                #index_name_lit,
                &[#(#index_columns),*],
                #is_unique,
                false,
            )
        });
        create_index_if_not_exists_statements.push(quote! {
            ::kite_sql::orm::orm_create_index_statement(
                #table_name_lit,
                #index_name_lit,
                &[#(#index_columns),*],
                #is_unique,
                true,
            )
        });
    }

    if primary_key_count != 1 {
        return Err(Error::new_spanned(
            struct_name,
            "Model requires exactly one #[model(primary_key)] field",
        ));
    }

    let primary_key_type = primary_key_type.expect("primary key checked above");
    let primary_key_value = primary_key_value.expect("primary key checked above");
    let _primary_key_column = primary_key_column.expect("primary key checked above");
    let _primary_key_placeholder = primary_key_placeholder.expect("primary key checked above");
    let (impl_generics, ty_generics, where_clause) = generics.split_for_impl();

    Ok(quote! {
        impl #impl_generics ::core::convert::From<(&::kite_sql::types::tuple::SchemaRef, ::kite_sql::types::tuple::Tuple)>
            for #struct_name #ty_generics
            #where_clause
        {
            fn from((schema, mut tuple): (&::kite_sql::types::tuple::SchemaRef, ::kite_sql::types::tuple::Tuple)) -> Self {
                let mut struct_instance = <Self as ::core::default::Default>::default();

                #(#assignments)*

                struct_instance
            }
        }

        impl #impl_generics #struct_name #ty_generics
            #where_clause
        {
            #(#field_getters)*
        }

        impl #impl_generics ::kite_sql::orm::Model for #struct_name #ty_generics
            #where_clause
        {
            type PrimaryKey = #primary_key_type;

            fn table_name() -> &'static str {
                #table_name_lit
            }

            fn fields() -> &'static [::kite_sql::orm::OrmField] {
                &[
                    #(#orm_fields),*
                ]
            }

            fn columns() -> &'static [::kite_sql::orm::OrmColumn] {
                static ORM_COLUMNS: ::std::sync::LazyLock<::std::vec::Vec<::kite_sql::orm::OrmColumn>> = ::std::sync::LazyLock::new(|| {
                    vec![
                        #(#orm_columns),*
                    ]
                });
                ORM_COLUMNS.as_slice()
            }

            fn params(&self) -> Vec<(&'static str, ::kite_sql::types::value::DataValue)> {
                vec![
                    #(#params),*
                ]
            }

            fn primary_key(&self) -> &Self::PrimaryKey {
                #primary_key_value
            }

            fn select_statement() -> &'static ::kite_sql::db::Statement {
                static SELECT_STATEMENT: ::std::sync::LazyLock<::kite_sql::db::Statement> = ::std::sync::LazyLock::new(|| {
                    ::kite_sql::orm::orm_select_statement(
                        #table_name_lit,
                        <#struct_name #ty_generics as ::kite_sql::orm::Model>::fields(),
                    )
                });
                &SELECT_STATEMENT
            }

            fn insert_statement() -> &'static ::kite_sql::db::Statement {
                static INSERT_STATEMENT: ::std::sync::LazyLock<::kite_sql::db::Statement> = ::std::sync::LazyLock::new(|| {
                    ::kite_sql::orm::orm_insert_statement(
                        #table_name_lit,
                        <#struct_name #ty_generics as ::kite_sql::orm::Model>::fields(),
                    )
                });
                &INSERT_STATEMENT
            }

            fn find_statement() -> &'static ::kite_sql::db::Statement {
                static FIND_STATEMENT: ::std::sync::LazyLock<::kite_sql::db::Statement> = ::std::sync::LazyLock::new(|| {
                    ::kite_sql::orm::orm_find_statement(
                        #table_name_lit,
                        <#struct_name #ty_generics as ::kite_sql::orm::Model>::fields(),
                        <#struct_name #ty_generics as ::kite_sql::orm::Model>::primary_key_field(),
                    )
                });
                &FIND_STATEMENT
            }

            fn create_table_statement() -> &'static ::kite_sql::db::Statement {
                static CREATE_TABLE_STATEMENT: ::std::sync::LazyLock<::kite_sql::db::Statement> = ::std::sync::LazyLock::new(|| {
                    ::kite_sql::orm::orm_create_table_statement(
                        #table_name_lit,
                        <#struct_name #ty_generics as ::kite_sql::orm::Model>::columns(),
                        false,
                    )
                        .expect("failed to build ORM create table statement")
                });
                &CREATE_TABLE_STATEMENT
            }

            fn create_table_if_not_exists_statement() -> &'static ::kite_sql::db::Statement {
                static CREATE_TABLE_IF_NOT_EXISTS_STATEMENT: ::std::sync::LazyLock<::kite_sql::db::Statement> = ::std::sync::LazyLock::new(|| {
                    ::kite_sql::orm::orm_create_table_statement(
                        #table_name_lit,
                        <#struct_name #ty_generics as ::kite_sql::orm::Model>::columns(),
                        true,
                    )
                        .expect("failed to build ORM create table if not exists statement")
                });
                &CREATE_TABLE_IF_NOT_EXISTS_STATEMENT
            }

            fn create_index_statements() -> &'static [::kite_sql::db::Statement] {
                static CREATE_INDEX_STATEMENTS: ::std::sync::LazyLock<::std::vec::Vec<::kite_sql::db::Statement>> = ::std::sync::LazyLock::new(|| {
                    vec![
                        #(#create_index_statements),*
                    ]
                });
                CREATE_INDEX_STATEMENTS.as_slice()
            }

            fn create_index_if_not_exists_statements() -> &'static [::kite_sql::db::Statement] {
                static CREATE_INDEX_IF_NOT_EXISTS_STATEMENTS: ::std::sync::LazyLock<::std::vec::Vec<::kite_sql::db::Statement>> = ::std::sync::LazyLock::new(|| {
                    vec![
                        #(#create_index_if_not_exists_statements),*
                    ]
                });
                CREATE_INDEX_IF_NOT_EXISTS_STATEMENTS.as_slice()
            }

            fn drop_table_statement() -> &'static ::kite_sql::db::Statement {
                static DROP_TABLE_STATEMENT: ::std::sync::LazyLock<::kite_sql::db::Statement> = ::std::sync::LazyLock::new(|| {
                    ::kite_sql::orm::orm_drop_table_statement(#table_name_lit, false)
                });
                &DROP_TABLE_STATEMENT
            }

            fn drop_table_if_exists_statement() -> &'static ::kite_sql::db::Statement {
                static DROP_TABLE_IF_EXISTS_STATEMENT: ::std::sync::LazyLock<::kite_sql::db::Statement> = ::std::sync::LazyLock::new(|| {
                    ::kite_sql::orm::orm_drop_table_statement(#table_name_lit, true)
                });
                &DROP_TABLE_IF_EXISTS_STATEMENT
            }

            fn analyze_statement() -> &'static ::kite_sql::db::Statement {
                static ANALYZE_STATEMENT: ::std::sync::LazyLock<::kite_sql::db::Statement> = ::std::sync::LazyLock::new(|| {
                    ::kite_sql::orm::orm_analyze_statement(#table_name_lit)
                });
                &ANALYZE_STATEMENT
            }
        }
    })
}