pgcrab 0.1.0

Linting and documentation generation tool for Postgres database schemas
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

// SPDX-FileCopyrightText: 2025 Olivier 'reivilibre'
//
// SPDX-License-Identifier: GPL-3.0-or-later

use super::{gather_comments::TotalHarvest, intermediate::IntermediateSchema};

/// Augment an `IntermediateSchema` with comments harvested from SQL files.
///
/// If `harvest_higher_priority` is true, then the comments harvested from SQL
/// files override those found in the schema itself.
pub fn combine_harvested_comments_into_schema(
    schema: &mut IntermediateSchema,
    harvest: &TotalHarvest,
    harvest_higher_priority: bool,
) {
    for (table_name, table) in &mut schema.tables {
        let Some(harvest_table) = harvest.tables.get(table_name) else {
            continue;
        };

        if let Some(harvest_tbl_comment) = &harvest_table.doc_comment {
            if table.comment.is_empty() || harvest_higher_priority {
                table.comment = harvest_tbl_comment.comment.clone();
            }
        }

        for column in &mut table.columns {
            let Some(harvest_column) = harvest_table.columns.get(&column.name) else {
                continue;
            };
            if let Some(harvest_col_comment) = &harvest_column.doc_comment {
                if column.comment.is_empty() || harvest_higher_priority {
                    column.comment = harvest_col_comment.comment.clone();
                }
            }
        }
    }
}