rails-pg-extras 3.1.0 → 3.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 72d0aaefc019490d3c298c7114d34fc55cc0f0b236f5edf8710a4bed290d96a5
-  data.tar.gz: bdcce61d6e4436aa74ca098c44d5e480c9a010aa246a375cf57be514e4c10c73
+  metadata.gz: 2c0a85db31ea8aee2a8c78dd5fa564d02f6a20be8ed2a98140cd9973fde8e9e9
+  data.tar.gz: 93a1281cc97ac17c82444302e26dace96cecb1ce0bc5b2ed2a03a5f0d3c91058
 SHA512:
-  metadata.gz: 3004a52e1219060a9f82e7a84028a1ee042fa95b9ef3320f9f093bf1fc3909586ac1fc0f33fb75c417df1ddec6bbef6f31d2a1ebfd6fe71d99d7d8f2ff09e266
-  data.tar.gz: 48cc602df378555e04ec157afdb447d702c8dfc26efb155dba6c35da221ca38c079c226997bf0fe1ea471c819d56e4612adddf410e0cdeaf48169ac828273a1d
+  metadata.gz: 84f337ffd1691a0051de367bc4c41a2538e8122cff8d07b112689d1110341ff4f5f4f48359e1354f4429649a2e9a4dded97b278824970758f4de3c73cac5a0a0
+  data.tar.gz: 71dd10a03afd078939382510f2e13fef4376d8c49ff4aa46a4a0d851134eb3dbc1372f83ca40694c5f794c9a233c7fa764f37f770b3c4e2b1c3192f7ede8093e

data/README.md

@@ -113,6 +113,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
+RailsPGExtras.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
+
+RailsPGExtras.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/rails-pg-extras/index_info.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module RailsPGExtras
+  class IndexInfo < RubyPGExtras::IndexInfo
+    private
+
+    def query_module
+      RailsPGExtras
+    end
+  end
+end

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

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module RailsPGExtras
+  class IndexInfoPrint < RubyPGExtras::IndexInfoPrint
+  end
+end

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

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module RailsPGExtras
+  class TableInfo < RubyPGExtras::TableInfo
+    private
+
+    def query_module
+      RailsPGExtras
+    end
+  end
+end

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

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module RailsPGExtras
+  class TableInfoPrint < RubyPGExtras::TableInfoPrint
+  end
+end

data/lib/rails-pg-extras/tasks/all.rake

@@ -24,4 +24,14 @@ namespace :pg_extras do
   task diagnose: :establish_connection do
     RailsPGExtras.diagnose
   end
+
+  desc "Display tables metadata metrics"
+  task table_info: :establish_connection do
+    RailsPGExtras.table_info
+  end
+
+  desc "Display indexes metadata metrics"
+  task index_info: :establish_connection do
+    RailsPGExtras.index_info
+  end
 end

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

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

data/lib/rails-pg-extras.rb

@@ -4,6 +4,10 @@ require 'terminal-table'
 require 'ruby-pg-extras'
 require 'rails-pg-extras/diagnose_data'
 require 'rails-pg-extras/diagnose_print'
+require 'rails-pg-extras/index_info'
+require 'rails-pg-extras/index_info_print'
+require 'rails-pg-extras/table_info'
+require 'rails-pg-extras/table_info_print'
 
 module RailsPGExtras
   QUERIES = RubyPGExtras::QUERIES
@@ -58,6 +62,34 @@ module RailsPGExtras
     end
   end
 
+  def self.index_info(args: {}, in_format: :display_table)
+    data = RailsPGExtras::IndexInfo.call(args[:table_name])
+
+    if in_format == :display_table
+      RailsPGExtras::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 = RailsPGExtras::TableInfo.call(args[:table_name])
+
+    if in_format == :display_table
+      RailsPGExtras::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.connection
     ActiveRecord::Base.connection
   end

data/spec/smoke_spec.rb

@@ -13,4 +13,18 @@ describe RailsPGExtras do
       end.not_to raise_error
     end
   end
+
+  it "runs the custom methods" do
+    expect do
+      RailsPGExtras.diagnose(in_format: :hash)
+    end.not_to raise_error
+
+    expect do
+      RailsPGExtras.index_info(in_format: :hash)
+    end.not_to raise_error
+
+    expect do
+      RailsPGExtras.table_info(in_format: :hash)
+    end.not_to raise_error
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails-pg-extras
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.2.5
 platform: ruby
 authors:
 - pawurb
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-10-29 00:00:00.000000000 Z
+date: 2021-12-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-pg-extras
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: 3.2.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: 3.2.5
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
@@ -85,7 +85,11 @@ files:
 - lib/rails-pg-extras.rb
 - lib/rails-pg-extras/diagnose_data.rb
 - lib/rails-pg-extras/diagnose_print.rb
+- lib/rails-pg-extras/index_info.rb
+- lib/rails-pg-extras/index_info_print.rb
 - lib/rails-pg-extras/railtie.rb
+- lib/rails-pg-extras/table_info.rb
+- lib/rails-pg-extras/table_info_print.rb
 - lib/rails-pg-extras/tasks/all.rake
 - lib/rails-pg-extras/version.rb
 - rails-pg-extras-diagnose.png
@@ -112,7 +116,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.0.3
 signing_key:
 specification_version: 4
 summary: Rails PostgreSQL performance database insights