essential-builder-db 0.6.0

The Essential builder 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

//! Provides the SQL statements used by `essential-builder-db` via `const` `str`s.

/// Short-hand for including an SQL string from the `sql/` subdir at compile time.
macro_rules! include_sql_str {
    ($subpath:expr) => {
        include_str!(concat!(env!("CARGO_MANIFEST_DIR"), "/sql/", $subpath))
    };
}

/// Short-hand for declaring a `const` SQL str and presenting the SQL via the doc comment.
macro_rules! decl_const_sql_str {
    ($name:ident, $subpath:expr) => {
        /// ```sql
        #[doc = include_sql_str!($subpath)]
        /// ```
        pub const $name: &str = include_sql_str!($subpath);
    };
}

/// Table creation statements.
pub mod create {
    decl_const_sql_str!(SOLUTION_SET, "create/solution_set.sql");
    decl_const_sql_str!(SUBMISSION, "create/submission.sql");
    decl_const_sql_str!(SOLUTION_SET_FAILURE, "create/solution_set_failure.sql");
}

/// Statements for deleting rows from tables.
pub mod delete {
    decl_const_sql_str!(SOLUTION_SET, "delete/solution_set.sql");
    decl_const_sql_str!(
        OLDEST_SOLUTION_SET_FAILURES,
        "delete/oldest_solution_set_failures.sql"
    );
}

/// Statements for inserting rows into the tables.
pub mod insert {
    decl_const_sql_str!(SOLUTION_SET, "insert/solution_set.sql");
    decl_const_sql_str!(SUBMISSION, "insert/submission.sql");
    decl_const_sql_str!(SOLUTION_SET_FAILURE, "insert/solution_set_failure.sql");
}

/// Statements for making queries.
pub mod query {
    decl_const_sql_str!(GET_SOLUTION_SET, "query/get_solution_set.sql");
    decl_const_sql_str!(LIST_SOLUTION_SETS, "query/list_solution_sets.sql");
    decl_const_sql_str!(LIST_SUBMISSIONS, "query/list_submissions.sql");
    decl_const_sql_str!(
        LATEST_SOLUTION_SET_FAILURES,
        "query/latest_solution_set_failures.sql"
    );
    decl_const_sql_str!(
        LIST_SOLUTION_SET_FAILURES,
        "query/list_solution_set_failures.sql"
    );
}

pub mod table {
    use super::create;

    /// A table's name along with its create statement.
    #[derive(Clone, Copy, Debug, Eq, Hash, PartialEq, PartialOrd, Ord)]
    pub struct Table {
        /// The name of the table as declared in the create statement.
        pub name: &'static str,
        /// The table's create statement.
        pub create: &'static str,
    }

    impl Table {
        const fn new(name: &'static str, create: &'static str) -> Self {
            Self { name, create }
        }
    }

    pub const SOLUTION_SET: Table = Table::new("solution_set", create::SOLUTION_SET);
    pub const SUBMISSION: Table = Table::new("submission", create::SUBMISSION);
    pub const SOLUTION_SET_FAILURE: Table =
        Table::new("solution_set_failure", create::SOLUTION_SET_FAILURE);

    /// All tables in a list. Useful for initialisation and testing.
    pub const ALL: &[Table] = &[SOLUTION_SET, SUBMISSION, SOLUTION_SET_FAILURE];
}