ruby-pg-extras 3.2.0 → 3.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3fd26a79ff47d4681d4e39888c8f1b362ff2c585c526c06b779e0fd84c3bdd7b
-  data.tar.gz: c516bc6586e939a6bdf9c815823094a1e1b92ef30c3dcf7064eb9a2b3394a845
+  metadata.gz: 297e1a74d8dc954314ed77c2da55a95747e33e0b5157c8371cc0f76efe6b9566
+  data.tar.gz: c11d9386d656671bf2adb0e15457df3cc6015104c6e6ba2e0634c67ee1fcbbe0
 SHA512:
-  metadata.gz: ecc8790295246456eb2ff3bd7025a08ed0a44b435bcf2af7070b35e2f081eeb302061e976a96d0ef5ef21422168637053fed1931687ec96d44e64f457ec21f51
-  data.tar.gz: 4a87d50af4289473bbf40bfe1dfae20bb214feca969ff56b34b3f27ba9321b28c3415443c3374970747877e3d5b3c14c0780e4e3108cdbf757eb1e0426c088d8
+  metadata.gz: 2e3891c10419e58bc53e47394c12032fbcce5fdb68ac82bc98e38c4b7f98a07087899bb83861b783de449fe03153d062eaf4a252db1a6939245889b1435c1bb8
+  data.tar.gz: 9dbdf383fa6b81dbdcc09e79e7e88660b4a3c802559525c99f41757b8e46a0061c896b213f0b0aa7910b570c313f717f449dbd20a1da81fe7478652f45fba5a8

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_print.rb

@@ -10,7 +10,6 @@ module RubyPGExtras
 
     def call(data)
       rows = data.sort do |el|
-        p el
         el.fetch(:ok) ? 1 : -1
       end.map do |el|
         symbol = el.fetch(:ok) ? "√" : "x"

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

@@ -11,10 +11,13 @@ module RubyPGExtras
         else
           index_data.fetch("tablename") == table_name
         end
+      end.sort_by do |index_data|
+        index_data.fetch("tablename")
       end.map do |index_data|
         index_name = index_data.fetch("indexname")
+
         {
-          index_name: index_data.fetch("indexname"),
+          index_name: index_name,
           table_name: index_data.fetch("tablename"),
           columns: index_data.fetch("columns").split(',').map(&:strip),
           index_size: index_size_data.find do |el|
@@ -25,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") || "0.00%"
+          end&.fetch("null_frac", "N/A")&.strip || "0.00%"
         }
       end
     end

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

@@ -11,6 +11,8 @@ module RubyPGExtras
         else
           table_data.fetch("tablename") == table_name
         end
+      end.sort_by do |table_data|
+        table_data.fetch("tablename")
       end.map do |table_data|
         table_name = table_data.fetch("tablename")
 

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

@@ -28,7 +28,7 @@ module RubyPGExtras
           "Table cache hit",
           "Indexes cache hit",
           "Estimated rows",
-          "Sequentail scans",
+          "Sequential scans",
           "Indexes scans"
         ],
         title: title,

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

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

data/lib/ruby-pg-extras.rb

@@ -87,7 +87,7 @@ module RubyPGExtras
     end
   end
 
-  def self.index_info(args:, in_format: :display_table)
+  def self.index_info(args: {}, in_format: :display_table)
     data = RubyPGExtras::IndexInfo.call(args[:table_name])
 
     if in_format == :display_table
@@ -101,7 +101,7 @@ module RubyPGExtras
     end
   end
 
-  def self.table_info(args:, in_format: :display_table)
+  def self.table_info(args: {}, in_format: :display_table)
     data = RubyPGExtras::TableInfo.call(args[:table_name])
 
     if in_format == :display_table

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-pg-extras
 version: !ruby/object:Gem::Version
-  version: 3.2.0
+  version: 3.2.4
 platform: ruby
 authors:
 - pawurb
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-12-15 00:00:00.000000000 Z
+date: 2021-12-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pg