ruby-pg-extras 3.2.3 → 3.2.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f1b62064eec105b0cc3efab13c7cb11bbe0421e3cda0bf6f6cd21fdb2fb48a3a
-  data.tar.gz: e264e506bdbf0d3a782fd23437dd512f981782355521e6d83904750ede326011
+  metadata.gz: 6f995f931c2dc41eaf38f0a9618aa591b351c953bc5f2c5c33381e3180137291
+  data.tar.gz: 1a0bd0e16237505d6f5bc6a1d7f99be0b09e4dc0985076c61d3295fe6edcbca0
 SHA512:
-  metadata.gz: 28c5d62d95d875b4a879598fe1d02695877f7d87614c2f8d93cc35b5cfb96b80cf29b640a45034c393e89cdaf795da2dc9cd5ed934b073892c6f687609fc4027
-  data.tar.gz: f0215c2441ef1d2f05b8ecdeff8cb80dce3cfdb9e4dc2a699368b06ed88aba980dadc749ca562fd93118c50250e8bc69827e8ea8412c7afa60897b50e93e4a8e
+  metadata.gz: ecde58728d9d1929477a994d28b318bc978dfd645d853628ac31f6ba88ec2189fb50749b71dae5021f42aa0925c77eb1712013ce07715352ca42526b6d9d8b40
+  data.tar.gz: 0d106567d3f9bdb9f0c691a0d4dcf1eb7ca53b4baffb823140648322b49a5b26ecaacdd6c70e9aaffa686f225db04b75cd101e90035a83919cd45c2af4a9fbf8

data/README.md

@@ -112,6 +112,38 @@ Keep reading to learn about methods that `diagnose` uses under the hood.
 
 ## Available methods
 
+### `table_info`
+
+This method displays metadata metrics for all or a selected table. You can use it to check the table's size, its cache hit metrics, and whether it is correctly indexed. Many sequential scans or no index scans are potential indicators of misconfigured indexes. This method aggregates data provided by other methods in an easy to analyze summary format.
+
+```ruby
+RubyPGExtras.table_info(args: { table_name: "users" })
+
+| Table name | Table size | Table cache hit   | Indexes cache hit  | Estimated rows | Sequential scans | Indexes scans |
++------------+------------+-------------------+--------------------+----------------+------------------+---------------+
+| users      | 2432 kB    | 0.999966685701511 | 0.9988780464661853 | 16650          | 2128             | 512496        |
+
+```
+
+### `index_info`
+
+This method returns summary info about database indexes. You can check index size, how often it is used and what percentage of its total size are NULL values. Like the previous method, it aggregates data from other helper methods in an easy-to-digest format.
+
+```ruby
+
+RubyPGExtras.index_info(args: { table_name: "users" })
+
+| Index name                    | Table name | Columns        | Index size | Index scans | Null frac |
++-------------------------------+------------+----------------+------------+-------------+-----------+
+| users_pkey                    | users      | id             | 1152 kB    | 163007      | 0.00%     |
+| index_users_on_slack_id       | users      | slack_id       | 1080 kB    | 258870      | 0.00%     |
+| index_users_on_team_id        | users      | team_id        | 816 kB     | 70962       | 0.00%     |
+| index_users_on_uuid           | users      | uuid           | 1032 kB    | 0           | 0.00%     |
+| index_users_on_block_uuid     | users      | block_uuid     | 776 kB     | 19502       | 100.00%   |
+| index_users_on_api_auth_token | users      | api_auth_token | 1744 kB    | 156         | 0.00%     |
+
+```
+
 ### `cache_hit`
 
 ```ruby

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

@@ -118,7 +118,7 @@ module RubyPGExtras
         in_format: :hash,
         args: { min_scans: PG_EXTRAS_UNUSED_INDEXES_MAX_SCANS }
       ).select do |i|
-        Filesize.from(i.fetch("index_size")).to_i >= PG_EXTRAS_UNUSED_INDEXES_MIN_SIZE_BYTES
+        Filesize.from(i.fetch("index_size").sub("bytes", "").strip).to_i >= PG_EXTRAS_UNUSED_INDEXES_MIN_SIZE_BYTES
       end
 
       if indexes.count == 0

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

@@ -28,7 +28,7 @@ module RubyPGExtras
           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").strip || "0.00%"
+          end&.fetch("null_frac", "N/A")&.strip || "0.00%"
         }
       end
     end

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

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

data/ruby-pg-extras.gemspec

@@ -3,21 +3,25 @@ lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'ruby-pg-extras/version'
 
-Gem::Specification.new do |gem|
-  gem.name          = "ruby-pg-extras"
-  gem.version       = RubyPGExtras::VERSION
-  gem.authors       = ["pawurb"]
-  gem.email         = ["contact@pawelurbanek.com"]
-  gem.summary       = %q{ Ruby PostgreSQL performance database insights }
-  gem.description   = %q{ Ruby 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/ruby-pg-extras"
-  gem.files         = `git ls-files`.split("\n")
-  gem.test_files    = gem.files.grep(%r{^(spec)/})
-  gem.require_paths = ["lib"]
-  gem.license       = "MIT"
-  gem.add_dependency "pg"
-  gem.add_dependency "filesize"
-  gem.add_dependency "terminal-table"
-  gem.add_development_dependency "rake"
-  gem.add_development_dependency "rspec"
+Gem::Specification.new do |s|
+  s.name          = "ruby-pg-extras"
+  s.version       = RubyPGExtras::VERSION
+  s.authors       = ["pawurb"]
+  s.email         = ["contact@pawelurbanek.com"]
+  s.summary       = %q{ Ruby PostgreSQL performance database insights }
+  s.description   = %q{ Ruby 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. }
+  s.homepage      = "http://github.com/pawurb/ruby-pg-extras"
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = s.files.grep(%r{^(spec)/})
+  s.require_paths = ["lib"]
+  s.license       = "MIT"
+  s.add_dependency "pg"
+  s.add_dependency "filesize"
+  s.add_dependency "terminal-table"
+  s.add_development_dependency "rake"
+  s.add_development_dependency "rspec"
+
+  if s.respond_to?(:metadata=)
+    s.metadata = { "rubygems_mfa_required" => "true" }
+  end
 end

data/spec/diagnose_data_spec.rb

@@ -13,7 +13,7 @@ describe RubyPGExtras::DiagnoseData do
         expect(RubyPGExtras).to receive(:unused_indexes) {
           [
             { "table" => "public.plans", "index" => "index_plans_on_payer_id", "index_size" => "16 MB", "index_scans" => 0 },
-            { "table" => "public.feedbacks", "index" => "index_feedbacks_on_target_id", "index_size" => "80 kB", "index_scans" => 1 },
+            { "table" => "public.feedbacks", "index" => "index_feedbacks_on_target_id", "index_size" => "111180 bytes", "index_scans" => 1 },
             { "table" => "public.channels", "index" => "index_channels_on_slack_id", "index_size" => "56 MB", "index_scans" => 7}
           ]
         }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-pg-extras
 version: !ruby/object:Gem::Version
-  version: 3.2.3
+  version: 3.2.7
 platform: ruby
 authors:
 - pawurb
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-12-18 00:00:00.000000000 Z
+date: 2022-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pg
@@ -152,8 +152,9 @@ files:
 homepage: http://github.com/pawurb/ruby-pg-extras
 licenses:
 - MIT
-metadata: {}
-post_install_message:
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -169,7 +170,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.6
-signing_key:
+signing_key: 
 specification_version: 4
 summary: Ruby PostgreSQL performance database insights
 test_files: