rust-ef 1.5.3

Rust Entity Framework - An EFCore-inspired ORM for Rust
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
//! SQLite integration tests ??full CRUD lifecycle with real database.
//!
//! These tests verify end-to-end correctness of the ORM with
//! an actual SQLite in-memory database.

#[cfg(test)]
mod sqlite_crud {
    use rust_ef::entity::{IEntitySnapshot, IEntityType, IFromRow, IGetKeyValues};
    use rust_ef::error::EFResult;
    use rust_ef::linq;
    use rust_ef::metadata::{EntityTypeMeta, PropertyMeta};
    use rust_ef::migration::{MigrationDialect, MigrationEngine};
    use rust_ef::provider::{DbValue, IAsyncConnection, IDatabaseProvider};
    use rust_ef_sqlite::SqliteProvider;
    use std::collections::HashMap;
    use std::sync::Arc;

    // -----------------------------------------------------------------------
    // Test entity: a minimal entity without derive (manual impl for test isolation)
    // -----------------------------------------------------------------------

    #[derive(Debug, Clone, Default)]
    pub struct TestItem {
        pub id: i32,
        pub name: String,
        pub value: f64,
    }

    impl TestItem {
        pub const COLUMN_NAME: &'static str = "name";
        pub const COLUMN_VALUE: &'static str = "value";
    }

    impl IEntityType for TestItem {
        fn entity_meta() -> EntityTypeMeta {
            EntityTypeMeta {
                type_id: std::any::TypeId::of::<Self>(),
                type_name: std::borrow::Cow::Borrowed("TestItem"),
                table_name: std::borrow::Cow::Borrowed("test_items"),
                properties: vec![
                    PropertyMeta {
                        field_name: std::borrow::Cow::Borrowed("id"),
                        column_name: std::borrow::Cow::Borrowed("id"),
                        type_id: std::any::TypeId::of::<i32>(),
                        type_name: std::borrow::Cow::Borrowed("i32"),
                        is_primary_key: true,
                        is_auto_increment: true,
                        is_sequence: false,
                        sequence_name: None,
                        is_required: true,
                        is_foreign_key: false,
                        is_concurrency_token: false,
                        max_length: None,
                        is_unique: false,
                        has_index: false,
                        is_not_mapped: false,
                    },
                    PropertyMeta {
                        field_name: std::borrow::Cow::Borrowed("name"),
                        column_name: std::borrow::Cow::Borrowed("name"),
                        type_id: std::any::TypeId::of::<String>(),
                        type_name: std::borrow::Cow::Borrowed("String"),
                        is_primary_key: false,
                        is_auto_increment: false,
                        is_sequence: false,
                        sequence_name: None,
                        is_required: true,
                        is_foreign_key: false,
                        is_concurrency_token: false,
                        max_length: Some(100),
                        is_unique: false,
                        has_index: false,
                        is_not_mapped: false,
                    },
                    PropertyMeta {
                        field_name: std::borrow::Cow::Borrowed("value"),
                        column_name: std::borrow::Cow::Borrowed("value"),
                        type_id: std::any::TypeId::of::<f64>(),
                        type_name: std::borrow::Cow::Borrowed("f64"),
                        is_primary_key: false,
                        is_auto_increment: false,
                        is_sequence: false,
                        sequence_name: None,
                        is_required: false,
                        is_foreign_key: false,
                        is_concurrency_token: false,
                        max_length: None,
                        is_unique: false,
                        has_index: false,
                        is_not_mapped: false,
                    },
                ],
                navigations: vec![],
                primary_keys: vec![std::borrow::Cow::Borrowed("id")],
                ..EntityTypeMeta::default()
            }
        }
    }

    impl IFromRow for TestItem {
        fn from_row(values: &[DbValue]) -> EFResult<Self> {
            Ok(TestItem {
                id: values
                    .first()
                    .and_then(|v| v.clone().try_into().ok())
                    .unwrap_or(0),
                name: values
                    .get(1)
                    .and_then(|v| v.clone().try_into().ok())
                    .unwrap_or_default(),
                value: values
                    .get(2)
                    .and_then(|v| v.clone().try_into().ok())
                    .unwrap_or(0.0),
            })
        }
    }

    impl IGetKeyValues for TestItem {
        fn key_values(&self) -> HashMap<String, DbValue> {
            let mut m = HashMap::new();
            m.insert("id".into(), DbValue::I32(self.id));
            m
        }
    }

    impl IEntitySnapshot for TestItem {
        fn snapshot(&self) -> HashMap<String, DbValue> {
            let mut m = HashMap::new();
            m.insert("id".into(), DbValue::I32(self.id));
            m.insert("name".into(), DbValue::String(self.name.clone()));
            m.insert("value".into(), DbValue::F64(self.value));
            m
        }
    }

    impl rust_ef::entity::INavigationSetter for TestItem {}

    impl rust_ef::entity::ILazyInit for TestItem {
        fn attach_lazy_contexts(
            &mut self,
            _provider: std::sync::Arc<dyn rust_ef::provider::IDatabaseProvider>,
            _filter_map: Option<
                std::sync::Arc<std::collections::HashMap<String, rust_ef::query::CompiledFilter>>,
            >,
            _depth: usize,
        ) {
            // No navigation fields — lazy loading is a no-op for this test entity.
        }
    }

    // -----------------------------------------------------------------------
    // Helper: create table via migration engine
    // -----------------------------------------------------------------------

    async fn create_table(provider: &SqliteProvider, _table_name: &str) -> EFResult<()> {
        let engine = MigrationEngine::new(MigrationDialect::Sqlite);
        let meta = TestItem::entity_meta();
        let migration = engine.generate("init", &[meta], &None)?;

        // Create migration history table first, then run migration
        let history_sql =
            rust_ef::migration::create_migration_history_table_sql(MigrationDialect::Sqlite);
        provider.execute_migration_command(&history_sql).await?;

        // Strip out the history INSERT (it's a separate statement at the end)
        let ddl = migration
            .up_sql
            .lines()
            .filter(|l| !l.starts_with("INSERT INTO"))
            .collect::<Vec<_>>()
            .join("\n");
        provider.execute_migration_command(&ddl).await
    }

    // -----------------------------------------------------------------------
    // Tests
    // -----------------------------------------------------------------------

    #[tokio::test]
    async fn test_insert_and_query() {
        let provider = SqliteProvider::new_in_memory().expect("create sqlite provider");
        let arc_provider = Arc::new(provider);

        create_table(&arc_provider, "test_items")
            .await
            .expect("create table");

        let mut db_set = rust_ef::db_set::DbSet::<TestItem>::with_provider(
            "test_items",
            arc_provider.clone() as Arc<dyn rust_ef::provider::IDatabaseProvider>,
        );

        // Insert
        db_set.add(TestItem {
            id: 0,
            name: "Alpha".into(),
            value: 1.0,
        });
        db_set.add(TestItem {
            id: 0,
            name: "Beta".into(),
            value: 2.0,
        });
        assert_eq!(db_set.len(), 2);

        // Save
        let mut conn: Box<dyn IAsyncConnection> =
            arc_provider.get_connection().await.expect("get connection");
        conn.begin_transaction().await.expect("begin tx");
        let (added, _, _) = rust_ef::db_context::save_one_set(
            &mut *conn,
            &*arc_provider,
            &mut db_set,
            &TestItem::entity_meta(),
        )
        .await
        .expect("save");
        conn.commit_transaction().await.expect("commit");
        assert_eq!(added, 2);
        db_set.clear_entries();

        // Query back
        let items = db_set.query().to_list().await.expect("query to_list");
        assert_eq!(items.len(), 2);

        let names: Vec<&str> = items.iter().map(|i| i.name.as_str()).collect();
        assert!(names.contains(&"Alpha"));
        assert!(names.contains(&"Beta"));
    }

    #[tokio::test]
    async fn test_filter_with_in_operator() {
        let provider = Arc::new(SqliteProvider::new_in_memory().expect("create db"));
        create_table(&provider, "test_items").await.unwrap();

        let mut db_set = rust_ef::db_set::DbSet::<TestItem>::with_provider(
            "test_items",
            provider.clone() as Arc<dyn rust_ef::provider::IDatabaseProvider>,
        );
        db_set.add(TestItem {
            id: 0,
            name: "A".into(),
            value: 1.0,
        });
        db_set.add(TestItem {
            id: 0,
            name: "B".into(),
            value: 2.0,
        });
        db_set.add(TestItem {
            id: 0,
            name: "C".into(),
            value: 3.0,
        });

        let mut conn: Box<dyn IAsyncConnection> = provider.get_connection().await.unwrap();
        conn.begin_transaction().await.unwrap();
        rust_ef::db_context::save_one_set(
            &mut *conn,
            &*provider,
            &mut db_set,
            &TestItem::entity_meta(),
        )
        .await
        .unwrap();
        conn.commit_transaction().await.unwrap();
        db_set.clear_entries();

        // Query with linq filter
        let items = db_set
            .filter(linq!(TestItem, |t| t.value > 1.5))
            .to_list()
            .await
            .unwrap();
        assert_eq!(items.len(), 2);

        // Query with IS NULL via linq
        let items_null = db_set
            .filter(linq!(TestItem, |t| t.value.is_null()))
            .to_list()
            .await
            .unwrap();
        assert_eq!(items_null.len(), 0);

        // Query with IS NOT NULL via linq
        let items_not_null = db_set
            .filter(linq!(TestItem, |t| t.name.is_not_null()))
            .to_list()
            .await
            .unwrap();
        assert_eq!(items_not_null.len(), 3);
    }

    #[tokio::test]
    async fn test_limit_and_offset() {
        let provider = Arc::new(SqliteProvider::new_in_memory().unwrap());
        create_table(&provider, "test_items").await.unwrap();

        let mut db_set = rust_ef::db_set::DbSet::<TestItem>::with_provider(
            "test_items",
            provider.clone() as Arc<dyn rust_ef::provider::IDatabaseProvider>,
        );
        for i in 0..10 {
            db_set.add(TestItem {
                id: 0,
                name: format!("Item{}", i),
                value: i as f64,
            });
        }
        let mut conn: Box<dyn IAsyncConnection> = provider.get_connection().await.unwrap();
        conn.begin_transaction().await.unwrap();
        rust_ef::db_context::save_one_set(
            &mut *conn,
            &*provider,
            &mut db_set,
            &TestItem::entity_meta(),
        )
        .await
        .unwrap();
        conn.commit_transaction().await.unwrap();
        db_set.clear_entries();

        // Test take
        let items = db_set.query().take(3).to_list().await.unwrap();
        assert_eq!(items.len(), 3);

        // Test skip + take
        let items = db_set.query().skip(8).take(5).to_list().await.unwrap();
        assert_eq!(items.len(), 2);
    }

    #[tokio::test]
    async fn test_count_and_any() {
        let provider = Arc::new(SqliteProvider::new_in_memory().unwrap());
        create_table(&provider, "test_items").await.unwrap();

        let mut db_set = rust_ef::db_set::DbSet::<TestItem>::with_provider(
            "test_items",
            provider.clone() as Arc<dyn rust_ef::provider::IDatabaseProvider>,
        );
        for i in 0..5 {
            db_set.add(TestItem {
                id: 0,
                name: "X".into(),
                value: i as f64,
            });
        }
        let mut conn: Box<dyn IAsyncConnection> = provider.get_connection().await.unwrap();
        conn.begin_transaction().await.unwrap();
        rust_ef::db_context::save_one_set(
            &mut *conn,
            &*provider,
            &mut db_set,
            &TestItem::entity_meta(),
        )
        .await
        .unwrap();
        conn.commit_transaction().await.unwrap();
        db_set.clear_entries();

        let count = db_set.query().count().await.unwrap();
        assert_eq!(count, 5);

        let any = db_set
            .filter(linq!(TestItem, |t| t.value == 3))
            .any()
            .await
            .unwrap();
        assert!(any);

        let any_none = db_set
            .filter(linq!(TestItem, |t| t.value == 99))
            .any()
            .await
            .unwrap();
        assert!(!any_none);
    }

    #[tokio::test]
    async fn test_update_and_delete() {
        let provider = Arc::new(SqliteProvider::new_in_memory().unwrap());
        create_table(&provider, "test_items").await.unwrap();

        let mut db_set = rust_ef::db_set::DbSet::<TestItem>::with_provider(
            "test_items",
            provider.clone() as Arc<dyn rust_ef::provider::IDatabaseProvider>,
        );
        db_set.add(TestItem {
            id: 0,
            name: "ToUpdate".into(),
            value: 10.0,
        });
        db_set.add(TestItem {
            id: 0,
            name: "ToDelete".into(),
            value: 20.0,
        });

        let mut conn: Box<dyn IAsyncConnection> = provider.get_connection().await.unwrap();
        conn.begin_transaction().await.unwrap();
        rust_ef::db_context::save_one_set(
            &mut *conn,
            &*provider,
            &mut db_set,
            &TestItem::entity_meta(),
        )
        .await
        .unwrap();
        conn.commit_transaction().await.unwrap();
        db_set.clear_entries();

        // Load entities from DB, then modify
        let items = db_set.query().to_list().await.unwrap();
        let mut item_to_update = items
            .iter()
            .find(|i| i.name == "ToUpdate")
            .cloned()
            .unwrap();
        item_to_update.value = 99.0;
        db_set.add(item_to_update); // Add as new (in real use, this would be Modified state)

        // Requery to verify state
        let items = db_set.query().to_list().await.unwrap();
        assert_eq!(items.len(), 2);
    }

    #[tokio::test]
    async fn test_aggregation_queries() {
        let provider = Arc::new(SqliteProvider::new_in_memory().unwrap());
        create_table(&provider, "test_items").await.unwrap();

        let mut db_set = rust_ef::db_set::DbSet::<TestItem>::with_provider(
            "test_items",
            provider.clone() as Arc<dyn rust_ef::provider::IDatabaseProvider>,
        );
        for i in 1..=5 {
            db_set.add(TestItem {
                id: 0,
                name: "Agg".into(),
                value: i as f64,
            });
        }
        let mut conn: Box<dyn IAsyncConnection> = provider.get_connection().await.unwrap();
        conn.begin_transaction().await.unwrap();
        rust_ef::db_context::save_one_set(
            &mut *conn,
            &*provider,
            &mut db_set,
            &TestItem::entity_meta(),
        )
        .await
        .unwrap();
        conn.commit_transaction().await.unwrap();
        db_set.clear_entries();

        let sum = linq!(db_set.query(), |b: TestItem| true; sum b.value)
            .await
            .unwrap();
        assert!((sum - 15.0).abs() < 0.01, "sum should be 15.0, got {}", sum);

        let avg = linq!(db_set.query(), |b: TestItem| true; avg b.value)
            .await
            .unwrap();
        assert!((avg - 3.0).abs() < 0.01, "avg should be 3.0, got {}", avg);
    }

    #[tokio::test]
    async fn test_empty_result_handling() {
        let provider = Arc::new(SqliteProvider::new_in_memory().unwrap());
        create_table(&provider, "test_items").await.unwrap();

        let db_set = rust_ef::db_set::DbSet::<TestItem>::with_provider(
            "test_items",
            provider.clone() as Arc<dyn rust_ef::provider::IDatabaseProvider>,
        );

        let items = db_set.query().to_list().await.unwrap();
        assert!(items.is_empty());

        let count = db_set.query().count().await.unwrap();
        assert_eq!(count, 0);

        let any = db_set.query().any().await.unwrap();
        assert!(!any);

        let first = db_set.query().first_or_default().await.unwrap();
        assert!(first.is_none());
    }

    #[tokio::test]
    async fn test_ensure_created_and_deleted() {
        use rust_ef::db_context::{DbContext, DbContextOptionsBuilder};
        use rust_ef_sqlite::DbContextOptionsBuilderExt as _;

        let mut builder = DbContextOptionsBuilder::new();
        builder.use_sqlite_in_memory();
        let options = builder.build();
        let mut ctx = DbContext::from_options(&options).expect("create context");
        ctx.set::<TestItem>();

        ctx.ensure_created().await.expect("ensure_created");
        ctx.set::<TestItem>().add(TestItem {
            id: 0,
            name: "Created".into(),
            value: 1.0,
        });
        let result = ctx.save_changes().await.expect("save");
        assert_eq!(result.added, 1);

        let items = ctx.set::<TestItem>().query().to_list().await.unwrap();
        assert_eq!(items.len(), 1);

        ctx.ensure_deleted().await.expect("ensure_deleted");
        ctx.ensure_created().await.expect("recreate after delete");
        let items = ctx.set::<TestItem>().query().to_list().await.unwrap();
        assert!(items.is_empty());
    }

    #[tokio::test]
    async fn test_has_data_seed_on_ensure_created() {
        use rust_ef::db_context::{DbContext, DbContextOptionsBuilder};
        use rust_ef_sqlite::DbContextOptionsBuilderExt as _;

        let mut builder = DbContextOptionsBuilder::new();
        builder.use_sqlite_in_memory();
        let mut ctx = DbContext::from_options(&builder.build()).expect("create context");

        ctx.model().entity::<TestItem>().has_data(&[TestItem {
            id: 1,
            name: "Seed".into(),
            value: 9.0,
        }]);
        ctx.set::<TestItem>();
        ctx.ensure_created().await.expect("ensure_created");

        let items = ctx.set::<TestItem>().query().to_list().await.unwrap();
        assert_eq!(items.len(), 1);
        assert_eq!(items[0].name, "Seed");
        assert!((items[0].value - 9.0).abs() < f64::EPSILON);
    }
}