easy-sql 0.101.1

Macro-first SQL toolkit with compile-time checked queries, optional migrations on top of sqlx.
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
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
use super::Database;
use super::TestDriver;
use crate::{Output, Table};
use anyhow::Context;
use easy_macros::always_context;
use easy_sql_macros::query;

#[derive(Table)]
#[sql(no_version)]
struct CustomSelectTable {
    #[sql(primary_key)]
    #[sql(auto_increment)]
    id: i32,
    first_name: String,
    last_name: String,
    age: i64,
}

#[derive(crate::Insert)]
#[sql(table = CustomSelectTable)]
#[sql(default = id)]
struct CustomSelectInsert {
    first_name: String,
    last_name: String,
    age: i64,
}
#[cfg(not(feature = "use_output_columns"))]
#[derive(Output)]
#[sql(table = CustomSelectTable)]
#[allow(unused)]
struct CustomSelect1 {
    id: i32,
    first_name: String,
    last_name: String,
    #[sql(select = age * 2)]
    agee: i64,
    #[sql(select = CustomSelectTable.age * 4)]
    ageee: i64,
}
#[cfg(feature = "use_output_columns")]
#[derive(Output)]
#[sql(table = CustomSelectTable)]
#[allow(unused)]
struct CustomSelect1 {
    id: i32,
    first_name: String,
    last_name: String,
    #[sql(select = age * 2)]
    agee: i64,
    #[sql(select = CustomSelectTable.age * 4)]
    ageee: i64,
}

// Test custom select with one arg
#[derive(Output)]
#[sql(table = CustomSelectTable)]
#[allow(unused)]
struct CustomSelect2 {
    id: i32,
    first_name: String,
    #[sql(select = last_name || {arg0})]
    last_name: String, // Reuse last_name field but with custom select expression
    age: i64,
}

// Test custom select with arg used as parameter (age multiplied by arg0)
#[derive(Output)]
#[sql(table = CustomSelectTable)]
#[allow(unused)]
struct CustomSelect3 {
    id: i32,
    #[sql(select = age * {arg0})]
    age_times: i64,
}

// Test custom select with multiple args (string concat + arithmetic)
#[derive(Output)]
#[sql(table = CustomSelectTable)]
#[allow(unused)]
struct CustomSelect4 {
    id: i32,
    #[sql(select = first_name || {arg0} || last_name)]
    full_name: String,
    #[sql(select = age + {arg1})]
    age_plus: i64,
}

// Test custom select with complex SQL expressions in args
#[derive(Output)]
#[sql(table = CustomSelectTable)]
#[allow(unused)]
struct CustomSelect5 {
    id: i32,
    #[sql(select = age + {arg0})]
    adjusted_age: i64,
    #[sql(select = first_name || {arg1})]
    labeled_name: String,
}

#[always_context(skip(!))]
#[tokio::test]
async fn test_custom_select_basic() -> anyhow::Result<()> {
    let db = Database::setup_for_testing::<CustomSelectTable>().await?;
    let mut conn = db.transaction().await?;

    // Insert test data
    query!(&mut conn, INSERT INTO CustomSelectTable VALUES {
        CustomSelectInsert {
            first_name: "John".to_string(),
            last_name: "Doe".to_string(),
            age: 30
        }
    })
    .await?;

    // Query with custom select - should get age * 2
    let result: CustomSelect1 = query!(&mut conn,
        SELECT CustomSelect1 FROM CustomSelectTable WHERE id = 1
    )
    .await?;

    // Verify the custom select expression (age * 2)
    assert_eq!(result.id, 1);
    assert_eq!(result.first_name, "John");
    assert_eq!(result.last_name, "Doe");
    assert_eq!(result.agee, 60, "Expected age * 2 = 30 * 2 = 60");
    assert_eq!(result.ageee, 120, "Expected age * 2 * 2 = 30 * 2 * 2 = 120");

    conn.rollback().await?;
    Ok(())
}

#[always_context(skip(!))]
#[tokio::test]
async fn test_query_select_with_output_args_string_concat() -> anyhow::Result<()> {
    let db = Database::setup_for_testing::<CustomSelectTable>().await?;
    let mut conn = db.transaction().await?;

    query!(&mut conn, INSERT INTO CustomSelectTable VALUES {
        CustomSelectInsert {
            first_name: "Jane".to_string(),
            last_name: "Smith".to_string(),
            age: 25,
        }
    })
    .await?;

    let result: CustomSelect2 = query!(&mut conn,
        SELECT CustomSelect2(" Jr.") FROM CustomSelectTable WHERE id = 1
    )
    .await?;

    assert_eq!(result.first_name, "Jane");
    assert_eq!(result.last_name, "Smith Jr.");

    conn.rollback().await?;
    Ok(())
}

#[always_context(skip(!))]
#[tokio::test]
async fn test_query_select_with_output_args_numeric() -> anyhow::Result<()> {
    let db = Database::setup_for_testing::<CustomSelectTable>().await?;
    let mut conn = db.transaction().await?;

    query!(&mut conn, INSERT INTO CustomSelectTable VALUES {
        CustomSelectInsert {
            first_name: "Leo".to_string(),
            last_name: "Ng".to_string(),
            age: 12,
        }
    })
    .await?;

    let result: CustomSelect3 = query!(&mut conn,
        SELECT CustomSelect3(3) FROM CustomSelectTable WHERE id = 1
    )
    .await?;

    assert_eq!(
        result.age_times, 36,
        "Expected age * multiplier = 12 * 3 = 36"
    );

    conn.rollback().await?;
    Ok(())
}

#[always_context(skip(!))]
#[tokio::test]
async fn test_query_select_with_output_args_multiple() -> anyhow::Result<()> {
    let db = Database::setup_for_testing::<CustomSelectTable>().await?;
    let mut conn = db.transaction().await?;

    query!(&mut conn, INSERT INTO CustomSelectTable VALUES {
        CustomSelectInsert {
            first_name: "Ada".to_string(),
            last_name: "Lovelace".to_string(),
            age: 36,
        }
    })
    .await?;

    let result: CustomSelect4 = query!(&mut conn,
        SELECT CustomSelect4(" ", 4) FROM CustomSelectTable WHERE id = 1
    )
    .await?;

    assert_eq!(result.full_name, "Ada Lovelace");
    assert_eq!(result.age_plus, 40);

    conn.rollback().await?;
    Ok(())
}

#[always_context(skip(!))]
#[tokio::test]
async fn test_query_select_with_output_args_complex_expressions() -> anyhow::Result<()> {
    let db = Database::setup_for_testing::<CustomSelectTable>().await?;
    let mut conn = db.transaction().await?;

    query!(&mut conn, INSERT INTO CustomSelectTable VALUES {
        CustomSelectInsert {
            first_name: "Grace".to_string(),
            last_name: "Hopper".to_string(),
            age: 85,
        }
    })
    .await?;

    let result: CustomSelect5 = query!(&mut conn,
        SELECT CustomSelect5(5 + 3 * 2, " #" || CustomSelectTable.last_name) FROM CustomSelectTable WHERE id = 1
    )
    .await?;

    assert_eq!(
        result.adjusted_age, 96,
        "Expected age + (5 + 3 * 2) = 85 + 11 = 96"
    );
    assert_eq!(result.labeled_name, "Grace #Hopper");

    conn.rollback().await?;
    Ok(())
}

#[always_context(skip(!))]
#[tokio::test]
async fn test_query_select_with_output_args_external_vars() -> anyhow::Result<()> {
    let db = Database::setup_for_testing::<CustomSelectTable>().await?;
    let mut conn = db.transaction().await?;

    query!(&mut conn, INSERT INTO CustomSelectTable VALUES {
        CustomSelectInsert {
            first_name: "Nikola".to_string(),
            last_name: "Tesla".to_string(),
            age: 50,
        }
    })
    .await?;

    let separator = " ";
    let age_offset = 7;
    let result: CustomSelect4 = query!(&mut conn,
        SELECT CustomSelect4({separator}, {age_offset}) FROM CustomSelectTable WHERE id = 1
    )
    .await?;

    assert_eq!(result.full_name, "Nikola Tesla");
    assert_eq!(result.age_plus, 57);

    conn.rollback().await?;
    Ok(())
}

#[always_context(skip(!))]
#[tokio::test]
async fn test_query_select_output_args_with_clause_vars() -> anyhow::Result<()> {
    let db = Database::setup_for_testing::<CustomSelectTable>().await?;
    let mut conn = db.transaction().await?;

    for (first_name, last_name, age) in [
        ("Ada", "Lovelace", 36),
        ("Grace", "Hopper", 85),
        ("Katherine", "Johnson", 101),
    ] {
        query!(&mut conn, INSERT INTO CustomSelectTable VALUES {
            CustomSelectInsert {
                first_name: first_name.to_string(),
                last_name: last_name.to_string(),
                age,
            }
        })
        .await?;
    }

    let separator = " ";
    let age_offset = 5;
    let min_age = 40;
    let excluded_name = "Ada";
    let min_count = 1;
    let limit_val = 1;

    let results: Vec<CustomSelect4> = query!(&mut conn,
        SELECT Vec<CustomSelect4>({separator}, {age_offset})
        FROM CustomSelectTable
        WHERE CustomSelectTable.age >= {min_age} AND CustomSelectTable.first_name != {excluded_name}
        GROUP BY id
        HAVING COUNT(*) >= {min_count}
        ORDER BY id DESC
        LIMIT {limit_val}
    )
    .await?;

    assert_eq!(results.len(), 1);
    assert_eq!(results[0].full_name, "Katherine Johnson");
    assert_eq!(results[0].age_plus, 106);

    conn.rollback().await?;
    Ok(())
}

#[always_context(skip(!))]
#[tokio::test]
async fn test_query_insert_returning_with_output_args() -> anyhow::Result<()> {
    let db = Database::setup_for_testing::<CustomSelectTable>().await?;
    let mut conn = db.transaction().await?;

    let inserted: CustomSelect4 = query!(&mut conn, INSERT INTO CustomSelectTable VALUES {
        CustomSelectInsert {
            first_name: "Alan".to_string(),
            last_name: "Turing".to_string(),
            age: 41,
        }
    } RETURNING CustomSelect4(" ", 2))
    .await?;

    assert_eq!(inserted.full_name, "Alan Turing");
    assert_eq!(inserted.age_plus, 43);

    conn.rollback().await?;
    Ok(())
}

#[always_context(skip(!))]
#[tokio::test]
async fn test_query_update_returning_with_output_args() -> anyhow::Result<()> {
    let db = Database::setup_for_testing::<CustomSelectTable>().await?;
    let mut conn = db.transaction().await?;

    query!(&mut conn, INSERT INTO CustomSelectTable VALUES {
        CustomSelectInsert {
            first_name: "Grace".to_string(),
            last_name: "Hopper".to_string(),
            age: 85,
        }
    })
    .await?;

    let returned: CustomSelect5 = query!(&mut conn,
        UPDATE CustomSelectTable SET age = 90 WHERE id = 1
        RETURNING CustomSelect5(5 + 3 * 2, " #" || CustomSelectTable.last_name)
    )
    .await?;

    assert_eq!(
        returned.adjusted_age, 101,
        "Expected age + 11 = 90 + 11 = 101"
    );
    assert_eq!(returned.labeled_name, "Grace #Hopper");

    conn.rollback().await?;
    Ok(())
}

#[always_context(skip(!))]
#[tokio::test]
async fn test_query_delete_returning_with_output_args() -> anyhow::Result<()> {
    let db = Database::setup_for_testing::<CustomSelectTable>().await?;
    let mut conn = db.transaction().await?;

    query!(&mut conn, INSERT INTO CustomSelectTable VALUES {
        CustomSelectInsert {
            first_name: "Katherine".to_string(),
            last_name: "Johnson".to_string(),
            age: 101,
        }
    })
    .await?;

    let deleted: CustomSelect2 = query!(&mut conn,
        DELETE FROM CustomSelectTable WHERE id = 1
        RETURNING CustomSelect2(" Sr.")
    )
    .await?;

    assert_eq!(deleted.first_name, "Katherine");
    assert_eq!(deleted.last_name, "Johnson Sr.");

    conn.rollback().await?;
    Ok(())
}

#[always_context(skip(!))]
#[tokio::test]
async fn test_query_returning_with_output_args_external_vars() -> anyhow::Result<()> {
    let db = Database::setup_for_testing::<CustomSelectTable>().await?;
    let mut conn = db.transaction().await?;

    query!(&mut conn, INSERT INTO CustomSelectTable VALUES {
        CustomSelectInsert {
            first_name: "Ada".to_string(),
            last_name: "Lovelace".to_string(),
            age: 36,
        }
    })
    .await?;

    let bump = 9;
    let prefix = " #";
    let returned: CustomSelect5 = query!(&mut conn,
        UPDATE CustomSelectTable SET age = 40 WHERE id = 1
        RETURNING CustomSelect5({bump} + 1, {prefix} || CustomSelectTable.last_name)
    )
    .await?;

    assert_eq!(
        returned.adjusted_age, 50,
        "Expected age + (bump + 1) = 40 + 10 = 50"
    );
    assert_eq!(returned.labeled_name, "Ada #Lovelace");

    conn.rollback().await?;
    Ok(())
}

#[always_context(skip(!))]
#[tokio::test]
async fn test_query_update_output_args_with_clause_vars() -> anyhow::Result<()> {
    let db = Database::setup_for_testing::<CustomSelectTable>().await?;
    let mut conn = db.transaction().await?;

    query!(&mut conn, INSERT INTO CustomSelectTable VALUES {
        CustomSelectInsert {
            first_name: "Margaret".to_string(),
            last_name: "Hamilton".to_string(),
            age: 35,
        }
    })
    .await?;

    let separator = " ";
    let age_offset = 4;
    let target_id = 1;
    let target_name = "Margaret";
    let new_age = 40;

    let returned: CustomSelect4 = query!(&mut conn,
        UPDATE CustomSelectTable SET age = {new_age}
        WHERE id = {target_id} AND first_name = {target_name}
        RETURNING CustomSelect4({separator}, {age_offset})
    )
    .await?;

    assert_eq!(returned.full_name, "Margaret Hamilton");
    assert_eq!(returned.age_plus, 44);

    conn.rollback().await?;
    Ok(())
}

#[always_context(skip(!))]
#[tokio::test]
async fn test_query_delete_output_args_with_clause_vars() -> anyhow::Result<()> {
    let db = Database::setup_for_testing::<CustomSelectTable>().await?;
    let mut conn = db.transaction().await?;

    query!(&mut conn, INSERT INTO CustomSelectTable VALUES {
        CustomSelectInsert {
            first_name: "Dorothy".to_string(),
            last_name: "Vaughan".to_string(),
            age: 50,
        }
    })
    .await?;

    let separator = " ";
    let age_offset = 6;
    let min_age = 45;
    let target_name = "Dorothy";

    let deleted: CustomSelect4 = query!(&mut conn,
        DELETE FROM CustomSelectTable
        WHERE age >= {min_age} AND first_name = {target_name}
        RETURNING CustomSelect4({separator}, {age_offset})
    )
    .await?;

    assert_eq!(deleted.full_name, "Dorothy Vaughan");
    assert_eq!(deleted.age_plus, 56);

    conn.rollback().await?;
    Ok(())
}

#[test]
fn test_custom_select_method_generation() {
    // Test that __easy_sql_select is generated correctly
    let delimiter = "\"";
    let select_str = CustomSelect2::__easy_sql_select::<TestDriver>(delimiter, " Suffix");
    println!("Generated SELECT: {}", select_str);

    // Verify exact SELECT string (with alias prefix to avoid conflicts)
    let expected = "\"id\", \"first_name\", \"age\", \"last_name\" ||  Suffix AS \"__easy_sql_custom_select_last_name\"";
    assert_eq!(
        select_str, expected,
        "Generated SELECT string doesn't match expected.\nExpected: {}\nActual:   {}",
        expected, select_str
    );
}

#[test]
fn test_custom_select_format_string_uses_named_args() {
    // Verify that the generated format! call uses {arg0} syntax, not {0}
    // This is a compile-time check - if the macro generates {0} instead of {arg0},
    // this will fail to compile because format! won't be able to match the argument names

    let result = CustomSelect2::__easy_sql_select::<TestDriver>("\"", "TestValue");

    // The fact that this compiles and runs proves that the macro
    // generates format! with {arg0} syntax like: format!("... || {arg0} ...", arg0=arg0)
    assert!(result.contains("TestValue"));
}

#[test]
fn test_custom_select_multiple_args() {
    // Test with multiple different delimiter and argument combinations
    let test_cases = vec![
        (
            "\"",
            " Smith",
            "\"id\", \"first_name\", \"age\", \"last_name\" ||  Smith AS \"__easy_sql_custom_select_last_name\"",
        ),
        (
            "'",
            "-Suffix",
            "'id', 'first_name', 'age', 'last_name' || -Suffix AS '__easy_sql_custom_select_last_name'",
        ),
        (
            "`",
            " Jr.",
            "`id`, `first_name`, `age`, `last_name` ||  Jr. AS `__easy_sql_custom_select_last_name`",
        ),
    ];

    for (delimiter, arg, expected) in test_cases {
        let select_str = CustomSelect2::__easy_sql_select::<TestDriver>(delimiter, arg);
        assert_eq!(
            select_str, expected,
            "With delimiter='{}' and arg='{}'\nExpected: {}\nActual:   {}",
            delimiter, arg, expected, select_str
        );
    }
}