sequelite 0.2.3

A simple SQLite 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

use crate::connection::Connection;

use self::delete_query::ModelDeleteQuery;
use self::query::CountQuery;
use self::update_query::ModelUpdateQuery;

mod column;
pub mod migrator;
pub mod query;
pub mod update_query;
pub mod delete_query;
pub mod relation;

pub use rusqlite::Row as SqliteRow;
pub use rusqlite::Rows as SqliteRows;
pub use rusqlite::ToSql as SqliteToSql;
pub use column::Column;

/// A trait that needs to be implemented for all models that are used with sequelite.
/// 
/// This trait is hard to implement manually, so it is automatically implemented for every struct that derives [Model](sequelite_macro::Model).
/// 
/// ## Note
/// This trait is not meant to be implemented manually.
pub trait Model {
    fn table_name() -> &'static str;
    fn columns() -> &'static [Column<'static>];
    fn count_columns() -> usize;
    fn get_id(&self) -> i64;
    fn id_column() -> Column<'static>;
    fn column_value(&self, column: &'static Column<'static>) -> Option<Box<dyn rusqlite::types::ToSql>>;
    fn parse_rows(rows: rusqlite::Rows, offset: usize, joins: &Vec<String>) -> Vec<Self>
    where
        Self: Sized;
    fn parse_row(row: &rusqlite::Row, offset: usize, joins: &Vec<String>) -> Self
    where
        Self: Sized;
}

/// A trait that extends the [Model](Model) trait with some useful methods.
pub trait ModelExt<M: Model> {
    fn select() -> query::ModelQuery<M>
    where
        Self: Sized;

    fn insert(self, conn: &Connection) -> Result<i64, rusqlite::Error> 
    where
        Self: Sized;

    fn count() -> query::ModelQuery<CountQuery>
    where
        Self: Sized;

    fn update() -> ModelUpdateQuery<M>
    where
        Self: Sized;

    fn delete() -> ModelDeleteQuery<M>
    where
        Self: Sized;

}

impl<M: Model> ModelExt<M> for M {
    /// Creates a new [ModelQuery](query::ModelQuery) that can be used to select rows from the database.
    fn select() -> query::ModelQuery<M>
    where
        Self: Sized,
    {
        query::ModelQuery::select()
    }

    /// Inserts the model into the database.
    fn insert(self, conn: &Connection) -> Result<i64, rusqlite::Error> 
        where
            Self: Sized {
        conn.insert(self)
    }

    /// Creates a new [ModelQuery](query::ModelQuery) that can be used to count rows from the database.
    fn count() -> query::ModelQuery<CountQuery>
    where
        Self: Sized,
    {
        query::ModelQuery::<M>::count()
    }

    /// Creates a new [ModelUpdateQuery](update_query::ModelUpdateQuery) that can be used to update rows in the database.
    fn update() -> ModelUpdateQuery<M>
    where
        Self: Sized,
    {
        ModelUpdateQuery::new()
    }

    /// Creates a new [ModelDeleteQuery](delete_query::ModelDeleteQuery) that can be used to delete rows from the database.
    fn delete() -> ModelDeleteQuery<M>
    where
        Self: Sized,
    {
        ModelDeleteQuery::new()
    }
}