ruby-pg-extras 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 943bbbbd7e2de25570164a5bbd5e6015708ca2f808e7f0b25523a4125ad1bbf0
-  data.tar.gz: dd4e28f9900f2b50eae39232828c47ebb7c6b57dbb9ca4042be074cda1214e75
+  metadata.gz: 741b8ec49ba2e7b4933ddbe085bd3c4f90ab1640e951fdec1dfa1178c4bf8ab0
+  data.tar.gz: d1b7d405ef8da4bcd450e461a6ff4411b760128bd22e660c1dc102aaa1cf9453
 SHA512:
-  metadata.gz: 12dd59913848f989fe6c186fefcdeb6418ab41cd6082b65f072b48d7d961e5d43b5c41822f8527bfda64e4557d284d52e74c0c3bd6dc1ca722fc958fa77d6b2a
-  data.tar.gz: 6c2d5445c0acb5eb93f614f778464c1059807112ca310efac9f135ca025985783ee553b7dca99e269d932a7d447c736011b54e791897e7e8671832492ee87add
+  metadata.gz: ce5011d3e926a7b1a246b6268d7d58a8f05f26bbab22bd665209daec81f4d03867b78c8306f6d3ebd4661acc1ae96640427ea33486d3ab6f91b1716c20b11cc1
+  data.tar.gz: 1cee23d5f7e171bdd13eeea76102a59ff1ad6774a9b1c80b614e76e9d4a60d4b76b098403fd69e7e5913c001d98e0b4792fc1f58762234d0b10af7cbd6a1ef6e

data/README.md

@@ -351,6 +351,22 @@ RubyPGExtras.unused_indexes(args: { min_scans: 20 })
 
 This command displays indexes that have < 50 scans recorded against them, and are greater than 5 pages in size, ordered by size relative to the number of index scans. This command is generally useful for eliminating indexes that are unused, which can impact write performance, as well as read performance should they occupy space in memory.
 
+### `null_indexes`
+
+```ruby
+
+RubyPGExtras.null_indexes
+
+   oid   |         index      | index_size | unique | indexed_column | null_frac | expected_saving
+---------+--------------------+------------+--------+----------------+-----------+-----------------
+  183764 | users_reset_token  | 1418 MB    | t      | reset_token    |   96.15%  | 1363 MB
+   88732 | plan_cancelled_at  | 1651 MB    | f      | cancelled_at   |    6.11%  | 101 MB
+ 9827345 | users_email        | 22 MB      | t      | email          |   11.21%  | 2494 kB
+
+```
+
+This commands displays indexes that contain `NULL` values. A high ratio of `NULL` values means that using a partial index excluding them will be beneficial in case they are not used for searching. [Source and more info](https://hakibenita.com/postgresql-unused-index-size).
+
 ### `seq_scans`
 
 ```ruby

data/lib/ruby-pg-extras.rb

@@ -10,7 +10,7 @@ module RubyPGExtras
   QUERIES = %i(
     bloat blocking cache_hit
     calls extensions table_cache_hit index_cache_hit
-    index_size index_usage locks all_locks
+    index_size index_usage null_indexes locks all_locks
     long_running_queries mandelbrot outliers
     records_rank seq_scans table_indexes_size
     table_size total_index_size total_table_size

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

@@ -0,0 +1,32 @@
+/* Find indexed columns with high null_frac */
+SELECT
+    c.oid,
+    c.relname AS index,
+    pg_size_pretty(pg_relation_size(c.oid)) AS index_size,
+    i.indisunique AS unique,
+    a.attname AS indexed_column,
+    CASE s.null_frac
+        WHEN 0 THEN ''
+        ELSE to_char(s.null_frac * 100, '999.00%')
+    END AS null_frac,
+    pg_size_pretty((pg_relation_size(c.oid) * s.null_frac)::bigint) AS expected_saving
+FROM
+    pg_class c
+    JOIN pg_index i ON i.indexrelid = c.oid
+    JOIN pg_attribute a ON a.attrelid = c.oid
+    JOIN pg_class c_table ON c_table.oid = i.indrelid
+    JOIN pg_indexes ixs ON c.relname = ixs.indexname
+    LEFT JOIN pg_stats s ON s.tablename = c_table.relname AND a.attname = s.attname
+WHERE
+    -- Primary key cannot be partial
+    NOT i.indisprimary
+    -- Exclude already partial indexes
+    AND i.indpred IS NULL
+    -- Exclude composite indexes
+    AND array_length(i.indkey, 1) = 1
+    -- Exclude indexes without null_frac ratio
+    AND coalesce(s.null_frac, 0) != 0
+    -- Larger than 10MB
+    AND pg_relation_size(c.oid) > 10 * 1024 ^ 2
+ORDER BY
+  pg_relation_size(c.oid) * s.null_frac DESC;

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

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-pg-extras
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - pawurb
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-01-26 00:00:00.000000000 Z
+date: 2021-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pg
@@ -96,6 +96,7 @@ files:
 - lib/ruby-pg-extras/queries/locks.sql
 - lib/ruby-pg-extras/queries/long_running_queries.sql
 - lib/ruby-pg-extras/queries/mandelbrot.sql
+- lib/ruby-pg-extras/queries/null_indexes.sql
 - lib/ruby-pg-extras/queries/outliers.sql
 - lib/ruby-pg-extras/queries/records_rank.sql
 - lib/ruby-pg-extras/queries/seq_scans.sql