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
// Tests for query_lazy! macro
// This macro creates reusable query builders without immediate execution

use super::*;
use anyhow::Context;
use easy_macros::always_context;
use futures::StreamExt;
use easy_sql_macros::{query, query_lazy};

/// Test query_lazy! with SELECT (basic usage)
#[always_context(skip(!))]
#[tokio::test]
async fn test_query_lazy_select_basic() -> anyhow::Result<()> {
    let db = Database::setup_for_testing::<ExprTestTable>().await?;
    let mut conn = db.transaction().await?;

    insert_test_data(&mut conn, default_expr_test_data()).await?;

    // Create lazy query (returns LazyQueryResult struct)
    let mut lazy_query =
        query_lazy!(SELECT ExprTestData FROM ExprTestTable WHERE ExprTestTable.id = 1)?;

    // Execute the lazy query - fetch() returns a Stream
    let mut result_stream = lazy_query.fetch(&mut conn);

    // Get first result from stream
    let result_option = result_stream.next().await;
    let result_result = result_option.context("Expected at least one result")?;
    let result = result_result.context("Failed to fetch result")?;

    assert_eq!(result.int_field, 42);
    assert_eq!(result.str_field, "test");

    // Drop stream before rollback to release borrow on conn
    drop(result_stream);

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

/// Test query_lazy! using sqlx::Pool as connection
#[always_context(skip(!))]
#[tokio::test]
async fn test_query_lazy_with_sqlx_pool_connection() -> anyhow::Result<()> {
    let pool_resource = setup_sqlx_pool_for_testing::<ExprTestTable>().await?;
    let mut pool = pool_resource.pool();

    let data = default_expr_test_data();
    query!(pool, INSERT INTO ExprTestTable VALUES {data}).await?;

    let mut lazy_query =
        query_lazy!(SELECT ExprTestData FROM ExprTestTable WHERE ExprTestTable.id = 1)?;

    let mut result_stream = lazy_query.fetch(pool);

    let result_option = result_stream.next().await;
    let result_result = result_option.context("Expected at least one result")?;
    let result = result_result.context("Failed to fetch result")?;

    assert_eq!(result.int_field, 42);
    assert_eq!(result.str_field, "test");

    Ok(())
}

#[always_context(skip(!))]
#[tokio::test]
/// query.fetch() should not borrow connection forever
async fn test_query_lazy_con_not_borrowed_forever_check() -> anyhow::Result<()> {
    let db = Database::setup_for_testing::<ExprTestTable>().await?;
    let mut conn = db.transaction().await?;

    insert_multiple_test_data(
        &mut conn,
        vec![
            expr_test_data(10, "first", true, None),
            expr_test_data(20, "second", false, None),
        ],
    )
    .await?;

    // Each lazy query can only be used once
    let mut lazy_query1 =
        query_lazy!(SELECT ExprTestData FROM ExprTestTable WHERE ExprTestTable.id = 1)?;
    let mut lazy_query2 =
        query_lazy!(SELECT ExprTestData FROM ExprTestTable WHERE ExprTestTable.id = 1)?;

    // Execute first query
    let result1 = {
        let mut stream1 = lazy_query1.fetch(&mut conn);
        let result1_option = stream1.next().await;
        let result1_result = result1_option.context("Expected result 1")?;
        result1_result.context("Failed to fetch result 1")?
    };

    // Execute second query (separate LazyQueryResult)
    let result2 = {
        let mut stream2 = lazy_query2.fetch(&mut conn);
        let result2_option = stream2.next().await;
        let result2_result = result2_option.context("Expected result 2")?;
        result2_result.context("Failed to fetch result 2")?
    };

    assert_eq!(result1.int_field, result2.int_field);
    assert_eq!(result1.int_field, 10);

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

/// Test query_lazy! SELECT collecting multiple results from stream
#[always_context(skip(!))]
#[tokio::test]
async fn test_query_lazy_select_multiple() -> anyhow::Result<()> {
    let db = Database::setup_for_testing::<ExprTestTable>().await?;
    let mut conn = db.transaction().await?;

    insert_multiple_test_data(
        &mut conn,
        vec![
            expr_test_data(10, "a", true, None),
            expr_test_data(20, "b", false, None),
            expr_test_data(30, "c", true, None),
        ],
    )
    .await?;

    // query_lazy! returns single row stream, so we collect manually
    let mut lazy_query = query_lazy!(
        SELECT ExprTestData FROM ExprTestTable WHERE int_field > 5
    )?;

    let mut results = Vec::new();
    {
        let mut stream = lazy_query.fetch(&mut conn);
        while let Some(result) = stream.next().await {
            let data = result.context("Failed to fetch row")?;
            results.push(data);
        }
    }

    assert_eq!(results.len(), 3);

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

/// Test query_lazy! SELECT with ORDER BY and LIMIT
#[always_context(skip(!))]
#[tokio::test]
async fn test_query_lazy_select_complex() -> anyhow::Result<()> {
    let db = Database::setup_for_testing::<ExprTestTable>().await?;
    let mut conn = db.transaction().await?;

    insert_multiple_test_data(
        &mut conn,
        vec![
            expr_test_data(30, "c", true, None),
            expr_test_data(10, "a", false, None),
            expr_test_data(20, "b", true, None),
        ],
    )
    .await?;

    let mut lazy_query = query_lazy!(
        SELECT ExprTestData FROM ExprTestTable
        ORDER BY int_field DESC
        LIMIT 2
    )?;

    let mut results = Vec::new();
    {
        let mut stream = lazy_query.fetch(&mut conn);
        while let Some(result) = stream.next().await {
            let data = result.context("Failed to fetch row")?;
            results.push(data);
        }
    }

    assert_eq!(results.len(), 2);
    assert_eq!(results[0].int_field, 30);
    assert_eq!(results[1].int_field, 20);

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

/// Test query_lazy! INSERT with RETURNING (Postgres only, required for lazy insert)
#[always_context(skip(!))]
#[tokio::test]
async fn test_query_lazy_insert() -> anyhow::Result<()> {
    let db = Database::setup_for_testing::<ExprTestTable>().await?;
    let mut conn = db.transaction().await?;

    let data = default_expr_test_data();
    // query_lazy! requires RETURNING clause for INSERT
    let mut lazy_insert =
        query_lazy!(INSERT INTO ExprTestTable VALUES {data} RETURNING ExprTestData)?;

    // Execute the insert - fetch() returns a Stream
    let returned = {
        let mut stream = lazy_insert.fetch(&mut conn);
        let returned_option = stream.next().await;
        let returned_result = returned_option.context("Expected INSERT to return row")?;
        returned_result.context("Failed to get INSERT result")?
    };

    assert_eq!(returned.int_field, 42);

    // Verify insertion using regular query! macro
    let results: Vec<ExprTestData> = query!(&mut conn,
        SELECT Vec<ExprTestData> FROM ExprTestTable
    )
    .await?;

    assert_eq!(results.len(), 1);
    assert_eq!(results[0].int_field, 42);

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

/// Test query_lazy! UPDATE with RETURNING
#[always_context(skip(!))]
#[tokio::test]
async fn test_query_lazy_update() -> anyhow::Result<()> {
    let db = Database::setup_for_testing::<ExprTestTable>().await?;
    let mut conn = db.transaction().await?;

    insert_test_data(&mut conn, default_expr_test_data()).await?;

    let new_value = 100;
    let mut lazy_update = query_lazy!(
        UPDATE ExprTestTable
        SET int_field = {new_value}
        WHERE id = 1
        RETURNING ExprTestData
    )?;

    let updated = {
        let mut stream = lazy_update.fetch(&mut conn);
        let result_option = stream.next().await;
        let result_result = result_option.context("Expected UPDATE to return row")?;
        result_result.context("Failed to get UPDATE result")?
    };

    assert_eq!(updated.int_field, 100);
    assert_eq!(updated.str_field, "test");

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

/// Test query_lazy! DELETE with RETURNING
#[always_context(skip(!))]
#[tokio::test]
async fn test_query_lazy_delete() -> anyhow::Result<()> {
    let db = Database::setup_for_testing::<ExprTestTable>().await?;
    let mut conn = db.transaction().await?;

    insert_multiple_test_data(
        &mut conn,
        vec![
            expr_test_data(10, "a", true, None),
            expr_test_data(20, "b", false, None),
            expr_test_data(30, "c", true, None),
        ],
    )
    .await?;

    let mut lazy_delete = query_lazy!(
        DELETE FROM ExprTestTable
        WHERE int_field > 15
        RETURNING ExprTestData
    )?;

    let mut deleted_rows = Vec::new();
    {
        let mut stream = lazy_delete.fetch(&mut conn);
        while let Some(result) = stream.next().await {
            let data = result.context("Failed to fetch deleted row")?;
            deleted_rows.push(data);
        }
    }

    // Should have deleted rows with int_field 20 and 30
    assert_eq!(deleted_rows.len(), 2);
    assert!(deleted_rows.iter().any(|r| r.int_field == 20));
    assert!(deleted_rows.iter().any(|r| r.int_field == 30));

    // Verify deletion - only row with int_field 10 should remain
    let remaining: Vec<ExprTestData> = query!(&mut conn,
        SELECT Vec<ExprTestData> FROM ExprTestTable
    )
    .await?;

    assert_eq!(remaining.len(), 1);
    assert_eq!(remaining[0].int_field, 10);

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

/// Test query_lazy! with variable capture
#[always_context(skip(!))]
#[tokio::test]
async fn test_query_lazy_variable_capture() -> anyhow::Result<()> {
    let db = Database::setup_for_testing::<ExprTestTable>().await?;
    let mut conn = db.transaction().await?;

    insert_multiple_test_data(
        &mut conn,
        vec![
            expr_test_data(10, "a", true, None),
            expr_test_data(20, "b", false, None),
            expr_test_data(30, "c", true, None),
        ],
    )
    .await?;

    let threshold = 15;
    let mut lazy_query = query_lazy!(
        SELECT ExprTestData FROM ExprTestTable WHERE int_field > {threshold}
    )?;

    let mut results = Vec::new();
    {
        let mut stream = lazy_query.fetch(&mut conn);
        while let Some(result) = stream.next().await {
            let data = result.context("Failed to fetch row")?;
            results.push(data);
        }
    }

    assert_eq!(results.len(), 2);
    assert_eq!(results[0].int_field, 20);
    assert_eq!(results[1].int_field, 30);

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

/// Test query_lazy! can be stored and passed around
#[always_context(skip(!))]
#[tokio::test]
async fn test_query_lazy_storage() -> anyhow::Result<()> {
    let db = Database::setup_for_testing::<ExprTestTable>().await?;
    let mut conn = db.transaction().await?;

    insert_test_data(&mut conn, default_expr_test_data()).await?;

    // Store lazy query in a variable
    let mut my_query =
        query_lazy!(SELECT ExprTestData FROM ExprTestTable WHERE ExprTestTable.id = 1)?;

    // Get result from query
    let result = {
        let mut stream = my_query.fetch(&mut conn);
        let result_option = stream.next().await;
        let result_result = result_option.context("Expected result")?;
        result_result.context("Failed to fetch result")?
    };

    assert_eq!(result.int_field, 42);

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

/// Test query_lazy! with complex WHERE clause
#[always_context(skip(!))]
#[tokio::test]
async fn test_query_lazy_complex_where() -> anyhow::Result<()> {
    let db = Database::setup_for_testing::<ExprTestTable>().await?;
    let mut conn = db.transaction().await?;

    insert_multiple_test_data(
        &mut conn,
        vec![
            expr_test_data(10, "test", true, None),
            expr_test_data(20, "test", false, None),
            expr_test_data(30, "other", true, None),
        ],
    )
    .await?;

    let mut lazy_query = query_lazy!(
        SELECT ExprTestData FROM ExprTestTable
        WHERE (int_field >= 10 AND int_field <= 30)
          AND str_field = "test"
          AND bool_field = true
    )?;

    let mut results = Vec::new();
    {
        let mut stream = lazy_query.fetch(&mut conn);
        while let Some(result) = stream.next().await {
            let data = result.context("Failed to fetch row")?;
            results.push(data);
        }
    }

    assert_eq!(results.len(), 1);
    assert_eq!(results[0].int_field, 10);

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

/// Test query_lazy! with RETURNING clause (Postgres only)
#[always_context(skip(!))]
#[tokio::test]
async fn test_query_lazy_with_returning() -> anyhow::Result<()> {
    let db = Database::setup_for_testing::<ExprTestTable>().await?;
    let mut conn = db.transaction().await?;

    let data = default_expr_test_data();
    let mut lazy_insert = query_lazy!(
        INSERT INTO ExprTestTable VALUES {data} RETURNING ExprTestData
    )?;

    let returned = {
        let mut stream = lazy_insert.fetch(&mut conn);
        let returned_option = stream.next().await;
        let returned_result = returned_option.context("Expected INSERT to return row")?;
        returned_result.context("Failed to get INSERT result")?
    };

    assert_eq!(returned.int_field, 42);
    assert_eq!(returned.str_field, "test");

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

/// Test multiple lazy queries in sequence (INSERT, UPDATE, SELECT)
#[always_context(skip(!))]
#[tokio::test]
async fn test_query_lazy_multiple_sequential() -> anyhow::Result<()> {
    let db = Database::setup_for_testing::<ExprTestTable>().await?;
    let mut conn = db.transaction().await?;

    // Use regular query! for INSERT (query_lazy! requires RETURNING for INSERT)
    let data = default_expr_test_data();
    query!(&mut conn, INSERT INTO ExprTestTable VALUES {data}).await?;

    // Now use query_lazy! for UPDATE with RETURNING
    let new_value = 999;
    let mut lazy_update = query_lazy!(
        UPDATE ExprTestTable
        SET int_field = {new_value}
        WHERE id = 1
        RETURNING ExprTestData
    )?;

    let updated = {
        let mut stream = lazy_update.fetch(&mut conn);
        let result_option = stream.next().await;
        let result_result = result_option.context("Expected UPDATE to return row")?;
        result_result.context("Failed to get UPDATE result")?
    };

    assert_eq!(updated.int_field, 999);

    // Verify with SELECT
    let mut lazy_select =
        query_lazy!(SELECT ExprTestData FROM ExprTestTable WHERE ExprTestTable.id = 1)?;
    let result = {
        let mut stream = lazy_select.fetch(&mut conn);
        let result_option = stream.next().await;
        let result_result = result_option.context("Expected SELECT result")?;
        result_result.context("Failed to fetch result")?
    };

    assert_eq!(result.int_field, 999);

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

/// Test that query_lazy! can be used in different scopes
#[always_context(skip(!))]
#[tokio::test]
async fn test_query_lazy_cross_scope() -> anyhow::Result<()> {
    let db = Database::setup_for_testing::<ExprTestTable>().await?;
    let mut conn = db.transaction().await?;

    insert_test_data(&mut conn, default_expr_test_data()).await?;

    // Define lazy query with a captured variable (must outlive the query)
    let filter_value = 1;
    let mut lazy_query = query_lazy!(SELECT ExprTestData FROM ExprTestTable WHERE ExprTestTable.id = {filter_value})?;

    // Execute in different scope
    let result = {
        let mut stream = lazy_query.fetch(&mut conn);
        let result_option = stream.next().await;
        let result_result = result_option.context("Expected result")?;
        result_result.context("Failed to fetch result")?
    };

    assert_eq!(result.int_field, 42);

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

// Note: EXISTS is NOT supported in query_lazy! as it requires immediate execution
// The following test would fail to compile:
//
// #[tokio::test]
// async fn test_query_lazy_exists_should_fail() {
//     // This should cause a compile error:
//     // let lazy_exists = query_lazy!(EXISTS ExprTestTable WHERE id = 1);
// }