schema_reverse_engineer/postgres/
relations.rs1use crate::error::SchemaReverseEngineerError;
2use schema_model::model::relation::Relation;
3use schema_model::model::types::RelationType;
4use sqlx::PgPool;
5use std::collections::HashMap;
6
7#[derive(Debug, sqlx::FromRow)]
8struct ForeignKeyRow {
9 constraint_name: String,
10 from_table: String,
11 from_column: String,
12 to_table: String,
13 to_column: String,
14 delete_rule: String,
15}
16
17struct ConstraintGroup {
19 from_table: String,
20 to_table: String,
21 delete_rule: String,
22 column_pairs: Vec<(String, String)>,
23}
24
25pub async fn list_foreign_keys(
36 pool: &PgPool,
37 db_schema: &str,
38) -> Result<HashMap<String, Vec<Relation>>, SchemaReverseEngineerError> {
39 let rows: Vec<ForeignKeyRow> = sqlx::query_as(
40 "SELECT tc.constraint_name AS constraint_name, \
41 tc.table_name AS from_table, fkcu.column_name AS from_column, \
42 ucu.table_name AS to_table, ucu.column_name AS to_column, \
43 rc.delete_rule AS delete_rule \
44 FROM information_schema.table_constraints tc \
45 JOIN information_schema.referential_constraints rc \
46 ON rc.constraint_name = tc.constraint_name AND rc.constraint_schema = tc.table_schema \
47 JOIN information_schema.key_column_usage fkcu \
48 ON fkcu.constraint_name = tc.constraint_name AND fkcu.table_schema = tc.table_schema \
49 JOIN information_schema.key_column_usage ucu \
50 ON ucu.constraint_name = rc.unique_constraint_name \
51 AND ucu.constraint_schema = rc.unique_constraint_schema \
52 AND ucu.ordinal_position = fkcu.position_in_unique_constraint \
53 WHERE tc.table_schema = $1 AND tc.constraint_type = 'FOREIGN KEY' \
54 ORDER BY tc.constraint_name, fkcu.ordinal_position",
55 )
56 .bind(db_schema)
57 .fetch_all(pool)
58 .await
59 .map_err(|e| SchemaReverseEngineerError::Introspection(e.to_string()))?;
60
61 group_foreign_key_rows(rows)
62}
63
64fn group_foreign_key_rows(rows: Vec<ForeignKeyRow>) -> Result<HashMap<String, Vec<Relation>>, SchemaReverseEngineerError> {
69 let mut groups: Vec<(String, ConstraintGroup)> = Vec::new();
70 for row in rows {
71 if let Some((last_name, group)) = groups.last_mut()
72 && *last_name == row.constraint_name
73 {
74 group.column_pairs.push((row.from_column, row.to_column));
75 continue;
76 }
77 groups.push((
78 row.constraint_name,
79 ConstraintGroup {
80 from_table: row.from_table,
81 to_table: row.to_table,
82 delete_rule: row.delete_rule,
83 column_pairs: vec![(row.from_column, row.to_column)],
84 },
85 ));
86 }
87
88 let mut by_table: HashMap<String, Vec<Relation>> = HashMap::new();
89 for (constraint_name, group) in groups {
90 let relation_type = map_delete_rule(&group.delete_rule);
91 let relation = if group.column_pairs.len() == 1 {
92 let (from_column, to_column) = group.column_pairs.into_iter().next().unwrap();
93 Relation::new(group.to_table, to_column, group.from_table.clone(), from_column, relation_type, false)
94 } else {
95 Relation::new_composite(group.to_table, group.from_table.clone(), group.column_pairs, relation_type, false).map_err(
96 |e| {
97 SchemaReverseEngineerError::Introspection(format!(
98 "foreign key constraint '{constraint_name}': {e}"
99 ))
100 },
101 )?
102 };
103 by_table.entry(group.from_table).or_default().push(relation);
104 }
105
106 Ok(by_table)
107}
108
109fn map_delete_rule(delete_rule: &str) -> RelationType {
110 match delete_rule {
111 "CASCADE" => RelationType::Cascade,
112 "SET NULL" | "SET DEFAULT" => RelationType::SetNull,
113 "RESTRICT" | "NO ACTION" => RelationType::Enforce,
114 _ => RelationType::DoNothing,
115 }
116}
117
118#[cfg(test)]
119mod tests {
120 use super::*;
121
122 fn row(constraint_name: &str, from_table: &str, from_column: &str, to_table: &str, to_column: &str, delete_rule: &str) -> ForeignKeyRow {
123 ForeignKeyRow {
124 constraint_name: constraint_name.to_string(),
125 from_table: from_table.to_string(),
126 from_column: from_column.to_string(),
127 to_table: to_table.to_string(),
128 to_column: to_column.to_string(),
129 delete_rule: delete_rule.to_string(),
130 }
131 }
132
133 #[test]
134 fn single_column_rows_produce_one_relation_per_row() {
135 let rows = vec![row("fk_a", "child", "parent_id", "parent", "id", "CASCADE")];
136 let by_table = group_foreign_key_rows(rows).unwrap();
137 let relations = &by_table["child"];
138 assert_eq!(relations.len(), 1);
139 assert!(!relations[0].is_composite());
140 assert_eq!(relations[0].from_column_name(), "parent_id");
141 assert_eq!(relations[0].to_column_name(), "id");
142 assert_eq!(relations[0].relation_type(), RelationType::Cascade);
143 }
144
145 #[test]
146 fn multi_row_same_constraint_groups_into_one_composite_relation() {
147 let rows = vec![
148 row("fk_assignment", "Assignment", "ParentAssignmentID", "Assignment", "ID", "CASCADE"),
149 row("fk_assignment", "Assignment", "PropertyID", "Assignment", "PropertyID", "CASCADE"),
150 ];
151 let by_table = group_foreign_key_rows(rows).unwrap();
152 let relations = &by_table["Assignment"];
153 assert_eq!(relations.len(), 1);
154 assert!(relations[0].is_composite());
155 assert_eq!(
156 relations[0].column_pairs(),
157 &[
158 ("ParentAssignmentID".to_string(), "ID".to_string()),
159 ("PropertyID".to_string(), "PropertyID".to_string()),
160 ]
161 );
162 }
163
164 #[test]
165 fn rows_from_different_constraints_stay_separate_even_when_adjacent() {
166 let rows = vec![
167 row("fk_a", "child", "a_id", "parent_a", "id", "CASCADE"),
168 row("fk_b", "child", "b_id", "parent_b", "id", "SET NULL"),
169 ];
170 let by_table = group_foreign_key_rows(rows).unwrap();
171 let relations = &by_table["child"];
172 assert_eq!(relations.len(), 2);
173 assert_eq!(relations[0].to_table_name(), "parent_a");
174 assert_eq!(relations[1].to_table_name(), "parent_b");
175 assert_eq!(relations[1].relation_type(), RelationType::SetNull);
176 }
177}