tideorm 0.9.4

A developer-friendly ORM for Rust with clean, expressive syntax
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
use crate::columns::ColumnLike;
use crate::config::DatabaseType;
use crate::model::Model as ModelTrait;
use crate::query::OrGroup;

#[cfg(all(feature = "sqlite", feature = "runtime-tokio"))]
use crate::{Database, QueryCache, TideConfig};
#[cfg(all(feature = "sqlite", feature = "runtime-tokio"))]
use std::sync::{Mutex, OnceLock};
#[cfg(all(feature = "sqlite", feature = "runtime-tokio"))]
use std::time::Duration;

#[tideorm::model(table = "query_mutation_guard_users")]
struct MutationGuardUser {
    #[tideorm(primary_key, auto_increment)]
    id: i64,
    name: String,
}

#[tideorm::model(table = "query_mutation_guard_soft_delete_users", soft_delete)]
struct SoftDeleteMutationGuardUser {
    #[tideorm(primary_key, auto_increment)]
    id: i64,
    name: String,
    deleted_at: Option<chrono::DateTime<chrono::Utc>>,
}

#[cfg(all(feature = "sqlite", feature = "runtime-tokio"))]
fn query_mutation_cache_test_guard() -> &'static Mutex<()> {
    static GUARD: OnceLock<Mutex<()>> = OnceLock::new();
    GUARD.get_or_init(|| Mutex::new(()))
}

#[cfg(all(feature = "sqlite", feature = "runtime-tokio"))]
async fn setup_query_mutation_cache_test_db() -> Database {
    Database::reset_global();
    TideConfig::reset();
    QueryCache::global().clear();
    QueryCache::global().enable();

    let db = Database::connect("sqlite::memory:")
        .await
        .expect("sqlite in-memory connection should succeed for query mutation cache tests");
    Database::set_global(db.clone()).expect("setting global database should succeed");

    db.__execute_with_params(
        "CREATE TABLE query_mutation_guard_users (id INTEGER PRIMARY KEY AUTOINCREMENT, name TEXT NOT NULL)",
        vec![],
    )
    .await
    .expect("creating mutation guard schema should succeed");
    db.__execute_with_params(
        "CREATE TABLE query_mutation_guard_soft_delete_users (id INTEGER PRIMARY KEY AUTOINCREMENT, name TEXT NOT NULL, deleted_at TEXT NULL)",
        vec![],
    )
    .await
    .expect("creating soft delete mutation guard schema should succeed");

    db
}

#[test]
fn query_fragment_preserves_soft_delete_scope_semantics() {
    let with_trashed = SoftDeleteMutationGuardUser::query().with_trashed();
    let fragment = with_trashed.consolidate();

    assert!(!fragment.is_empty());

    let rebuilt = SoftDeleteMutationGuardUser::query()
        .only_trashed()
        .apply(&fragment)
        .build_sql_preview();

    assert_eq!(rebuilt, with_trashed.build_sql_preview());
    assert!(
        !rebuilt.contains("deleted_at\" IS NOT NULL"),
        "sql: {rebuilt}"
    );
    assert!(!rebuilt.contains("deleted_at\" IS NULL"), "sql: {rebuilt}");
}

#[test]
fn query_fragment_only_trashed_scope_is_not_empty() {
    let fragment = SoftDeleteMutationGuardUser::query()
        .only_trashed()
        .consolidate();

    assert!(!fragment.is_empty());
}

#[test]
fn mutation_guard_rejects_unfiltered_delete() {
    let err = MutationGuardUser::query()
        .ensure_mutation_has_explicit_filters("delete")
        .unwrap_err();
    assert!(
        err.to_string()
            .contains("requires at least one explicit filter")
    );
}

#[test]
fn mutation_guard_accepts_basic_where_clause() {
    assert!(
        MutationGuardUser::query()
            .where_eq("id", 1)
            .ensure_mutation_has_explicit_filters("delete")
            .is_ok()
    );
}

#[test]
fn mutation_guard_accepts_non_empty_or_group() {
    assert!(
        MutationGuardUser::query()
            .begin_or()
            .or_where_eq("name", "alice")
            .end_or()
            .ensure_mutation_has_explicit_filters("delete")
            .is_ok()
    );
}

#[test]
fn mutation_guard_rejects_only_trashed_without_user_filters() {
    let err = SoftDeleteMutationGuardUser::query()
        .only_trashed()
        .ensure_mutation_has_explicit_filters("restore")
        .unwrap_err();
    assert!(
        err.to_string()
            .contains("requires at least one explicit filter")
    );
}

#[test]
fn mutation_guard_rejects_empty_nested_or_groups() {
    let mut query = MutationGuardUser::query();
    query
        .or_groups
        .push(OrGroup::new().nested_or(|group| group));

    let err = query
        .ensure_mutation_has_explicit_filters("delete")
        .unwrap_err();
    assert!(
        err.to_string()
            .contains("requires at least one explicit filter")
    );
}

#[test]
fn delete_all_accepts_unfiltered_queries() {
    assert!(
        MutationGuardUser::query()
            .ensure_mutation_has_no_explicit_filters("delete_all")
            .is_ok()
    );
}

#[test]
fn delete_all_rejects_filtered_queries() {
    let err = MutationGuardUser::query()
        .where_eq("id", 1)
        .ensure_mutation_has_no_explicit_filters("delete_all")
        .unwrap_err();
    assert!(err.to_string().contains("does not accept WHERE filters"));
}

#[tideorm::model(table = "query_count_guard_users")]
struct QueryCountGuardUser {
    #[tideorm(primary_key, auto_increment)]
    id: i64,
    name: String,
}

#[test]
fn count_sql_preserves_joins() {
    let (sql, params) = QueryCountGuardUser::query()
        .inner_join("profiles", "query_count_guard_users.id", "profiles.user_id")
        .where_eq("profiles.active", true)
        .build_count_sql_with_params_for_db(DatabaseType::Postgres);

    assert_eq!(params.len(), 1);
    assert!(sql.starts_with("SELECT COUNT(*) AS count FROM (SELECT "));
    assert!(sql.contains(" FROM \"query_count_guard_users\" "));
    assert!(sql.contains(
        "INNER JOIN \"profiles\" ON \"query_count_guard_users\".\"id\" = \"profiles\".\"user_id\""
    ));
    assert!(sql.contains("WHERE \"profiles\".\"active\" = $1"));
    assert!(sql.ends_with(") AS \"tideorm_count_subquery\""));
}

#[test]
fn count_sql_preserves_group_by_and_having() {
    let (sql, params) = QueryCountGuardUser::query()
        .select(vec!["name"])
        .group_by("name")
        .having("COUNT(*) > 1")
        .build_count_sql_with_params_for_db(DatabaseType::Postgres);

    assert!(params.is_empty());
    assert!(sql.starts_with("SELECT COUNT(*) AS count FROM (SELECT "));
    assert!(sql.contains("\"name\" FROM \"query_count_guard_users\""));
    assert!(sql.contains("GROUP BY \"name\""));
    assert!(sql.contains("HAVING COUNT(*) > 1"));
    assert!(sql.ends_with(") AS \"tideorm_count_subquery\""));
}

#[test]
fn count_sql_ignores_order_limit_and_offset() {
    let (sql, params) = QueryCountGuardUser::query()
        .where_eq("name", "alice")
        .order_by("name", crate::query::Order::Asc)
        .limit(10)
        .offset(20)
        .build_count_sql_with_params_for_db(DatabaseType::Postgres);

    assert_eq!(params.len(), 1);
    assert!(!sql.contains("ORDER BY"));
    assert!(!sql.contains("LIMIT 10"));
    assert!(!sql.contains("OFFSET 20"));
    assert!(sql.contains("WHERE \"name\" = $1"));
}

#[test]
fn exists_sql_uses_select_one_with_limit() {
    let (sql, params) = QueryCountGuardUser::query()
        .where_eq("name", "alice")
        .build_exists_sql_with_params_for_db(DatabaseType::Postgres);

    assert_eq!(params.len(), 1);
    assert!(sql.starts_with("SELECT 1 FROM (SELECT 1 FROM "));
    assert!(sql.contains("FROM \"query_count_guard_users\""));
    assert!(sql.contains("WHERE \"name\" = $1"));
    assert!(sql.ends_with("AS \"tideorm_exists_subquery\" LIMIT 1"));
}

#[test]
fn exists_sql_discards_original_projection_for_non_union_queries() {
    let (sql, params) = QueryCountGuardUser::query()
        .select(vec!["name"])
        .build_exists_sql_with_params_for_db(DatabaseType::Postgres);

    assert!(params.is_empty());
    assert!(sql.starts_with("SELECT 1 FROM (SELECT 1 FROM "));
    assert!(!sql.contains("SELECT \"query_count_guard_users\".\"name\""));
}

#[test]
fn exists_sql_ignores_order_limit_and_offset() {
    let (sql, params) = QueryCountGuardUser::query()
        .where_eq("name", "alice")
        .order_by("name", crate::query::Order::Asc)
        .limit(10)
        .offset(20)
        .build_exists_sql_with_params_for_db(DatabaseType::Postgres);

    assert_eq!(params.len(), 1);
    assert!(!sql.contains("ORDER BY"));
    assert!(!sql.contains("LIMIT 10"));
    assert!(!sql.contains("OFFSET 20"));
    assert!(sql.ends_with("LIMIT 1"));
    assert!(sql.contains("WHERE \"name\" = $1"));
}

#[test]
fn sql_preview_is_labeled_as_non_executable() {
    let preview = QueryCountGuardUser::query()
        .where_eq("name", "alice")
        .build_sql_preview();

    assert!(preview.starts_with("-- DEBUG PREVIEW (not executable, values are approximate)\n"));
    assert!(preview.contains("query_count_guard_users"));
    assert!(preview.contains("WHERE \"name\" = 'alice'"));
}

#[test]
fn sql_preview_marks_escaped_literal_like_helpers() {
    let name = crate::columns::Column::<String>::new("name");
    let preview = QueryCountGuardUser::query()
        .where_col(name.starts_with(r"100%_\done"))
        .build_sql_preview_for_db(DatabaseType::Postgres);

    assert!(preview.contains("LIKE '100\\%\\_\\\\done%'"));
    assert!(preview.contains("ESCAPE '\\'"));
}

#[test]
fn postgres_parameterized_sql_uses_single_character_like_escape() {
    let name = crate::columns::Column::<String>::new("name");
    let (sql, params) = QueryCountGuardUser::query()
        .where_col(name.starts_with(r"100%_\done"))
        .build_select_sql_with_params_for_db(DatabaseType::Postgres);

    assert!(sql.contains("WHERE \"name\" LIKE $1 ESCAPE '\\'"));
    assert_eq!(params.len(), 1);
}

#[test]
fn debug_output_includes_preview_banner_and_parameterized_sql() {
    let debug_info = QueryCountGuardUser::query()
        .where_eq("name", "alice")
        .debug();

    assert!(
        debug_info
            .sql
            .starts_with("-- DEBUG PREVIEW (not executable, values are approximate)\n")
    );
    assert!(debug_info.sql.contains("-- PARAMETERIZED SQL\nSELECT"));
    assert!(debug_info.sql.contains("query_count_guard_users"));
    assert_eq!(debug_info.params.len(), 1);
}

#[cfg(all(feature = "sqlite", feature = "runtime-tokio"))]
#[tokio::test]
async fn query_delete_invalidates_cached_queries() {
    let _guard = query_mutation_cache_test_guard()
        .lock()
        .expect("query mutation cache test guard should not be poisoned");
    let _db = setup_query_mutation_cache_test_db().await;

    let saved = MutationGuardUser {
        id: 0,
        name: "Alice".to_string(),
    }
    .save()
    .await
    .expect("seed save should succeed");

    let cached_before = MutationGuardUser::query()
        .order_by("id", crate::query::Order::Asc)
        .cache(Duration::from_secs(60))
        .get()
        .await
        .expect("cached query before delete should succeed");
    assert_eq!(cached_before.len(), 1);
    assert_eq!(QueryCache::global().stats().entries, 1);

    let rows_affected = MutationGuardUser::query()
        .where_eq("id", saved.id)
        .delete()
        .await
        .expect("query delete should succeed");

    assert_eq!(rows_affected, 1);
    assert_eq!(QueryCache::global().stats().entries, 0);
}

#[cfg(all(feature = "sqlite", feature = "runtime-tokio"))]
#[tokio::test]
async fn query_delete_all_invalidates_cached_queries() {
    let _guard = query_mutation_cache_test_guard()
        .lock()
        .expect("query mutation cache test guard should not be poisoned");
    let _db = setup_query_mutation_cache_test_db().await;

    MutationGuardUser {
        id: 0,
        name: "Alice".to_string(),
    }
    .save()
    .await
    .expect("seed save should succeed");

    let cached_before = MutationGuardUser::query()
        .order_by("id", crate::query::Order::Asc)
        .cache(Duration::from_secs(60))
        .get()
        .await
        .expect("cached query before delete_all should succeed");
    assert_eq!(cached_before.len(), 1);
    assert_eq!(QueryCache::global().stats().entries, 1);

    let rows_affected = MutationGuardUser::query()
        .delete_all()
        .await
        .expect("query delete_all should succeed");

    assert_eq!(rows_affected, 1);
    assert_eq!(QueryCache::global().stats().entries, 0);
}

#[cfg(all(feature = "sqlite", feature = "runtime-tokio"))]
#[tokio::test]
async fn soft_delete_and_restore_invalidate_cached_queries() {
    let _guard = query_mutation_cache_test_guard()
        .lock()
        .expect("query mutation cache test guard should not be poisoned");
    let _db = setup_query_mutation_cache_test_db().await;

    let saved = SoftDeleteMutationGuardUser {
        id: 0,
        name: "Alice".to_string(),
        deleted_at: None,
    }
    .save()
    .await
    .expect("seed save should succeed");

    let cached_before_soft_delete = SoftDeleteMutationGuardUser::query()
        .order_by("id", crate::query::Order::Asc)
        .cache(Duration::from_secs(60))
        .get()
        .await
        .expect("cached query before soft_delete should succeed");
    assert_eq!(cached_before_soft_delete.len(), 1);
    assert_eq!(QueryCache::global().stats().entries, 1);

    let soft_deleted = SoftDeleteMutationGuardUser::query()
        .where_eq("id", saved.id)
        .soft_delete()
        .await
        .expect("soft_delete should succeed");

    assert_eq!(soft_deleted, 1);
    assert_eq!(QueryCache::global().stats().entries, 0);

    let cached_before_restore = SoftDeleteMutationGuardUser::query()
        .with_trashed()
        .order_by("id", crate::query::Order::Asc)
        .cache(Duration::from_secs(60))
        .get()
        .await
        .expect("cached query before restore should succeed");
    assert_eq!(cached_before_restore.len(), 1);
    assert_eq!(QueryCache::global().stats().entries, 1);

    let restored = SoftDeleteMutationGuardUser::query()
        .where_eq("id", saved.id)
        .with_trashed()
        .restore()
        .await
        .expect("restore should succeed");

    assert_eq!(restored, 1);
    assert_eq!(QueryCache::global().stats().entries, 0);
}

#[cfg(all(feature = "sqlite", feature = "runtime-tokio"))]
#[tokio::test]
async fn force_delete_invalidates_cached_queries() {
    let _guard = query_mutation_cache_test_guard()
        .lock()
        .expect("query mutation cache test guard should not be poisoned");
    let _db = setup_query_mutation_cache_test_db().await;

    let saved = SoftDeleteMutationGuardUser {
        id: 0,
        name: "Alice".to_string(),
        deleted_at: None,
    }
    .save()
    .await
    .expect("seed save should succeed");

    SoftDeleteMutationGuardUser::query()
        .where_eq("id", saved.id)
        .soft_delete()
        .await
        .expect("soft_delete should succeed");

    let cached_before = SoftDeleteMutationGuardUser::query()
        .with_trashed()
        .order_by("id", crate::query::Order::Asc)
        .cache(Duration::from_secs(60))
        .get()
        .await
        .expect("cached query before force_delete should succeed");
    assert_eq!(cached_before.len(), 1);
    assert_eq!(QueryCache::global().stats().entries, 1);

    let rows_affected = SoftDeleteMutationGuardUser::query()
        .with_trashed()
        .where_eq("id", saved.id)
        .force_delete()
        .await
        .expect("force_delete should succeed");

    assert_eq!(rows_affected, 1);
    assert_eq!(QueryCache::global().stats().entries, 0);
}