mithril_signer/database/query/signed_beacon/
delete_signed_beacon.rs

1use sqlite::Value;
2
3use mithril_common::entities::Epoch;
4use mithril_persistence::sqlite::{Query, SourceAlias, SqLiteEntity, WhereCondition};
5
6use crate::database::record::SignedBeaconRecord;
7
8/// Query to delete old [SignedBeaconRecord] from the sqlite database
9pub struct DeleteSignedBeaconRecordQuery {
10    condition: WhereCondition,
11}
12
13impl Query for DeleteSignedBeaconRecordQuery {
14    type Entity = SignedBeaconRecord;
15
16    fn filters(&self) -> WhereCondition {
17        self.condition.clone()
18    }
19
20    fn get_definition(&self, condition: &str) -> String {
21        // it is important to alias the fields with the same name as the table
22        // since the table cannot be aliased in a RETURNING statement in SQLite.
23        let projection = Self::Entity::get_projection()
24            .expand(SourceAlias::new(&[("{:signed_beacon:}", "signed_beacon")]));
25
26        format!("delete from signed_beacon where {condition} returning {projection}")
27    }
28}
29
30impl DeleteSignedBeaconRecordQuery {
31    /// Create the SQL query to prune data older than the given Epoch.
32    pub fn below_epoch_threshold(epoch_threshold: Epoch) -> Self {
33        let epoch_threshold = Value::Integer(epoch_threshold.try_into().unwrap());
34
35        Self {
36            condition: WhereCondition::new("epoch < ?*", vec![epoch_threshold]),
37        }
38    }
39}
40
41#[cfg(test)]
42mod tests {
43    use mithril_common::entities::{BlockNumber, SignedEntityType};
44    use mithril_persistence::sqlite::ConnectionExtensions;
45
46    use crate::database::query::GetSignedBeaconQuery;
47    use crate::database::test_helper::{insert_signed_beacons, main_db_connection};
48
49    use super::*;
50
51    // Epoch of the signed entities is irrelevant for those tests, only SignedBeacon.epoch matter
52    const WHATEVER_EPOCH: Epoch = Epoch(378);
53
54    #[test]
55    fn test_delete_nothing_if_nothing_strictly_below_epoch_threshold() {
56        let connection = main_db_connection().unwrap();
57        insert_signed_beacons(
58            &connection,
59            SignedBeaconRecord::fakes(&[(
60                Epoch(7),
61                vec![SignedEntityType::MithrilStakeDistribution(WHATEVER_EPOCH)],
62            )]),
63        );
64
65        let delete_cursor = connection
66            .fetch(DeleteSignedBeaconRecordQuery::below_epoch_threshold(Epoch(
67                7,
68            )))
69            .unwrap();
70        assert_eq!(0, delete_cursor.count());
71
72        let get_all_cursor = connection.fetch(GetSignedBeaconQuery::all()).unwrap();
73        assert_eq!(1, get_all_cursor.count());
74    }
75
76    #[test]
77    fn test_delete_below_epoch_threshold() {
78        let connection = main_db_connection().unwrap();
79        insert_signed_beacons(
80            &connection,
81            SignedBeaconRecord::fakes(&[
82                (
83                    Epoch(7),
84                    vec![
85                        SignedEntityType::MithrilStakeDistribution(WHATEVER_EPOCH),
86                        SignedEntityType::CardanoTransactions(WHATEVER_EPOCH, BlockNumber(12)),
87                    ],
88                ),
89                (
90                    Epoch(8),
91                    vec![
92                        SignedEntityType::MithrilStakeDistribution(WHATEVER_EPOCH),
93                        SignedEntityType::CardanoStakeDistribution(WHATEVER_EPOCH),
94                    ],
95                ),
96                (
97                    Epoch(9),
98                    vec![
99                        SignedEntityType::MithrilStakeDistribution(WHATEVER_EPOCH),
100                        SignedEntityType::CardanoStakeDistribution(WHATEVER_EPOCH),
101                        SignedEntityType::CardanoTransactions(WHATEVER_EPOCH, BlockNumber(23)),
102                    ],
103                ),
104            ]),
105        );
106
107        let delete_cursor = connection
108            .fetch(DeleteSignedBeaconRecordQuery::below_epoch_threshold(Epoch(
109                9,
110            )))
111            .unwrap();
112        assert_eq!(4, delete_cursor.count());
113
114        let get_all_cursor = connection.fetch(GetSignedBeaconQuery::all()).unwrap();
115        assert_eq!(3, get_all_cursor.count());
116    }
117}
mithril_signer/database/query/signed_beacon/delete_signed_beacon.rs

mithril_signer/database/query/signed_beacon/
delete_signed_beacon.rs
