ormdantic-schema 2.0.1

Schema metadata structures for Ormdantic
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

#[derive(Debug, Clone, PartialEq, Eq)]
pub struct RelationshipDef {
    field: String,
    target_table: String,
    target_field: String,
    cardinality: RelationshipCardinality,
    back_reference: Option<String>,
    local_columns: Vec<String>,
    remote_columns: Vec<String>,
    direction: RelationshipDirection,
    uselist: bool,
    nullable: bool,
    secondary_table: Option<String>,
    cascade: Vec<CascadeAction>,
    loader_strategy: LoaderStrategy,
}

impl RelationshipDef {
    pub fn new(
        field: impl Into<String>,
        target_table: impl Into<String>,
        target_field: impl Into<String>,
        cardinality: RelationshipCardinality,
    ) -> Self {
        Self {
            field: field.into(),
            target_table: target_table.into(),
            target_field: target_field.into(),
            cardinality,
            back_reference: None,
            local_columns: Vec::new(),
            remote_columns: Vec::new(),
            direction: match cardinality {
                RelationshipCardinality::One => RelationshipDirection::ManyToOne,
                RelationshipCardinality::Many => RelationshipDirection::OneToMany,
            },
            uselist: cardinality == RelationshipCardinality::Many,
            nullable: true,
            secondary_table: None,
            cascade: Vec::new(),
            loader_strategy: LoaderStrategy::Lazy,
        }
    }

    pub fn with_back_reference(mut self, back_reference: impl Into<String>) -> Self {
        self.back_reference = Some(back_reference.into());
        self
    }

    pub fn with_columns(mut self, local_columns: Vec<String>, remote_columns: Vec<String>) -> Self {
        self.local_columns = local_columns;
        self.remote_columns = remote_columns;
        self
    }

    pub fn with_direction(mut self, direction: RelationshipDirection) -> Self {
        self.direction = direction;
        self
    }

    pub fn uselist(mut self, uselist: bool) -> Self {
        self.uselist = uselist;
        self
    }

    pub fn nullable(mut self, nullable: bool) -> Self {
        self.nullable = nullable;
        self
    }

    pub fn secondary_table(mut self, secondary_table: impl Into<String>) -> Self {
        self.secondary_table = Some(secondary_table.into());
        self
    }

    pub fn cascade(mut self, cascade: Vec<CascadeAction>) -> Self {
        self.cascade = cascade;
        self
    }

    pub fn loader_strategy(mut self, loader_strategy: LoaderStrategy) -> Self {
        self.loader_strategy = loader_strategy;
        self
    }

    pub fn field(&self) -> &str {
        &self.field
    }

    pub fn target_table(&self) -> &str {
        &self.target_table
    }

    pub fn target_field(&self) -> &str {
        &self.target_field
    }

    pub fn cardinality(&self) -> &RelationshipCardinality {
        &self.cardinality
    }

    pub fn back_reference(&self) -> Option<&str> {
        self.back_reference.as_deref()
    }

    pub fn local_columns(&self) -> &[String] {
        &self.local_columns
    }

    pub fn remote_columns(&self) -> &[String] {
        &self.remote_columns
    }

    pub fn direction(&self) -> &RelationshipDirection {
        &self.direction
    }

    pub fn is_uselist(&self) -> bool {
        self.uselist
    }

    pub fn is_nullable(&self) -> bool {
        self.nullable
    }

    pub fn secondary_table_name(&self) -> Option<&str> {
        self.secondary_table.as_deref()
    }

    pub fn cascade_actions(&self) -> &[CascadeAction] {
        &self.cascade
    }

    pub fn loader_strategy_ref(&self) -> &LoaderStrategy {
        &self.loader_strategy
    }
}

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum RelationshipCardinality {
    One,
    Many,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum RelationshipDirection {
    OneToOne,
    OneToMany,
    ManyToOne,
    ManyToMany,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum CascadeAction {
    SaveUpdate,
    Merge,
    Delete,
    DeleteOrphan,
    RefreshExpire,
    Expunge,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum LoaderStrategy {
    Lazy,
    Joined,
    SelectIn,
    Raise,
    NoLoad,
}