Module: PgReports::Modules::SchemaAnalysis

Extended by:
SchemaAnalysis
Included in:
SchemaAnalysis
Defined in:
lib/pg_reports/modules/schema_analysis.rb

Overview

Schema analysis module - validates database schema consistency with application code

Instance Method Summary collapse

Instance Method Details

#counter_cache_issues(**_params) ⇒ Report

belongs_to …, counter_cache: … whose counter column is missing on the parent

Returns:



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
 
# File 'lib/pg_reports/modules/schema_analysis.rb', line 107

def counter_cache_issues(**_params)
  eager_load_models!
  results = []

  each_concrete_model do |model|
    counter_belongs_to(model).each do |assoc|
      counter_col = counter_cache_column_name(model, assoc)
      parent = parent_class_for(assoc)
      next unless parent && parent.table_exists?

      unless parent.column_names.include?(counter_col)
        results << {
          "schema" => "public",
          "child_model" => model.name,
          "child_table" => model.table_name,
          "parent_model" => parent.name,
          "parent_table" => parent.table_name,
          "expected_column" => counter_col,
          "issue" => "missing_column",
          "suggestion" => "add_column :#{parent.table_name}, :#{counter_col}, :integer, default: 0, null: false"
        }
      end
    end
  end

  Report.new(
    title: "Counter Cache Issues",
    data: results,
    columns: %w[child_model parent_model expected_column issue suggestion]
  )
end

#missing_validations ⇒ Report

Missing validations - unique indexes without corresponding validations

Returns:

  • (Report) —

    Report with unique indexes missing validations



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
 
# File 'lib/pg_reports/modules/schema_analysis.rb', line 11

def missing_validations
  unique_indexes = executor.execute_from_file(:schema_analysis, :unique_indexes)
  results = []

  unique_indexes.each do |index|
    schema_name = index["schema_name"]
    table_name = index["table_name"]
    index_name = index["index_name"]
    column_names = parse_array(index["column_names"])
    index_type = index["index_type"]

    # Skip primary keys (they don't need validation)
    next if index_type == "primary_key"

    # Try to find the model for this table
    model = find_model_for_table(table_name)

    if model.nil?
      results << {
        "schema" => schema_name,
        "table_name" => table_name,
        "index_name" => index_name,
        "columns" => column_names.join(", "),
        "index_type" => index_type,
        "status" => "no_model",
        "validation_status" => "Model not found",
        "suggestion" => "Create a model for this table or add validates :#{column_names.first}, uniqueness: true"
      }
      next
    end

    # Check if validation exists
    has_validation = check_uniqueness_validation(model, column_names)

    unless has_validation
      results << {
        "schema" => schema_name,
        "table_name" => table_name,
        "model_name" => model.name,
        "index_name" => index_name,
        "columns" => column_names.join(", "),
        "index_type" => index_type,
        "status" => "missing_validation",
        "validation_status" => "Missing uniqueness validation",
        "suggestion" => build_validation_suggestion(column_names)
      }
    end
  end

  Report.new(
    title: "Unique Indexes Missing Validations",
    data: results,
    columns: %w[table_name model_name columns status validation_status]
  )
end

#orphan_tables(**_params) ⇒ Report

Tables with no corresponding Rails model (legacy or HABTM)

Returns:



187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
 
# File 'lib/pg_reports/modules/schema_analysis.rb', line 187

def orphan_tables(**_params)
  eager_load_models!
  results = []

  ActiveRecord::Base.connection.tables.each do |table|
    next if internal_table?(table)
    next if find_model_for_table(table)

    columns = ActiveRecord::Base.connection.columns(table)
    row_count = approximate_row_count(table)

    results << {
      "schema" => "public",
      "table_name" => table,
      "row_count" => row_count,
      "column_count" => columns.size,
      "classification" => classify_orphan(columns)
    }
  end

  results.sort_by! { |r| -r["row_count"].to_i }

  Report.new(
    title: "Orphan Tables (No Rails Model)",
    data: results,
    columns: %w[table_name row_count column_count classification]
  )
end

#polymorphic_without_index(**_params) ⇒ Report

Polymorphic associations missing a composite (type, id) index

Returns:



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
 
# File 'lib/pg_reports/modules/schema_analysis.rb', line 69

def polymorphic_without_index(**_params)
  eager_load_models!
  results = []

  each_concrete_model do |model|
    polymorphic_belongs_to(model).each do |assoc|
      type_col = "#{assoc.name}_type"
      id_col = "#{assoc.name}_id"

      next unless model.column_names.include?(type_col) && model.column_names.include?(id_col)

      # Expression/functional indexes report `columns` as a String — drop them; we only care about column-list indexes.
      indexes = ActiveRecord::Base.connection.indexes(model.table_name).select { |i| i.columns.is_a?(Array) }
      composite = indexes.find { |idx| (idx.columns & [type_col, id_col]).size == 2 }
      next if composite

      results << {
        "schema" => "public",
        "table_name" => model.table_name,
        "model_name" => model.name,
        "association" => assoc.name.to_s,
        "type_column" => type_col,
        "id_column" => id_col,
        "coverage" => coverage_label(indexes, type_col, id_col),
        "suggestion" => "add_index :#{model.table_name}, [:#{type_col}, :#{id_col}]"
      }
    end
  end

  Report.new(
    title: "Polymorphic Associations Without Composite Index",
    data: results,
    columns: %w[table_name model_name association coverage suggestion]
  )
end

#soft_delete_without_scope(**_params) ⇒ Report

Tables with soft-delete column but no model scope filtering it

Returns:



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
171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/pg_reports/modules/schema_analysis.rb', line 141

def soft_delete_without_scope(**_params)
  eager_load_models!
  soft_delete_columns = %w[deleted_at discarded_at archived_at]
  results = []

  ActiveRecord::Base.connection.tables.each do |table|
    next if internal_table?(table)

    columns = ActiveRecord::Base.connection.columns(table).map(&:name)
    soft_col = (columns & soft_delete_columns).first
    next unless soft_col

    model = find_model_for_table(table)
    if model.nil?
      results << {
        "schema" => "public",
        "table_name" => table,
        "model_name" => "(no model)",
        "soft_delete_column" => soft_col,
        "status" => "no_model",
        "suggestion" => "Create a model or filter manually in queries"
      }
      next
    end

    next if model_filters_soft_delete?(model, soft_col)

    results << {
      "schema" => "public",
      "table_name" => table,
      "model_name" => model.name,
      "soft_delete_column" => soft_col,
      "status" => "no_scope",
      "suggestion" => "default_scope { where(#{soft_col}: nil) } or use discard/paranoia"
    }
  end

  Report.new(
    title: "Soft Delete Without Scope",
    data: results,
    columns: %w[table_name model_name soft_delete_column status suggestion]
  )
end