ruby-pg-extras 3.1.0 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1b09fa8f29c8e1b0438acf8834d8d51e4ab76b2b8c4c7475e7ac82902d9bc29d
-  data.tar.gz: 5a18583d3576f515ea05e0a5d74180c11d811a44d5ecca9d5bad001540f28a98
+  metadata.gz: 3fd26a79ff47d4681d4e39888c8f1b362ff2c585c526c06b779e0fd84c3bdd7b
+  data.tar.gz: c516bc6586e939a6bdf9c815823094a1e1b92ef30c3dcf7064eb9a2b3394a845
 SHA512:
-  metadata.gz: 3a24a0a49e083f081d0d023f4f1b05d3fa867ef5b362f99eb6bc3c711616b857c5f434e5c23ffcc2ba42a0890f562f553694cb45434fa5484402569a827fe1fa
-  data.tar.gz: c50dd6d08c4e470a53257af9a7092271a6abeaab308579dc579efcd7df39e9b42031cc01f3d627225fcc73a26bb5c3253a6fe2c94ccc19812fc9671d88936a9b
+  metadata.gz: ecc8790295246456eb2ff3bd7025a08ed0a44b435bcf2af7070b35e2f081eeb302061e976a96d0ef5ef21422168637053fed1931687ec96d44e64f457ec21f51
+  data.tar.gz: 4a87d50af4289473bbf40bfe1dfae20bb214feca969ff56b34b3f27ba9321b28c3415443c3374970747877e3d5b3c14c0780e4e3108cdbf757eb1e0426c088d8

data/lib/ruby-pg-extras/index_info.rb

@@ -0,0 +1,58 @@
+module RubyPGExtras
+  class IndexInfo
+    def self.call(table_name = nil)
+      new.call(table_name)
+    end
+
+    def call(table_name = nil)
+      indexes_data.select do |index_data|
+        if table_name == nil
+          true
+        else
+          index_data.fetch("tablename") == table_name
+        end
+      end.map do |index_data|
+        index_name = index_data.fetch("indexname")
+        {
+          index_name: index_data.fetch("indexname"),
+          table_name: index_data.fetch("tablename"),
+          columns: index_data.fetch("columns").split(',').map(&:strip),
+          index_size: index_size_data.find do |el|
+            el.fetch("name") == index_name
+          end.fetch("size", "N/A"),
+          index_scans:  index_scans_data.find do |el|
+            el.fetch("index") == index_name
+          end.fetch("index_scans", "N/A"),
+          null_frac: null_indexes_data.find do |el|
+            el.fetch("index") == index_name
+          end&.fetch("null_frac", "N/A") || "0.00%"
+        }
+      end
+    end
+
+    def index_size_data
+      @_index_size_data ||= query_module.index_size(in_format: :hash)
+    end
+
+    def null_indexes_data
+      @_null_indexes_data ||= query_module.null_indexes(
+        in_format: :hash,
+        args: { min_relation_size_mb: 0 }
+      )
+    end
+
+    def index_scans_data
+      @_index_scans_data ||= query_module.index_scans(in_format: :hash)
+    end
+
+    def indexes_data
+      @_indexes_data ||= query_module.indexes(in_format: :hash)
+    end
+
+    private
+
+    def query_module
+      RubyPGExtras
+    end
+  end
+end

data/lib/ruby-pg-extras/index_info_print.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require 'terminal-table'
+
+module RubyPGExtras
+  class IndexInfoPrint
+    def self.call(data)
+      new.call(data)
+    end
+
+    def call(data)
+      rows = data.map do |el|
+        [
+          el.fetch(:index_name),
+          el.fetch(:table_name),
+          el.fetch(:columns).join(', '),
+          el.fetch(:index_size),
+          el.fetch(:index_scans),
+          el.fetch(:null_frac)
+        ]
+      end
+
+      puts Terminal::Table.new(
+        headings: [
+          "Index name",
+          "Table name",
+          "Columns",
+          "Index size",
+          "Index scans",
+          "Null frac"
+        ],
+        title: title,
+        rows: rows
+      )
+    end
+
+    private
+
+    def title
+      "Index info"
+    end
+  end
+end

data/lib/ruby-pg-extras/queries/index_scans.sql

@@ -0,0 +1,12 @@
+/* Number of scans performed on indexes */
+
+SELECT
+  schemaname,
+  relname AS table,
+  indexrelname AS index,
+  pg_size_pretty(pg_relation_size(i.indexrelid)) AS index_size,
+  idx_scan as index_scans
+FROM pg_stat_user_indexes ui
+JOIN pg_index i ON ui.indexrelid = i.indexrelid
+ORDER BY pg_relation_size(i.indexrelid) / nullif(idx_scan, 0) DESC NULLS FIRST,
+pg_relation_size(i.indexrelid) DESC;

data/lib/ruby-pg-extras/queries/indexes.sql

@@ -0,0 +1,9 @@
+/* List all the indexes with their corresponding tables and columns. */
+
+SELECT
+  schemaname,
+  indexname,
+  tablename,
+  rtrim(split_part(indexdef, '(', 2), ')') as columns
+FROM pg_indexes
+where tablename in (select relname from pg_statio_user_tables);

data/lib/ruby-pg-extras/queries/table_index_scans.sql

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

data/lib/ruby-pg-extras/queries/tables.sql

@@ -0,0 +1,3 @@
+/* List all the tables. */
+
+select relname as tablename, schemaname from pg_statio_user_tables;

data/lib/ruby-pg-extras/table_info.rb

@@ -0,0 +1,75 @@
+module RubyPGExtras
+  class TableInfo
+    def self.call(table_name = nil)
+      new.call(table_name)
+    end
+
+    def call(table_name)
+      tables_data.select do |table_data|
+        if table_name == nil
+          true
+        else
+          table_data.fetch("tablename") == table_name
+        end
+      end.map do |table_data|
+        table_name = table_data.fetch("tablename")
+
+        {
+          table_name: table_name,
+          table_size: table_size_data.find do |el|
+            el.fetch("name") == table_name
+          end.fetch("size", "N/A"),
+          table_cache_hit: table_cache_hit_data.find do |el|
+            el.fetch("name") == table_name
+          end.fetch("ratio", "N/A"),
+          indexes_cache_hit: index_cache_hit_data.find do |el|
+            el.fetch("name") == table_name
+          end.fetch("ratio", "N/A"),
+          estimated_rows: records_rank_data.find do |el|
+            el.fetch("name") == table_name
+          end.fetch("estimated_count", "N/A"),
+          sequential_scans: seq_scans_data.find do |el|
+            el.fetch("name") == table_name
+          end.fetch("count", "N/A"),
+          indexes_scans: table_index_scans_data.find do |el|
+            el.fetch("name") == table_name
+          end.fetch("count", "N/A")
+        }
+      end
+    end
+
+    private
+
+    def index_cache_hit_data
+      @_index_cache_hit_data ||= query_module.index_cache_hit(in_format: :hash)
+    end
+
+    def table_cache_hit_data
+      @_table_cache_hit_data ||= query_module.table_cache_hit(in_format: :hash)
+    end
+
+    def table_size_data
+      @_table_size_data ||= query_module.table_size(in_format: :hash)
+    end
+
+    def records_rank_data
+      @_records_rank_data ||= query_module.records_rank(in_format: :hash)
+    end
+
+    def tables_data
+      @_tables_data ||= query_module.tables(in_format: :hash)
+    end
+
+    def seq_scans_data
+      @_seq_scans_data ||= query_module.seq_scans(in_format: :hash)
+    end
+
+    def table_index_scans_data
+      @_table_index_scans_data ||= query_module.table_index_scans(in_format: :hash)
+    end
+
+    def query_module
+      RubyPGExtras
+    end
+  end
+end

data/lib/ruby-pg-extras/table_info_print.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require 'terminal-table'
+
+module RubyPGExtras
+  class TableInfoPrint
+    def self.call(data)
+      new.call(data)
+    end
+
+    def call(data)
+      rows = data.map do |el|
+        [
+          el.fetch(:table_name),
+          el.fetch(:table_size),
+          el.fetch(:table_cache_hit),
+          el.fetch(:indexes_cache_hit),
+          el.fetch(:estimated_rows),
+          el.fetch(:sequential_scans),
+          el.fetch(:indexes_scans)
+        ]
+      end
+
+      puts Terminal::Table.new(
+        headings: [
+          "Table name",
+          "Table size",
+          "Table cache hit",
+          "Indexes cache hit",
+          "Estimated rows",
+          "Sequentail scans",
+          "Indexes scans"
+        ],
+        title: title,
+        rows: rows
+      )
+    end
+
+    private
+
+    def title
+      "Table info"
+    end
+  end
+end

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

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RubyPGExtras
-  VERSION = "3.1.0"
+  VERSION = "3.2.0"
 end

data/lib/ruby-pg-extras.rb

@@ -5,6 +5,10 @@ require 'uri'
 require 'pg'
 require 'ruby-pg-extras/diagnose_data'
 require 'ruby-pg-extras/diagnose_print'
+require 'ruby-pg-extras/index_info'
+require 'ruby-pg-extras/index_info_print'
+require 'ruby-pg-extras/table_info'
+require 'ruby-pg-extras/table_info_print'
 
 module RubyPGExtras
   @@database_url = nil
@@ -12,10 +16,10 @@ module RubyPGExtras
 
   QUERIES = %i(
     add_extensions bloat blocking cache_hit db_settings
-    calls extensions table_cache_hit index_cache_hit
-    index_size index_usage null_indexes locks all_locks
+    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_indexes_size
+    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
     pg_stat_statements_reset buffercache_stats
@@ -83,6 +87,34 @@ module RubyPGExtras
     end
   end
 
+  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
+
+  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
+
   def self.display_result(result, title:, in_format:)
     case in_format
     when :array

data/spec/diagnose_data_spec.rb

@@ -20,9 +20,9 @@ describe RubyPGExtras::DiagnoseData do
 
         expect(RubyPGExtras).to receive(:null_indexes) {
           [
-            { "oid" => 123, "index" => "index_plans_on_payer_id", "index_size" => "16 MB", "unique" => "t", "null_frac" => "00.00%", "expected_saving" => "0 kb" },
-            { "oid" => 321, "index" => "index_feedbacks_on_target_id", "index_size" => "80 kB", "unique" => "f", "null_frac" => "97.00%", "expected_saving" => "77 kb" },
-            { "oid" => 231, "index" => "index_channels_on_slack_id", "index_size" => "56 MB", "unique" => "t", "null_frac" => "49.99%", "expected_saving" => "28 MB" }
+            { "oid" => 123, "index" => "index_plans_on_payer_id", "index_size" => "16 MB", "unique" => true, "null_frac" => "00.00%", "expected_saving" => "0 kb" },
+            { "oid" => 321, "index" => "index_feedbacks_on_target_id", "index_size" => "80 kB", "unique" => true, "null_frac" => "97.00%", "expected_saving" => "77 kb" },
+            { "oid" => 231, "index" => "index_channels_on_slack_id", "index_size" => "56 MB", "unique" => true, "null_frac" => "49.99%", "expected_saving" => "28 MB" }
           ]
         }
 
@@ -55,17 +55,6 @@ describe RubyPGExtras::DiagnoseData do
     end
 
     context "real database data" do
-      before do
-        expect(RubyPGExtras).to receive(:unused_indexes) {
-          [
-            { "table" => "public.plans", "index" => "index_plans_on_payer_id", "index_size" => "2 MB", "index_scans" => 0 },
-            { "table" => "public.feedbacks", "index" => "index_feedbacks_on_target_id", "index_size" => "80 kB", "index_scans" => 1 },
-            { "table" => "public.channels", "index" => "index_channels_on_slack_id", "index_size" => "1.1 MB", "index_scans" => 7}
-          ]
-        }
-
-      end
-
       it "works" do
         expect {
           RubyPGExtras::DiagnosePrint.call(result)

data/spec/index_info_spec.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe RubyPGExtras::IndexInfo do
+  subject(:result) do
+    RubyPGExtras::IndexInfo.call
+  end
+
+  describe "call" do
+    context "stubbed cases" do
+      before do
+        expect(RubyPGExtras).to receive(:indexes) {
+          [
+            { "schemaname" => "public", "indexname" => "index_users_on_api_auth_token", "tablename" => "users", "columns" => "api_auth_token, column2" },
+            {"schemaname" => "public", "indexname" => "index_teams_on_slack_id", "tablename" => "teams", "columns" => "slack_id" },
+          ]
+        }
+
+        expect(RubyPGExtras).to receive(:index_size) {
+          [
+            { "name" => "index_users_on_api_auth_token", "size" => "1744 kB" },
+            {"name" => "index_teams_on_slack_id", "size" => "500 kB"},
+          ]
+        }
+
+        expect(RubyPGExtras).to receive(:null_indexes) {
+          [
+            { "oid" => 16803, "index" => "index_users_on_api_auth_token", "index_size" => "1744 kB", "unique"=>true, "indexed_column" => "api_auth_token", "null_frac" => "25.00%", "expected_saving" => "300 kB" }
+          ]
+        }
+
+        expect(RubyPGExtras).to receive(:index_scans) {
+          [
+            { "schemaname" => "public", "table" => "users", "index" => "index_users_on_api_auth_token", "index_size" => "1744 kB", "index_scans"=> 0 },
+            { "schemaname" => "public", "table" => "teams", "index" => "index_teams_on_slack_id", "index_size" => "500 kB", "index_scans"=> 0 }
+          ]
+        }
+      end
+
+      it "works" do
+        expect {
+          RubyPGExtras::IndexInfoPrint.call(result)
+        }.not_to raise_error
+      end
+    end
+
+    context "real data" do
+      it "works" do
+        expect {
+          RubyPGExtras::IndexInfoPrint.call(result)
+        }.not_to raise_error
+      end
+    end
+  end
+end

data/spec/table_info_spec.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe RubyPGExtras::TableInfo do
+  subject(:result) do
+    RubyPGExtras::TableInfo.call
+  end
+
+  describe "call" do
+    context "stubbed cases" do
+      before do
+        expect(RubyPGExtras).to receive(:tables) {
+          [
+            { "schemaname" => "public", "tablename" => "users" },
+            { "schemaname" => "public", "tablename" => "teams" }
+          ]
+        }
+
+        expect(RubyPGExtras).to receive(:table_size) {
+          [
+            { "name" => "teams", "size" => "25 MB" },
+            {"name" => "users", "size" => "250 MB"},
+          ]
+        }
+
+        expect(RubyPGExtras).to receive(:index_cache_hit) {
+          [
+            { "name" => "teams", "ratio" => "0.98" },
+            { "name" => "users", "ratio" => "0.999" },
+          ]
+        }
+
+        expect(RubyPGExtras).to receive(:table_cache_hit) {
+          [
+            { "name" => "teams", "ratio" => "0.88" },
+            { "name" => "users", "ratio" => "0.899" },
+          ]
+        }
+
+        expect(RubyPGExtras).to receive(:records_rank) {
+          [
+            { "name" => "teams", "estimated_count" => "358" },
+            { "name" => "users", "estimated_count" => "8973" },
+          ]
+        }
+
+        expect(RubyPGExtras).to receive(:seq_scans) {
+          [
+            { "name" => "teams", "count" => "0" },
+            { "name" => "users", "count" => "409328" },
+          ]
+        }
+
+        expect(RubyPGExtras).to receive(:table_index_scans) {
+          [
+            { "name" => "teams", "count" => "8579" },
+            { "name" => "users", "count" => "0" },
+          ]
+        }
+      end
+
+      it "works" do
+        expect {
+          RubyPGExtras::TableInfoPrint.call(result)
+        }.not_to raise_error
+      end
+    end
+
+    context "real data" do
+      it "works" do
+        expect {
+          RubyPGExtras::TableInfoPrint.call(result)
+        }.not_to raise_error
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-pg-extras
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.2.0
 platform: ruby
 authors:
 - pawurb
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-10-29 00:00:00.000000000 Z
+date: 2021-12-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pg
@@ -99,6 +99,8 @@ files:
 - lib/ruby-pg-extras.rb
 - lib/ruby-pg-extras/diagnose_data.rb
 - lib/ruby-pg-extras/diagnose_print.rb
+- lib/ruby-pg-extras/index_info.rb
+- lib/ruby-pg-extras/index_info_print.rb
 - lib/ruby-pg-extras/queries/add_extensions.sql
 - lib/ruby-pg-extras/queries/all_locks.sql
 - lib/ruby-pg-extras/queries/bloat.sql
@@ -112,8 +114,10 @@ files:
 - lib/ruby-pg-extras/queries/duplicate_indexes.sql
 - lib/ruby-pg-extras/queries/extensions.sql
 - lib/ruby-pg-extras/queries/index_cache_hit.sql
+- lib/ruby-pg-extras/queries/index_scans.sql
 - lib/ruby-pg-extras/queries/index_size.sql
 - lib/ruby-pg-extras/queries/index_usage.sql
+- lib/ruby-pg-extras/queries/indexes.sql
 - lib/ruby-pg-extras/queries/kill_all.sql
 - lib/ruby-pg-extras/queries/locks.sql
 - lib/ruby-pg-extras/queries/long_running_queries.sql
@@ -126,19 +130,25 @@ files:
 - lib/ruby-pg-extras/queries/seq_scans.sql
 - lib/ruby-pg-extras/queries/ssl_used.sql
 - lib/ruby-pg-extras/queries/table_cache_hit.sql
+- lib/ruby-pg-extras/queries/table_index_scans.sql
 - lib/ruby-pg-extras/queries/table_indexes_size.sql
 - lib/ruby-pg-extras/queries/table_size.sql
+- lib/ruby-pg-extras/queries/tables.sql
 - lib/ruby-pg-extras/queries/total_index_size.sql
 - lib/ruby-pg-extras/queries/total_table_size.sql
 - lib/ruby-pg-extras/queries/unused_indexes.sql
 - lib/ruby-pg-extras/queries/vacuum_stats.sql
+- lib/ruby-pg-extras/table_info.rb
+- lib/ruby-pg-extras/table_info_print.rb
 - lib/ruby-pg-extras/version.rb
 - ruby-pg-extras-diagnose.png
 - ruby-pg-extras.gemspec
 - spec/diagnose_data_spec.rb
 - spec/diagnose_print_spec.rb
+- spec/index_info_spec.rb
 - spec/smoke_spec.rb
 - spec/spec_helper.rb
+- spec/table_info_spec.rb
 homepage: http://github.com/pawurb/ruby-pg-extras
 licenses:
 - MIT
@@ -165,5 +175,7 @@ summary: Ruby PostgreSQL performance database insights
 test_files:
 - spec/diagnose_data_spec.rb
 - spec/diagnose_print_spec.rb
+- spec/index_info_spec.rb
 - spec/smoke_spec.rb
 - spec/spec_helper.rb
+- spec/table_info_spec.rb