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
use super::{Database, TestDriver};
use crate::{Insert, Output, Table, Update};
use anyhow::Context;
use easy_macros::always_context;
use easy_sql_macros::{query, query_lazy};
use futures::StreamExt;

#[derive(Table, Debug, Clone)]
#[sql(no_version)]
struct TokioSpawnTable {
    #[sql(primary_key)]
    #[sql(auto_increment)]
    id: i32,
    group_key: String,
    int_field: i32,
    bool_field: bool,
    nullable_field: Option<String>,
}

#[derive(Insert, Output, Debug, Clone, PartialEq)]
#[sql(table = TokioSpawnTable)]
#[sql(default = id)]
struct TokioSpawnData {
    group_key: String,
    int_field: i32,
    bool_field: bool,
    nullable_field: Option<String>,
}

#[derive(Update, Debug, Clone)]
#[sql(table = TokioSpawnTable)]
struct TokioSpawnUpdate {
    group_key: String,
    int_field: i32,
    bool_field: bool,
    nullable_field: Option<String>,
}

fn spawn_rows() -> Vec<TokioSpawnData> {
    vec![
        TokioSpawnData {
            group_key: "A".to_string(),
            int_field: 10,
            bool_field: true,
            nullable_field: None,
        },
        TokioSpawnData {
            group_key: "A".to_string(),
            int_field: 20,
            bool_field: true,
            nullable_field: Some("x".to_string()),
        },
        TokioSpawnData {
            group_key: "B".to_string(),
            int_field: 30,
            bool_field: false,
            nullable_field: Some("y".to_string()),
        },
    ]
}

#[always_context(skip(!))]
#[no_context]
#[tokio::test]
async fn mini_test() -> anyhow::Result<()> {
    let db = Database::setup_for_testing::<TokioSpawnTable>().await?;

    tokio::spawn(async move {
        let mut conn = db.conn().await?;

        let data_vec = spawn_rows();
        query!(conn, INSERT INTO TokioSpawnTable VALUES {data_vec}).await?;

        anyhow::Ok(())
    })
    .await
    .context("tokio::spawn join error")?
}

#[always_context(skip(!))]
#[no_context]
#[tokio::test]
async fn test_select_inside_tokio_spawn_specific() -> anyhow::Result<()> {
    let db = Database::setup_for_testing::<TokioSpawnTable>().await?;

    {
        let mut conn = db.conn().await?;
        let data_vec = spawn_rows();
        query!(conn, INSERT INTO TokioSpawnTable VALUES {data_vec}).await?;
    }

    tokio::spawn(async move {
        let mut conn = db.conn().await?;
        let mut lazy_select = query_lazy!(
            <TestDriver>
            SELECT TokioSpawnData
            FROM TokioSpawnTable
            WHERE int_field >= 20
            ORDER BY int_field DESC
        )?;
        let mut selected = Vec::new();
        {
            let mut stream = lazy_select.fetch(&mut conn);
            while let Some(row) = stream.next().await {
                selected.push(row.context("Failed to fetch selected row")?);
            }
        }

        assert_eq!(selected.len(), 2);
        assert_eq!(selected[0].int_field, 30);
        assert_eq!(selected[1].int_field, 20);
        anyhow::Ok(())
    })
    .await
    .context("tokio::spawn join error")?
}

#[always_context(skip(!))]
#[no_context]
#[tokio::test]
async fn test_update_inside_tokio_spawn_specific() -> anyhow::Result<()> {
    let db = Database::setup_for_testing::<TokioSpawnTable>().await?;

    {
        let mut conn = db.conn().await?;
        let data = TokioSpawnData {
            group_key: "A".to_string(),
            int_field: 20,
            bool_field: true,
            nullable_field: Some("before".to_string()),
        };
        query!(conn, INSERT INTO TokioSpawnTable VALUES {data}).await?;
    }

    tokio::spawn(async move {
        let mut conn = db.conn().await?;
        let update_data = TokioSpawnUpdate {
            group_key: "A".to_string(),
            int_field: 25,
            bool_field: false,
            nullable_field: Some("after".to_string()),
        };
        let mut lazy_update = query_lazy!(
            <TestDriver>
            UPDATE TokioSpawnTable
            SET {update_data}
            WHERE int_field = 20
            RETURNING TokioSpawnData
        )?;
        let updated = {
            let mut stream = lazy_update.fetch(&mut conn);
            let updated_option = stream.next().await;
            let updated_result = updated_option.context("Expected UPDATE RETURNING row")?;
            updated_result.context("Failed to fetch UPDATE RETURNING row")?
        };

        assert_eq!(updated.int_field, 25);
        assert!(!updated.bool_field);
        assert_eq!(updated.nullable_field.as_deref(), Some("after"));
        anyhow::Ok(())
    })
    .await
    .context("tokio::spawn join error")?
}

#[always_context(skip(!))]
#[no_context]
#[tokio::test]
async fn test_delete_inside_tokio_spawn_specific() -> anyhow::Result<()> {
    let db = Database::setup_for_testing::<TokioSpawnTable>().await?;

    {
        let mut conn = db.conn().await?;
        let data = TokioSpawnData {
            group_key: "A".to_string(),
            int_field: 10,
            bool_field: true,
            nullable_field: Some("delete-me".to_string()),
        };
        query!(conn, INSERT INTO TokioSpawnTable VALUES {data}).await?;
    }

    tokio::spawn(async move {
        let mut conn = db.conn().await?;
        let mut lazy_delete = query_lazy!(
            <TestDriver>
            DELETE FROM TokioSpawnTable
            WHERE int_field = 10
            RETURNING TokioSpawnData
        )?;
        let deleted = {
            let mut stream = lazy_delete.fetch(&mut conn);
            let deleted_option = stream.next().await;
            let deleted_result = deleted_option.context("Expected DELETE RETURNING row")?;
            deleted_result.context("Failed to fetch DELETE RETURNING row")?
        };
        assert_eq!(deleted.int_field, 10);
        let exists_after_delete: bool =
            query!(conn, EXISTS TokioSpawnTable WHERE int_field = 10).await?;
        assert!(!exists_after_delete);
        anyhow::Ok(())
    })
    .await
    .context("tokio::spawn join error")?
}

#[always_context(skip(!))]
#[no_context]
#[tokio::test]
async fn test_exists_inside_tokio_spawn_specific() -> anyhow::Result<()> {
    let db = Database::setup_for_testing::<TokioSpawnTable>().await?;

    {
        let mut conn = db.conn().await?;
        let data = TokioSpawnData {
            group_key: "A".to_string(),
            int_field: 99,
            bool_field: true,
            nullable_field: None,
        };
        query!(conn, INSERT INTO TokioSpawnTable VALUES {data}).await?;
    }

    tokio::spawn(async move {
        let mut conn = db.conn().await?;
        let exists: bool = query!(conn, EXISTS TokioSpawnTable WHERE int_field = 99).await?;
        assert!(exists);

        anyhow::Ok(())
    })
    .await
    .context("tokio::spawn join error")?
}

#[always_context(skip(!))]
#[no_context]
#[tokio::test]
async fn test_query_macro_full_coverage_inside_tokio_spawn() -> anyhow::Result<()> {
    let db = Database::setup_for_testing::<TokioSpawnTable>().await?;

    tokio::spawn(async move {
        let mut conn = db.conn().await?;

        let data_vec = spawn_rows();
        query!(&mut conn, INSERT INTO TokioSpawnTable VALUES {data_vec}).await?;

        let min_int = 10;
        let min_count = 1;
        let limit_rows = 2;
        let selected: Vec<TokioSpawnData> = query!(&mut conn,
            SELECT DISTINCT Vec<TokioSpawnData>
            FROM TokioSpawnTable
            WHERE int_field >= {min_int} AND bool_field = true
            GROUP BY TokioSpawnTable.id
            HAVING COUNT(*) >= {min_count}
            ORDER BY int_field DESC
            LIMIT {limit_rows}
        )
        .await?;
        assert_eq!(selected.len(), 2);
        assert_eq!(selected[0].int_field, 20);
        assert_eq!(selected[1].int_field, 10);

        let updated_data = TokioSpawnUpdate {
            group_key: "A".to_string(),
            int_field: 25,
            bool_field: true,
            nullable_field: Some("updated".to_string()),
        };
        let updated: TokioSpawnData = query!(&mut conn,
            UPDATE TokioSpawnTable
            SET {updated_data}
            WHERE int_field = 20
            RETURNING TokioSpawnData
        )
        .await?;
        assert_eq!(updated.int_field, 25);
        assert_eq!(updated.nullable_field, Some("updated".to_string()));

        let deleted: TokioSpawnData = query!(&mut conn,
            DELETE FROM TokioSpawnTable
            WHERE int_field = 10
            RETURNING TokioSpawnData
        )
        .await?;
        assert_eq!(deleted.int_field, 10);

        let exists_after_delete: bool =
            query!(&mut conn, EXISTS TokioSpawnTable WHERE int_field = 10).await?;
        assert!(!exists_after_delete);

        let mut tx = db.transaction().await?;
        let tx_data = TokioSpawnData {
            group_key: "TX".to_string(),
            int_field: 77,
            bool_field: true,
            nullable_field: Some("tx".to_string()),
        };
        query!(&mut tx, INSERT INTO TokioSpawnTable VALUES {tx_data}).await?;
        let tx_exists: bool = query!(&mut tx, EXISTS TokioSpawnTable WHERE int_field = 77).await?;
        assert!(tx_exists);
        tx.rollback().await?;

        anyhow::Ok(())
    })
    .await
    .context("tokio::spawn join error")?
}

#[always_context(skip(!))]
#[no_context]
#[tokio::test]
async fn test_query_lazy_macro_full_coverage_inside_tokio_spawn() -> anyhow::Result<()> {
    let db = Database::setup_for_testing::<TokioSpawnTable>().await?;

    let handle = tokio::spawn(async move {
        let mut conn = db.conn().await?;

        for data in spawn_rows() {
            let mut lazy_insert = query_lazy!(<TestDriver> INSERT INTO TokioSpawnTable VALUES {data} RETURNING TokioSpawnData)?;
            let mut stream = lazy_insert.fetch(&mut conn);
            let inserted_option = stream.next().await;
            let inserted_result = inserted_option.context("Expected INSERT RETURNING row")?;
            let inserted = inserted_result.context("Failed to read INSERT RETURNING row")?;
            assert!(inserted.int_field > 0);
        }

        let threshold = 5;
        let mut lazy_select = query_lazy!(
            <TestDriver>
            SELECT TokioSpawnData FROM TokioSpawnTable
            WHERE int_field > {threshold}
            ORDER BY int_field DESC
            LIMIT 2
        )?;

        let mut selected = Vec::new();
        {
            let mut stream = lazy_select.fetch(&mut conn);
            while let Some(row) = stream.next().await {
                selected.push(row.context("Failed to fetch selected row")?);
            }
        }
        assert_eq!(selected.len(), 2);
        assert_eq!(selected[0].int_field, 30);
        assert_eq!(selected[1].int_field, 20);

        let new_int = 26;
        let mut lazy_update = query_lazy!(
            <TestDriver>
            UPDATE TokioSpawnTable
            SET int_field = {new_int}
            WHERE int_field = 20
            RETURNING TokioSpawnData
        )?;
        let updated = {
            let mut stream = lazy_update.fetch(&mut conn);
            let updated_option = stream.next().await;
            let updated_result = updated_option.context("Expected UPDATE RETURNING row")?;
            updated_result.context("Failed to fetch UPDATE RETURNING row")?
        };
        assert_eq!(updated.int_field, 26);

        let mut lazy_delete = query_lazy!(
            <TestDriver>
            DELETE FROM TokioSpawnTable
            WHERE int_field = 10
            RETURNING TokioSpawnData
        )?;
        let deleted = {
            let mut stream = lazy_delete.fetch(&mut conn);
            let deleted_option = stream.next().await;
            let deleted_result = deleted_option.context("Expected DELETE RETURNING row")?;
            deleted_result.context("Failed to fetch DELETE RETURNING row")?
        };
        assert_eq!(deleted.int_field, 10);

        let mut tx = db.transaction().await?;
        let tx_data = TokioSpawnData {
            group_key: "TX".to_string(),
            int_field: 88,
            bool_field: true,
            nullable_field: Some("tx-lazy".to_string()),
        };
        let mut tx_lazy_insert = query_lazy!(
            <TestDriver>
            INSERT INTO TokioSpawnTable VALUES {tx_data} RETURNING TokioSpawnData
        )?;
        let tx_inserted = {
            let mut stream = tx_lazy_insert.fetch(&mut tx);
            let row_option = stream.next().await;
            let row_result = row_option.context("Expected tx INSERT RETURNING row")?;
            row_result.context("Failed to fetch tx INSERT RETURNING row")?
        };
        assert_eq!(tx_inserted.int_field, 88);
        tx.rollback().await?;

        anyhow::Ok(())
    });

    let joined = handle.await.context("tokio::spawn join error")?;
    joined.context("spawned query_lazy! workflow failed")?;
    Ok(())
}