native_db 0.8.2

Drop-in embedded database
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

use native_db::*;
use native_model::{native_model, Model};
use serde::{Deserialize, Serialize};

#[derive(Serialize, Deserialize, Eq, PartialEq, Clone, Debug)]
#[native_model(id = 1, version = 1)]
#[native_db]
struct Item1 {
    #[primary_key]
    id: u32,
    #[secondary_key(unique)]
    name: String,
}

#[derive(Serialize, Deserialize, Eq, PartialEq, Clone, Debug)]
#[native_model(id = 2, version = 1)]
#[native_db]
struct Item2 {
    #[primary_key]
    id: u32,
    #[secondary_key(optional)]
    id2: Option<u32>,
    #[secondary_key]
    name: String,
}

// TODO: when we remove the feature upgrade_0_7_x, we must rewrite the test
#[test]
#[cfg(feature = "upgrade_0_7_x")]
fn test_refresh() {
    use std::path::PathBuf;
    #[cfg(any(target_os = "android", target_os = "ios"))]
    let database_path = { dinghy_test::test_project_path().join("tests/data/db_0_7_1") };

    #[cfg(not(any(target_os = "android", target_os = "ios")))]
    let database_path = {
        let root_project_path = env!("CARGO_MANIFEST_DIR");
        PathBuf::from(format!("{}/tests/data/db_0_7_1", root_project_path))
    };

    use shortcut_assert_fs::TmpFs;
    let tmp = TmpFs::new().unwrap();

    // Copy the legacy database to the temporary directory.
    let tmp_database_path = tmp.path("db_0_7_1");
    std::fs::copy(&database_path, &tmp_database_path).unwrap();

    // Open the legacy database with the upgrade feature. This must succeed.
    let mut models = Models::new();
    models.define::<Item1>().unwrap();
    models.define::<Item2>().unwrap();
    let db = Builder::new().open(&models, &tmp_database_path).unwrap();
    // TODO: during open, the database must be upgraded to the latest version.

    tmp.display_dir_entries();
    let stats = db.redb_stats().unwrap();
    assert_eq!(stats.primary_tables.len(), 2);
    assert_eq!(stats.primary_tables[0].name, "1_1_id");
    assert_eq!(stats.primary_tables[0].n_entries, Some(1));
    assert_eq!(stats.primary_tables[1].name, "2_1_id");
    assert_eq!(stats.primary_tables[1].n_entries, Some(1000));
    assert_eq!(stats.secondary_tables.len(), 3);
    assert_eq!(stats.secondary_tables[0].name, "1_1_name");
    assert_eq!(stats.secondary_tables[0].n_entries, Some(1));
    assert_eq!(stats.secondary_tables[1].name, "2_1_id2");
    assert_eq!(stats.secondary_tables[1].n_entries, Some(500));
    assert_eq!(stats.secondary_tables[2].name, "2_1_name");
    assert_eq!(stats.secondary_tables[2].n_entries, Some(1000));

    // Is not usefull but it's generaly used with the method upgrading_from_version.
    if db.upgrading_from_version("<0.8.0").unwrap() {
        // Refresh the database
        let rw = db.rw_transaction().unwrap();
        rw.refresh::<Item1>().unwrap();
        rw.refresh::<Item2>().unwrap();
        rw.commit().unwrap();
    } else {
        assert!(false);
    }

    let stats = db.redb_stats().unwrap();
    assert_eq!(stats.primary_tables.len(), 2);
    assert_eq!(stats.primary_tables[0].name, "1_1_id");
    assert_eq!(stats.primary_tables[0].n_entries, Some(1));
    assert_eq!(stats.primary_tables[1].name, "2_1_id");
    assert_eq!(stats.primary_tables[1].n_entries, Some(1000));
    assert_eq!(stats.secondary_tables.len(), 3);
    assert_eq!(stats.secondary_tables[0].name, "1_1_name");
    assert_eq!(stats.secondary_tables[0].n_entries, Some(1));
    assert_eq!(stats.secondary_tables[1].name, "2_1_id2");
    assert_eq!(stats.secondary_tables[1].n_entries, Some(500));
    assert_eq!(stats.secondary_tables[2].name, "2_1_name");
    assert_eq!(stats.secondary_tables[2].n_entries, Some(1000));
}