Module: RubyPgExtras

Defined in:
lib/ruby-pg-extras.rb,
lib/ruby_pg_extras/version.rb,
lib/ruby_pg_extras/index_info.rb,
lib/ruby_pg_extras/table_info.rb,
lib/ruby_pg_extras/size_parser.rb,
lib/ruby_pg_extras/diagnose_data.rb,
lib/ruby_pg_extras/diagnose_print.rb,
lib/ruby_pg_extras/detect_fk_column.rb,
lib/ruby_pg_extras/index_info_print.rb,
lib/ruby_pg_extras/table_info_print.rb,
lib/ruby_pg_extras/missing_fk_indexes.rb,
lib/ruby_pg_extras/missing_fk_constraints.rb

Defined Under Namespace

Classes: DetectFkColumn, DiagnoseData, DiagnosePrint, IndexInfo, IndexInfoPrint, MissingFkConstraints, MissingFkIndexes, SizeParser, TableInfo, TableInfoPrint

Constant Summary collapse

NEW_PG_STAT_STATEMENTS = 
"1.8"
PG_STAT_STATEMENTS_17 = 
"1.11"
QUERIES = 
i(
  add_extensions bloat blocking cache_hit db_settings
  calls extensions table_cache_hit tables index_cache_hit
  indexes index_size index_usage index_scans null_indexes locks all_locks
  long_running_queries mandelbrot outliers
  records_rank seq_scans table_index_scans table_indexes_size
  table_size total_index_size total_table_size
  unused_indexes duplicate_indexes vacuum_stats kill_all kill_pid
  pg_stat_statements_reset buffercache_stats
  buffercache_usage ssl_used connections
  table_schema table_foreign_keys
)
DEFAULT_SCHEMA = 
ENV["PG_EXTRAS_SCHEMA"] || "public"
REQUIRED_ARGS = 
{
  table_schema: [:table_name],
  table_foreign_keys: [:table_name],
}
DEFAULT_ARGS = 
Hash.new({}).merge({
  calls: { limit: 10 },
  calls_legacy: { limit: 10 },
  calls_17: { limit: 10 },
  long_running_queries: { threshold: "500 milliseconds" },
  locks: { limit: 20 },
  blocking: { limit: 20 },
  outliers: { limit: 10 },
  outliers_legacy: { limit: 10 },
  outliers_17: { limit: 10 },
  buffercache_stats: { limit: 10 },
  buffercache_usage: { limit: 20 },
  unused_indexes: { max_scans: 50, schema: DEFAULT_SCHEMA },
  null_indexes: { min_relation_size_mb: 10 },
  index_usage: { schema: DEFAULT_SCHEMA },
  index_cache_hit: { schema: DEFAULT_SCHEMA },
  table_cache_hit: { schema: DEFAULT_SCHEMA },
  index_scans: { schema: DEFAULT_SCHEMA },
  cache_hit: { schema: DEFAULT_SCHEMA },
  seq_scans: { schema: DEFAULT_SCHEMA },
  table_index_scans: { schema: DEFAULT_SCHEMA },
  records_rank: { schema: DEFAULT_SCHEMA },
  tables: { schema: DEFAULT_SCHEMA },
  kill_pid: { pid: 0 },
})
VERSION = 
"5.6.6"
@@database_url = 
nil

Class Method Summary collapse

Class Method Details

.connection ⇒ Object 



214
215
216
 
# File 'lib/ruby-pg-extras.rb', line 214

def self.connection
  @_connection ||= PG.connect(database_url)
end

.database_url ⇒ Object 



222
223
224
 
# File 'lib/ruby-pg-extras.rb', line 222

def self.database_url
  @@database_url || ENV["RUBY_PG_EXTRAS_DATABASE_URL"] || ENV.fetch("DATABASE_URL")
end

.database_url=(value) ⇒ Object 



218
219
220
 
# File 'lib/ruby-pg-extras.rb', line 218

def self.database_url=(value)
  @@database_url = value
end

.description_for(query_name:) ⇒ Object 



196
197
198
199
200
201
202
 
# File 'lib/ruby-pg-extras.rb', line 196

def self.description_for(query_name:)
  first_line = File.open(
    sql_path_for(query_name: query_name)
  ) { |f| f.readline }

  first_line[/\/\*(.*?)\*\//m, 1].strip
end

.diagnose(in_format: :display_table) ⇒ Object 



121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/ruby-pg-extras.rb', line 121

def self.diagnose(in_format: :display_table)
  data = RubyPgExtras::DiagnoseData.call

  if in_format == :display_table
    RubyPgExtras::DiagnosePrint.call(data)
  elsif in_format == :hash
    data
  elsif in_format == :array
    data.map(&:values)
  else
    raise "Invalid 'in_format' argument!"
  end
end

.display_result(result, title:, in_format:) ⇒ Object 



171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'lib/ruby-pg-extras.rb', line 171

def self.display_result(result, title:, in_format:)
  case in_format
  when :array
    result.values
  when :hash
    result.to_a
  when :raw
    result
  when :display_table
    headings = if result.count > 0
        result[0].keys
      else
        ["No results"]
      end

    puts Terminal::Table.new(
      title: title,
      headings: headings,
      rows: (result.try(:values) || result.map(&:values)),
    )
  else
    raise "Invalid in_format option"
  end
end

.index_info(args: {}, in_format: :display_table) ⇒ Object 



135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/ruby-pg-extras.rb', line 135

def self.index_info(args: {}, in_format: :display_table)
  data = RubyPgExtras::IndexInfo.call(args[:table_name])

  if in_format == :display_table
    RubyPgExtras::IndexInfoPrint.call(data)
  elsif in_format == :hash
    data
  elsif in_format == :array
    data.map(&:values)
  else
    raise "Invalid 'in_format' argument!"
  end
end

.missing_fk_constraints(args: {}, in_format: :display_table) ⇒ Object 



167
168
169
 
# File 'lib/ruby-pg-extras.rb', line 167

def self.missing_fk_constraints(args: {}, in_format: :display_table)
  RubyPgExtras::MissingFkConstraints.call(args[:table_name])
end

.missing_fk_indexes(args: {}, in_format: :display_table) ⇒ Object 



163
164
165
 
# File 'lib/ruby-pg-extras.rb', line 163

def self.missing_fk_indexes(args: {}, in_format: :display_table)
  RubyPgExtras::MissingFkIndexes.call(args[:table_name])
end

.run_query(query_name:, in_format:, args: {}) ⇒ Object 



111
112
113
114
115
116
117
118
119
 
# File 'lib/ruby-pg-extras.rb', line 111

def self.run_query(query_name:, in_format:, args: {})
  run_query_base(
    query_name: query_name,
    conn: connection,
    exec_method: :exec,
    in_format: in_format,
    args: args,
  )
end

.run_query_base(query_name:, conn:, exec_method:, in_format:, args: {}) ⇒ Object 



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
 
# File 'lib/ruby-pg-extras.rb', line 78

def self.run_query_base(query_name:, conn:, exec_method:, in_format:, args: {})
  if i(calls outliers).include?(query_name)
    pg_stat_statements_ver = conn.send(exec_method, "select installed_version from pg_available_extensions where name='pg_stat_statements'")
      .to_a[0].fetch("installed_version", nil)
    if pg_stat_statements_ver != nil
      if Gem::Version.new(pg_stat_statements_ver) < Gem::Version.new(NEW_PG_STAT_STATEMENTS)
        query_name = "#{query_name}_legacy".to_sym
      elsif Gem::Version.new(pg_stat_statements_ver) >= Gem::Version.new(PG_STAT_STATEMENTS_17)
        query_name = "#{query_name}_17".to_sym
      end
    end
  end

  REQUIRED_ARGS.fetch(query_name) { [] }.each do |arg_name|
    if args[arg_name].nil?
      raise ArgumentError, "'#{arg_name}' is required"
    end
  end

  sql = if (custom_args = DEFAULT_ARGS.fetch(query_name, {}).merge(args)) != {}
      sql_for(query_name: query_name) % custom_args
    else
      sql_for(query_name: query_name)
    end
  result = conn.send(exec_method, sql)

  display_result(
    result,
    title: description_for(query_name: query_name),
    in_format: in_format,
  )
end

.sql_for(query_name:) ⇒ Object 



204
205
206
207
208
 
# File 'lib/ruby-pg-extras.rb', line 204

def self.sql_for(query_name:)
  File.read(
    sql_path_for(query_name: query_name)
  )
end

.sql_path_for(query_name:) ⇒ Object 



210
211
212
 
# File 'lib/ruby-pg-extras.rb', line 210

def self.sql_path_for(query_name:)
  File.join(File.dirname(__FILE__), "/ruby_pg_extras/queries/#{query_name}.sql")
end

.table_info(args: {}, in_format: :display_table) ⇒ Object 



149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/ruby-pg-extras.rb', line 149

def self.table_info(args: {}, in_format: :display_table)
  data = RubyPgExtras::TableInfo.call(args[:table_name])

  if in_format == :display_table
    RubyPgExtras::TableInfoPrint.call(data)
  elsif in_format == :hash
    data
  elsif in_format == :array
    data.map(&:values)
  else
    raise "Invalid 'in_format' argument!"
  end
end