Class: RubyPgExtras::MissingFkIndexes

Inherits:
Object
  • Object
show all
Defined in:
lib/ruby_pg_extras/missing_fk_indexes.rb

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.call(table_name, ignore_list: nil) ⇒ Object

ignore_list: array (or comma-separated string) of entries like:

  • “posts.topic_id” (ignore a specific table+column)

  • “topic_id” (ignore this column name for all tables)

  • “posts.*” (ignore all columns on a table)

  • “*” (ignore everything)



10
11
12
 
# File 'lib/ruby_pg_extras/missing_fk_indexes.rb', line 10

def self.call(table_name, ignore_list: nil)
  new.call(table_name, ignore_list: ignore_list)
end

Instance Method Details

#call(table_name, ignore_list: nil) ⇒ Object 



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
 
# File 'lib/ruby_pg_extras/missing_fk_indexes.rb', line 14

def call(table_name, ignore_list: nil)
  ignore_list_matcher = IgnoreList.new(ignore_list)

  indexes_info = query_module.indexes(in_format: :hash)
  foreign_keys = query_module.foreign_keys(in_format: :hash)

  tables = if table_name
      [table_name]
    else
      foreign_keys.map { |row| row.fetch("table_name") }.uniq
    end

  tables.reduce([]) do |agg, table|
    index_info = indexes_info.select { |row| row.fetch("tablename") == table }
    table_fks = foreign_keys.select { |row| row.fetch("table_name") == table }

    table_fks.each do |fk|
      column_name = fk.fetch("column_name")

      # Skip columns explicitly excluded via ignore list.
      next if ignore_list_matcher.ignored?(table: table, column_name: column_name)

      if index_info.none? { |row| row.fetch("columns").split(",").first == column_name }
        agg.push(
          {
            table: table,
            column_name: column_name,
          }
        )
      end
    end

    agg
  end
end