rails-pg-extras 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9dfa15692ba53bb7e4e763859f519ac6ee4d1f6b40fe901dc4c0fa7bb245fa86
-  data.tar.gz: 284287818c776080da8f61b67ffef1604ec48ea622358a1c4822417fe50229fd
+  metadata.gz: b6bc007ddc338613256c083afc688a962ee9e79d3430e8c725e141e26611c490
+  data.tar.gz: 2d27467222f23985d1ac6e463095f80de58d8bd76e7fa0089203fd5d61852f46
 SHA512:
-  metadata.gz: 575d2bb592139fd3fcc91dc175fef56376a055b00a241e714b6ba13d8cdc287c84a2e887967bb947e20b7f6916e5756c297bcb0121522da00cc4cb72fe351aa4
-  data.tar.gz: 2c135940884acd28d4ab91970f2ba0a55bc8797b591a908aec6de51e31fea831596125bb99146c349b27ae8b5f054bbf53c31850706d43536fcf7d92eda0cd3a
+  metadata.gz: 54a816ff465969fea4dc82ecac87ac4d98bac06b65ab138cfaa3570a23d2e099cd0dbc1ae7210d4a4fb63e44a9618c0961b41b2fcb4ccd45b61fc37cdd247baf
+  data.tar.gz: 34ec1ee2fd6e730983ed9be54be68b8c6603eafb93147453125567f277d327d292743f9a1cbfd95b429454c7321a54800123a5cf71cbc01a362b6c065deb1aa6

data/lib/rails-pg-extras.rb

@@ -3,19 +3,17 @@
 require 'terminal-table'
 
 module RailsPGExtras
-  QUERIES =   %i(
+  QUERIES = %i(
     bloat blocking cache_hit
-     calls extensions
-     index_size index_usage locks all_locks
-     long_running_queries mandelbrot outliers
-     records_rank seq_scans table_indexes_size
-     table_size total_index_size total_table_size
-     unused_indexes vacuum_stats
+    calls extensions
+    index_size index_usage locks all_locks
+    long_running_queries mandelbrot outliers
+    records_rank seq_scans table_indexes_size
+    table_size total_index_size total_table_size
+    unused_indexes vacuum_stats
   )
 
   QUERIES.each do |query_name|
-    require "rails-pg-extras/queries/#{query_name}"
-
     define_singleton_method query_name do |options = { in_format: :display_table }|
       run_query(
         query_name: query_name,
@@ -25,9 +23,11 @@ module RailsPGExtras
   end
 
   def self.run_query(query_name:, in_format:)
-    result = connection.execute(self.public_send("#{query_name}_sql"))
-    title = self.public_send("#{query_name}_description")
-    display_result(result, title: title, in_format: in_format)
+    sql_path = File.join(File.dirname(__FILE__), "/rails-pg-extras/queries/#{query_name}.sql")
+    sql = File.read(sql_path)
+    description = sql.split("\n").first[/\/\*(.*?)\*\//m, 1].strip
+    result = connection.execute(sql)
+    display_result(result, title: description, in_format: in_format)
   end
 
   def self.display_result(result, title:, in_format:)

data/lib/rails-pg-extras/queries/{all_locks.rb → all_locks.sql}

@@ -1,12 +1,5 @@
-# frozen_string_literal: true
+/* Queries with active locks */
 
-module RailsPGExtras
-  def self.all_locks_description
-    "Queries with active locks"
-  end
-
-  def self.all_locks_sql
-    <<-EOS
 SELECT
   pg_stat_activity.pid,
   pg_class.relname,
@@ -21,6 +14,3 @@ OUTER JOIN pg_class
 WHERE pg_stat_activity.query <> '<insufficient privilege>'
   AND pg_locks.pid = pg_stat_activity.pid
   AND pg_stat_activity.pid <> pg_backend_pid() order by query_start;
-EOS
-  end
-end

data/lib/rails-pg-extras/queries/{bloat.rb → bloat.sql}

@@ -1,12 +1,5 @@
-# frozen_string_literal: true
+/* Table and index bloat in your database ordered by most wasteful */
 
-module RailsPGExtras
-  def self.bloat_description
-    "Table and index bloat in your database ordered by most wasteful"
-  end
-
-  def self.bloat_sql
-    <<-EOS
 WITH constants AS (
   SELECT current_setting('block_size')::numeric AS bs, 23 AS hdr, 4 AS ma
 ), bloat_info AS (
@@ -66,8 +59,5 @@ SELECT
   CASE WHEN ipages < iotta THEN '0' ELSE (bs*(ipages-iotta))::bigint END AS raw_waste
 FROM
   index_bloat) bloat_summary
-ORDER BY raw_waste DESC, bloat DESC
-EOS
-  end
-end
+ORDER BY raw_waste DESC, bloat DESC;
 

data/lib/rails-pg-extras/queries/{blocking.rb → blocking.sql}

@@ -1,12 +1,5 @@
-# frozen_string_literal: true
+/* Queries holding locks other queries are waiting to be released */
 
-module RailsPGExtras
-  def self.blocking_description
-    "Queries holding locks other queries are waiting to be released"
-  end
-
-  def self.blocking_sql
-    <<-EOS
 SELECT bl.pid AS blocked_pid,
   ka.query AS blocking_statement,
   now() - ka.query_start AS blocking_duration,
@@ -20,7 +13,4 @@ JOIN pg_catalog.pg_locks kl
   JOIN pg_catalog.pg_stat_activity ka
     ON kl.pid = ka.pid
 ON bl.transactionid = kl.transactionid AND bl.pid != kl.pid
-WHERE NOT bl.granted
-EOS
-  end
-end
+WHERE NOT bl.granted;

data/lib/rails-pg-extras/queries/{cache_hit.rb → cache_hit.sql}

@@ -1,12 +1,5 @@
-# frozen_string_literal: true
+/* Index and table hit rate */
 
-module RailsPGExtras
-  def self.cache_hit_description
-    "Index and table hit rate"
-  end
-
-  def self.cache_hit_sql
-    <<-EOS
 SELECT
   'index hit rate' AS name,
   (sum(idx_blks_hit)) / nullif(sum(idx_blks_hit + idx_blks_read),0) AS ratio
@@ -16,6 +9,3 @@ SELECT
  'table hit rate' AS name,
   sum(heap_blks_hit) / nullif(sum(heap_blks_hit) + sum(heap_blks_read),0) AS ratio
 FROM pg_statio_user_tables;
-EOS
-  end
-end

data/lib/rails-pg-extras/queries/{calls.rb → calls.sql}

@@ -1,19 +1,9 @@
-# frozen_string_literal: true
+/* 10 queries that have longest execution time in aggregate */
 
-module RailsPGExtras
-  def self.calls_description
-    "10 queries that have longest execution time in aggregate"
-  end
-
-  def self.calls_sql
-    <<-EOS
 SELECT query AS qry,
 interval '1 millisecond' * total_time AS exec_time,
 to_char((total_time/sum(total_time) OVER()) * 100, 'FM90D0') || '%'  AS prop_exec_time,
 to_char(calls, 'FM999G999G990') AS ncalls,
 interval '1 millisecond' * (blk_read_time + blk_write_time) AS sync_io_time
 FROM pg_stat_statements WHERE userid = (SELECT usesysid FROM pg_user WHERE usename = current_user LIMIT 1)
-ORDER BY calls DESC LIMIT 10
-EOS
-  end
-end
+ORDER BY calls DESC LIMIT 10;

data/lib/rails-pg-extras/queries/extensions.sql

@@ -0,0 +1,4 @@
+/* Available and installed extensions */
+
+SELECT * FROM pg_available_extensions ORDER BY installed_version;
+

data/lib/rails-pg-extras/queries/{index_size.rb → index_size.sql}

@@ -1,12 +1,5 @@
-# frozen_string_literal: true
+/* The size of indexes, descending by size */
 
-module RailsPGExtras
-  def self.index_size_description
-    "The size of indexes, descending by size"
-  end
-
-  def self.index_size_sql
-    <<-EOS
 SELECT c.relname AS name,
   pg_size_pretty(sum(c.relpages::bigint*8192)::bigint) AS size
 FROM pg_class c
@@ -16,6 +9,3 @@ AND n.nspname !~ '^pg_toast'
 AND c.relkind='i'
 GROUP BY c.relname
 ORDER BY sum(c.relpages) DESC;
-EOS
-  end
-end

data/lib/rails-pg-extras/queries/{index_usage.rb → index_usage.sql}

@@ -1,12 +1,5 @@
-# frozen_string_literal: true
+/* Index hit rate (effective databases are at 99% and up) */
 
-module RailsPGExtras
-  def self.index_usage_description
-    "Index hit rate (effective databases are at 99% and up)"
-  end
-
-  def self.index_usage_sql
-    <<-EOS
 SELECT relname,
    CASE idx_scan
      WHEN 0 THEN 'Insufficient data'
@@ -17,6 +10,3 @@ SELECT relname,
    pg_stat_user_tables
  ORDER BY
    n_live_tup DESC;
-EOS
-  end
-end

data/lib/rails-pg-extras/queries/{locks.rb → locks.sql}

@@ -1,12 +1,5 @@
-# frozen_string_literal: true
+/* Queries with active exclusive locks */
 
-module RailsPGExtras
-  def self.locks_description
-    "Queries with active exclusive locks"
-  end
-
-  def self.locks_sql
-    <<-EOS
 SELECT
   pg_stat_activity.pid,
   pg_class.relname,
@@ -21,6 +14,3 @@ WHERE pg_stat_activity.query <> '<insufficient privilege>'
   AND pg_locks.pid = pg_stat_activity.pid
   AND pg_locks.mode = 'ExclusiveLock'
   AND pg_stat_activity.pid <> pg_backend_pid() order by query_start;
-EOS
-  end
-end

data/lib/rails-pg-extras/queries/long_running_queries.rb

@@ -1,12 +1,5 @@
-# frozen_string_literal: true
+/* All queries longer than five minutes by descending duration */
 
-module RailsPGExtras
-  def self.long_running_queries_description
-    "All queries longer than five minutes by descending duration"
-  end
-
-  def self.long_running_queries_sql
-    <<-EOS
 SELECT
   pid,
   now() - pg_stat_activity.query_start AS duration,
@@ -19,6 +12,3 @@ WHERE
   AND now() - pg_stat_activity.query_start > interval '5 minutes'
 ORDER BY
   now() - pg_stat_activity.query_start DESC;
-EOS
-  end
-end

data/lib/rails-pg-extras/queries/{mandelbrot.rb → mandelbrot.sql}

@@ -1,12 +1,5 @@
-# frozen_string_literal: true
+/* The mandelbrot set */
 
-module RailsPGExtras
-  def self.mandelbrot_description
-    "The mandelbrot set"
-  end
-
-  def self.mandelbrot_sql
-    <<-EOS
 WITH RECURSIVE Z(IX, IY, CX, CY, X, Y, I) AS (
           SELECT IX, IY, X::float, Y::float, X::float, Y::float, 0
           FROM (select -2.2 + 0.031 * i, i from generate_series(0,101) as i) as xgen(x,ix),
@@ -25,7 +18,4 @@ FROM (
       ORDER BY IY, IX
      ) AS ZT
 GROUP BY IY
-ORDER BY IY
-EOS
-  end
-end
+ORDER BY IY;

data/lib/rails-pg-extras/queries/{outliers.rb → outliers.sql}

@@ -1,12 +1,5 @@
-# frozen_string_literal: true
+/* 10 queries that have longest execution time in aggregate */
 
-module RailsPGExtras
-  def self.outliers_description
-    "10 queries that have longest execution time in aggregate"
-  end
-
-  def self.outliers_sql
-    <<-EOS
 SELECT interval '1 millisecond' * total_time AS total_exec_time,
 to_char((total_time/sum(total_time) OVER()) * 100, 'FM90D0') || '%'  AS prop_exec_time,
 to_char(calls, 'FM999G999G999G990') AS ncalls,
@@ -14,7 +7,4 @@ interval '1 millisecond' * (blk_read_time + blk_write_time) AS sync_io_time,
 query AS query
 FROM pg_stat_statements WHERE userid = (SELECT usesysid FROM pg_user WHERE usename = current_user LIMIT 1)
 ORDER BY total_time DESC
-LIMIT 10
-EOS
-  end
-end
+LIMIT 10;

data/lib/rails-pg-extras/queries/records_rank.sql

@@ -0,0 +1,9 @@
+/* All tables and the number of rows in each ordered by number of rows descending */
+
+SELECT
+  relname AS name,
+  n_live_tup AS estimated_count
+FROM
+  pg_stat_user_tables
+ORDER BY
+  n_live_tup DESC;

data/lib/rails-pg-extras/queries/seq_scans.sql

@@ -0,0 +1,7 @@
+/* Count of sequential scans by table descending by order */
+
+SELECT relname AS name,
+       seq_scan as count
+FROM
+  pg_stat_user_tables
+ORDER BY seq_scan DESC;

data/lib/rails-pg-extras/queries/{table_indexes_size.rb → table_indexes_size.sql}

@@ -1,12 +1,5 @@
-# frozen_string_literal: true
+/* Total size of all the indexes on each table, descending by size */
 
-module RailsPGExtras
-  def self.table_indexes_size_description
-    "Total size of all the indexes on each table, descending by size"
-  end
-
-  def self.table_indexes_size_sql
-    <<-EOS
 SELECT c.relname AS table,
   pg_size_pretty(pg_indexes_size(c.oid)) AS index_size
 FROM pg_class c
@@ -15,6 +8,3 @@ WHERE n.nspname NOT IN ('pg_catalog', 'information_schema')
 AND n.nspname !~ '^pg_toast'
 AND c.relkind='r'
 ORDER BY pg_indexes_size(c.oid) DESC;
-EOS
-  end
-end

data/lib/rails-pg-extras/queries/{table_size.rb → table_size.sql}

@@ -1,12 +1,5 @@
-# frozen_string_literal: true
+/* Size of the tables (excluding indexes), descending by size */
 
-module RailsPGExtras
-  def self.table_size_description
-    "Size of the tables (excluding indexes), descending by size"
-  end
-
-  def self.table_size_sql
-    <<-EOS
 SELECT c.relname AS name,
   pg_size_pretty(pg_table_size(c.oid)) AS size
 FROM pg_class c
@@ -15,6 +8,3 @@ WHERE n.nspname NOT IN ('pg_catalog', 'information_schema')
 AND n.nspname !~ '^pg_toast'
 AND c.relkind='r'
 ORDER BY pg_table_size(c.oid) DESC;
-EOS
-  end
-end

data/lib/rails-pg-extras/queries/{total_index_size.rb → total_index_size.sql}

@@ -1,18 +1,8 @@
-# frozen_string_literal: true
+/* Total size of all indexes in MB */
 
-module RailsPGExtras
-  def self.total_index_size_description
-    "Total size of all indexes in MB"
-  end
-
-  def self.total_index_size_sql
-    <<-EOS
 SELECT pg_size_pretty(sum(c.relpages::bigint*8192)::bigint) AS size
 FROM pg_class c
 LEFT JOIN pg_namespace n ON (n.oid = c.relnamespace)
 WHERE n.nspname NOT IN ('pg_catalog', 'information_schema')
 AND n.nspname !~ '^pg_toast'
 AND c.relkind='i';
-EOS
-  end
-end

data/lib/rails-pg-extras/queries/{total_table_size.rb → total_table_size.sql}

@@ -1,12 +1,5 @@
-# frozen_string_literal: true
+/* Size of the tables (including indexes), descending by size */
 
-module RailsPGExtras
-  def self.total_table_size_description
-    "Size of the tables (including indexes), descending by size"
-  end
-
-  def self.total_table_size_sql
-    <<-EOS
 SELECT c.relname AS name,
   pg_size_pretty(pg_total_relation_size(c.oid)) AS size
 FROM pg_class c
@@ -15,6 +8,3 @@ WHERE n.nspname NOT IN ('pg_catalog', 'information_schema')
 AND n.nspname !~ '^pg_toast'
 AND c.relkind='r'
 ORDER BY pg_total_relation_size(c.oid) DESC;
-EOS
-  end
-end

data/lib/rails-pg-extras/queries/{unused_indexes.rb → unused_indexes.sql}

@@ -1,16 +1,9 @@
-# frozen_string_literal: true
+/* Unused and almost unused indexes */
+/* Ordered by their size relative to the number of index scans.
+Exclude indexes of very small tables (less than 5 pages),
+where the planner will almost invariably select a sequential scan,
+but may not in the future as the table grows */
 
-module RailsPGExtras
-  def self.unused_indexes_description
-    "Unused and almost unused indexes"
-  end
-  # Ordered by their size relative to the number of index scans.
-  # Exclude indexes of very small tables (less than 5 pages),
-  # where the planner will almost invariably select a sequential scan,
-  # but may not in the future as the table grows
-
-  def self.unused_indexes_sql
-    <<-EOS
 SELECT
   schemaname || '.' || relname AS table,
   indexrelname AS index,
@@ -21,6 +14,3 @@ JOIN pg_index i ON ui.indexrelid = i.indexrelid
 WHERE NOT indisunique AND idx_scan < 50 AND pg_relation_size(relid) > 5 * 8192
 ORDER BY pg_relation_size(i.indexrelid) / nullif(idx_scan, 0) DESC NULLS FIRST,
 pg_relation_size(i.indexrelid) DESC;
-EOS
-  end
-end

data/lib/rails-pg-extras/queries/{vacuum_stats.rb → vacuum_stats.sql}

@@ -1,12 +1,5 @@
-# frozen_string_literal: true
+/* Dead rows and whether an automatic vacuum is expected to be triggered */
 
-module RailsPGExtras
-  def self.vacuum_stats_description
-    "Dead rows and whether an automatic vacuum is expected to be triggered"
-  end
-
-  def self.vacuum_stats_sql
-    <<-EOS
 WITH table_opts AS (
   SELECT
     pg_class.oid, relname, nspname, array_to_string(reloptions, '') AS relopts
@@ -44,8 +37,4 @@ SELECT
 FROM
   pg_stat_user_tables psut INNER JOIN pg_class ON psut.relid = pg_class.oid
     INNER JOIN vacuum_settings ON pg_class.oid = vacuum_settings.oid
-ORDER BY 1
-EOS
-  end
-end
-
+ORDER BY 1;

data/lib/rails-pg-extras/version.rb

@@ -1,3 +1,3 @@
 module RailsPGExtras
-  VERSION = "0.4.1"
+  VERSION = "0.5.0"
 end

data/rails-pg-extras.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |gem|
   gem.version       = RailsPGExtras::VERSION
   gem.authors       = ["pawurb"]
   gem.email         = ["contact@pawelurbanek.com"]
-  gem.summary       = %q{ Rails PostgreSQL database insights }
-  gem.description   = %q{ A bunch of rake tasks for showing what's going on inside your Rails PostgreSQL database }
+  gem.summary       = %q{ Rails PostgreSQL performance database insights }
+  gem.description   = %q{ Rails port of Heroku PG Extras. The goal of this project is to provide a powerful insights into PostgreSQL database for Ruby on Rails apps that are not using the default Heroku PostgreSQL plugin. }
   gem.homepage      = "http://github.com/pawurb/rails-pg-extras"
   gem.files         = `git ls-files`.split("\n")
   gem.require_paths = ["lib"]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails-pg-extras
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - pawurb
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-28 00:00:00.000000000 Z
+date: 2019-12-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -38,8 +38,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: " A bunch of rake tasks for showing what's going on inside your Rails
-  PostgreSQL database "
+description: " Rails port of Heroku PG Extras. The goal of this project is to provide
+  a powerful insights into PostgreSQL database for Ruby on Rails apps that are not
+  using the default Heroku PostgreSQL plugin. "
 email:
 - contact@pawelurbanek.com
 executables: []
@@ -52,26 +53,26 @@ files:
 - README.md
 - Rakefile
 - lib/rails-pg-extras.rb
-- lib/rails-pg-extras/queries/all_locks.rb
-- lib/rails-pg-extras/queries/bloat.rb
-- lib/rails-pg-extras/queries/blocking.rb
-- lib/rails-pg-extras/queries/cache_hit.rb
-- lib/rails-pg-extras/queries/calls.rb
-- lib/rails-pg-extras/queries/extensions.rb
-- lib/rails-pg-extras/queries/index_size.rb
-- lib/rails-pg-extras/queries/index_usage.rb
-- lib/rails-pg-extras/queries/locks.rb
+- lib/rails-pg-extras/queries/all_locks.sql
+- lib/rails-pg-extras/queries/bloat.sql
+- lib/rails-pg-extras/queries/blocking.sql
+- lib/rails-pg-extras/queries/cache_hit.sql
+- lib/rails-pg-extras/queries/calls.sql
+- lib/rails-pg-extras/queries/extensions.sql
+- lib/rails-pg-extras/queries/index_size.sql
+- lib/rails-pg-extras/queries/index_usage.sql
+- lib/rails-pg-extras/queries/locks.sql
 - lib/rails-pg-extras/queries/long_running_queries.rb
-- lib/rails-pg-extras/queries/mandelbrot.rb
-- lib/rails-pg-extras/queries/outliers.rb
-- lib/rails-pg-extras/queries/records_rank.rb
-- lib/rails-pg-extras/queries/seq_scans.rb
-- lib/rails-pg-extras/queries/table_indexes_size.rb
-- lib/rails-pg-extras/queries/table_size.rb
-- lib/rails-pg-extras/queries/total_index_size.rb
-- lib/rails-pg-extras/queries/total_table_size.rb
-- lib/rails-pg-extras/queries/unused_indexes.rb
-- lib/rails-pg-extras/queries/vacuum_stats.rb
+- lib/rails-pg-extras/queries/mandelbrot.sql
+- lib/rails-pg-extras/queries/outliers.sql
+- lib/rails-pg-extras/queries/records_rank.sql
+- lib/rails-pg-extras/queries/seq_scans.sql
+- lib/rails-pg-extras/queries/table_indexes_size.sql
+- lib/rails-pg-extras/queries/table_size.sql
+- lib/rails-pg-extras/queries/total_index_size.sql
+- lib/rails-pg-extras/queries/total_table_size.sql
+- lib/rails-pg-extras/queries/unused_indexes.sql
+- lib/rails-pg-extras/queries/vacuum_stats.sql
 - lib/rails-pg-extras/railtie.rb
 - lib/rails-pg-extras/tasks/all.rake
 - lib/rails-pg-extras/version.rb
@@ -95,8 +96,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
-summary: Rails PostgreSQL database insights
+summary: Rails PostgreSQL performance database insights
 test_files: []

data/lib/rails-pg-extras/queries/extensions.rb

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-module RailsPGExtras
-  def self.extensions_description
-    "Available and installed extensions"
-  end
-
-  def self.extensions_sql
-    <<-EOS
-SELECT * FROM pg_available_extensions ORDER BY installed_version;
-EOS
-  end
-end

data/lib/rails-pg-extras/queries/records_rank.rb

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-module RailsPGExtras
-  def self.records_rank_description
-    "All tables and the number of rows in each ordered by number of rows descending"
-  end
-
-  def self.records_rank_sql
-    <<-EOS
-SELECT
-  relname AS name,
-  n_live_tup AS estimated_count
-FROM
-  pg_stat_user_tables
-ORDER BY
-  n_live_tup DESC;
-EOS
-  end
-end

data/lib/rails-pg-extras/queries/seq_scans.rb

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-module RailsPGExtras
-  def self.seq_scans_description
-    "Count of sequential scans by table descending by order"
-  end
-
-  def self.seq_scans_sql
-    <<-EOS
-SELECT relname AS name,
-       seq_scan as count
-FROM
-  pg_stat_user_tables
-ORDER BY seq_scan DESC;
-EOS
-  end
-end