rails-pg-extras 1.2.4 → 1.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 808e77df9b7f529b420f7a88775e90e031b055dd26804fd61a80b6fc2e8d96b7
-  data.tar.gz: '01853117599237d182f2edb901550cf52ba46691a98e1f8a1f2594f139b90e4b'
+  metadata.gz: 0322aaf3e072e39ad3174eb39bc66711c7738ad0e943aaac6056a4a42efa7368
+  data.tar.gz: 898d8e611d025487cf03c9ead7271427af08fb2604b35eab1c90e44b820e2769
 SHA512:
-  metadata.gz: e2d7d8a9558dea4637026b9c165942816c77527229172ca398c81ee0badc940e0c970f4049b2464d2aa667cef83ec43f11d8afd0c253203fda98b47f6703e87f
-  data.tar.gz: 7f4975baacf9d2822eeca20f260f03debec3dabb1e11544c48bf4b0a323393c8966a792b64e91777e95758c29cc69a1295660174195ddb66310c9601fd66d148
+  metadata.gz: 49e97a75d7af406f40f070b97890d2c9eedc1c759c9941991b545596d344b3af9a1adfa23daf86998992fb409618160474e6075b7d158a83ff9b2d3b37dc659d
+  data.tar.gz: fb1549df9972842ef573ca47d4eaf0b17722b054be82693110afdc0cb0972b59ba25148794c1f743fc1e26fb8abe65c70f135c2339a99ab4495a5680550544cb

data/.circleci/config.yml

@@ -16,6 +16,7 @@ jobs:
       - run: gem update --system
       - run: gem install bundler
       - run: bundle install --path vendor/bundle
+      - run: sudo apt-get update
       - run: sudo apt install postgresql-client
       - run: dockerize -wait tcp://localhost:5432 -timeout 1m
       - run:

data/README.md

@@ -16,6 +16,8 @@ Alternative versions:
 
 - [Python](https://github.com/pawurb/ecto_psql_extras)
 
+- [Haskell](https://github.com/pawurb/haskell-pg-extras)
+
 ## Installation
 
 In your Gemfile
@@ -76,11 +78,20 @@ RailsPGExtras.cache_hit(in_format: :raw) =>
  #<PG::Result:0x00007f75777f7328 status=PGRES_TUPLES_OK ntuples=2 nfields=2 cmd_tuples=2>
 ```
 
+Some methods accept an optional `args` param allowing you to customize queries:
+
+```ruby
+RailsPGExtras.long_running_queries(args: { threshold: "200 milliseconds" })
+
+```
+
 ## Available methods
 
 ### `cache_hit`
 
 ```
+RailsPGExtras.cache_hit
+
 $ rake pg_extras:cache_hit
 
       name      |         ratio
@@ -96,6 +107,8 @@ This command provides information on the efficiency of the buffer cache, for bot
 
 ```
 
+RailsPGExtras.index_cache_hit
+
 $ rake pg_extras:index_cache_hit
 
 | name                  | buffer_hits | block_reads | total_read | ratio             |
@@ -106,12 +119,14 @@ $ rake pg_extras:index_cache_hit
 (truncated results for brevity)
 ```
 
-The same as `cache_hit` with each table's indexes cache hit info displayed seperately.
+The same as `cache_hit` with each table's indexes cache hit info displayed separately.
 
 ### `table_cache_hit`
 
 ```
 
+RailsPGExtras.table_cache_hit
+
 $ rake pg_extras:table_cache_hit
 
 | name                  | buffer_hits | block_reads | total_read | ratio             |
@@ -127,6 +142,8 @@ The same as `cache_hit` with each table's cache hit info displayed seperately.
 ### `index_usage`
 
 ```
+RailsPGExtras.index_usage
+
 $ rake pg_extras:index_usage
 
        relname       | percent_of_times_index_used | rows_in_table
@@ -144,6 +161,8 @@ This command provides information on the efficiency of indexes, represented as w
 ### `locks`
 
 ```
+RailsPGExtras.locks
+
 $ rake pg_extras:locks
 
  procpid | relname | transactionid | granted |     query_snippet     | mode             |       age
@@ -157,11 +176,13 @@ $ rake pg_extras:locks
 (4 rows)
 ```
 
-This command displays queries that have taken out an exlusive lock on a relation. Exclusive locks typically prevent other operations on that relation from taking place, and can be a cause of "hung" queries that are waiting for a lock to be granted.
+This command displays queries that have taken out an exclusive lock on a relation. Exclusive locks typically prevent other operations on that relation from taking place, and can be a cause of "hung" queries that are waiting for a lock to be granted.
 
 ### `all_locks`
 
 ```
+RailsPGExtras.all_locks
+
 $ rake pg_extras:all_locks
 ```
 
@@ -170,6 +191,8 @@ This command displays all the current locks, regardless of their type.
 ### `outliers`
 
 ```
+RubyPGExtras.outliers(args: { limit: 20 })
+
 $ rake pg_extras:outliers
 
                    qry                   |    exec_time     | prop_exec_time |   ncalls    | sync_io_time
@@ -183,13 +206,15 @@ $ rake pg_extras:outliers
 (truncated results for brevity)
 ```
 
-This command displays statements, obtained from `pg_stat_statements`, ordered by the amount of time to execute in aggregate. This includes the statement itself, the total execution time for that statement, the proportion of total execution time for all statements that statement has taken up, the number of times that statement has been called, and the amount of time that statement spent on synchronous I/O (reading/writing from the filesystem).
+This command displays statements, obtained from `pg_stat_statements`, ordered by the amount of time to execute in aggregate. This includes the statement itself, the total execution time for that statement, the proportion of total execution time for all statements that statement has taken up, the number of times that statement has been called, and the amount of time that statement spent on synchronous I/O (reading/writing from the file system).
 
 Typically, an efficient query will have an appropriate ratio of calls to total execution time, with as little time spent on I/O as possible. Queries that have a high total execution time but low call count should be investigated to improve their performance. Queries that have a high proportion of execution time being spent on synchronous I/O should also be investigated.
 
 ### `calls`
 
 ```
+RubyPGExtras.calls(args: { limit: 10 })
+
 $ rake pg_extras:calls
 
                    qry                   |    exec_time     | prop_exec_time |   ncalls    | sync_io_time
@@ -207,6 +232,8 @@ This command is much like `pg:outliers`, but ordered by the number of times a st
 ### `blocking`
 
 ```
+RubyPGExtras.blocking
+
 $ rake pg_extras:blocking
 
  blocked_pid |    blocking_statement    | blocking_duration | blocking_pid |                                        blocked_statement                           | blocked_duration
@@ -220,6 +247,8 @@ This command displays statements that are currently holding locks that other sta
 #### `total_index_size`
 
 ```
+RubyPGExtras.total_index_size
+
 $ rake pg_extras:total_index_size
 
   size
@@ -233,6 +262,8 @@ This command displays the total size of all indexes on the database, in MB. It i
 ### `index_size`
 
 ```
+RubyPGExtras.index_size
+
 $ rake pg_extras:index_size
                              name                              |  size
 ---------------------------------------------------------------+---------
@@ -254,6 +285,8 @@ This command displays the size of each each index in the database, in MB. It is
 ### `table_size`
 
 ```
+RubyPGExtras.table_size
+
 $ rake pg_extras:table_size
 
                              name                              |  size
@@ -271,6 +304,8 @@ This command displays the size of each table and materialized view in the databa
 ### `table_indexes_size`
 
 ```
+RubyPGExtras.table_indexes_size
+
 $ rake pg_extras:table_indexes_size
 
                              table                             | indexes_size
@@ -283,11 +318,13 @@ $ rake pg_extras:table_indexes_size
 (truncated results for brevity)
 ```
 
-This command displays the total size of indexes for each table and materialized view, in MB. It is calcualtes by using the system administration function `pg_indexes_size()`.
+This command displays the total size of indexes for each table and materialized view, in MB. It is calculated by using the system administration function `pg_indexes_size()`.
 
 ### `total_table_size`
 
 ```
+RubyPGExtras.total_table_size
+
 $ rake pg_extras:total_table_size
 
                              name                              |  size
@@ -305,6 +342,8 @@ This command displays the total size of each table and materialized view in the
 ### `unused_indexes`
 
 ```
+RubyPGExtras.unused_indexes(args: { min_scans: 20 })
+
 $ rake pg_extras:unused_indexes
 
           table      |                       index                | index_size | index_scans
@@ -317,9 +356,29 @@ $ rake pg_extras:unused_indexes
 
 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
+
+RailsPGExtras.null_indexes(args: { min_relation_size_mb: 10 })
+
+$ rake pg_extras:null_indexes
+
+   oid   |         index      | index_size | unique | indexed_column | null_frac | expected_saving
+---------+--------------------+------------+--------+----------------+-----------+-----------------
+  183764 | users_reset_token  | 1445 MB    | t      | reset_token    |   97.00%  | 1401 MB
+   88732 | plan_cancelled_at  | 539 MB     | f      | cancelled_at   |    8.30%  | 44 MB
+ 9827345 | users_email        | 18 MB      | t      | email          |   28.67%  | 5160 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`
 
 ```
+RubyPGExtras.seq_scans
+
 $ rake pg_extras:seq_scans
 
                name                |  count
@@ -343,11 +402,13 @@ $ rake pg_extras:seq_scans
 (truncated results for brevity)
 ```
 
-This command displays the number of sequential scans recorded against all tables, descending by count of sequential scans. Tables that have very high numbers of sequential scans may be underindexed, and it may be worth investigating queries that read from these tables.
+This command displays the number of sequential scans recorded against all tables, descending by count of sequential scans. Tables that have very high numbers of sequential scans may be under-indexed, and it may be worth investigating queries that read from these tables.
 
 ### `long_running_queries`
 
 ```
+RubyPGExtras.long_running_queries(args: { threshold: "200 milliseconds" })
+
 $ rake pg_extras:long_running_queries
 
   pid  |    duration     |                                      query
@@ -363,6 +424,8 @@ This command displays currently running queries, that have been running for long
 ### `records_rank`
 
 ```
+RubyPGExtras.records_rank
+
 $ rake pg_extras:records_rank
 
                name                | estimated_count
@@ -381,6 +444,8 @@ This command displays an estimated count of rows per table, descending by estima
 ### `bloat`
 
 ```
+RubyPGExtras.bloat
+
 $ rake pg_extras:bloat
 
  type  | schemaname |           object_name         | bloat |   waste
@@ -398,6 +463,8 @@ This command displays an estimation of table "bloat" – space allocated to a re
 ### `vacuum_stats`
 
 ```
+RubyPGExtras.vacuum_stats
+
 $ rake pg_extras:vacuum_stats
 
  schema |         table         | last_vacuum | last_autovacuum  |    rowcount    | dead_rowcount  | autovacuum_threshold | expect_autovacuum
@@ -409,7 +476,7 @@ $ rake pg_extras:vacuum_stats
  (truncated results for brevity)
 ```
 
-This command displays statistics related to vacuum operations for each table, including an estiamtion of dead rows, last autovacuum and the current autovacuum threshold. This command can be useful when determining if current vacuum thresholds require adjustments, and to determine when the table was last vacuumed.
+This command displays statistics related to vacuum operations for each table, including an estimation of dead rows, last autovacuum and the current autovacuum threshold. This command can be useful when determining if current vacuum thresholds require adjustments, and to determine when the table was last vacuumed.
 
 ### `kill_all`
 
@@ -423,10 +490,15 @@ This commands kills all the currently active connections to the database. It can
 
 ### `extensions`
 
-```ruby
+```
 
 RailsPGExtras.extensions
 
+$ rake pg_extras:extensions
+
+| pg_stat_statements | 1.7 | 1.7 | track execution statistics of all SQL statements executed
+ (truncated results for brevity)
+
 ```
 
 This command lists all the currently installed and available PostgreSQL extensions.
@@ -434,6 +506,8 @@ This command lists all the currently installed and available PostgreSQL extensio
 ### mandelbrot
 
 ```
+RailsPGExtras.mandelbrot
+
 $ rake pg_extras:mandelbrot
 ```
 

data/lib/rails-pg-extras.rb

@@ -5,20 +5,26 @@ require 'ruby-pg-extras'
 
 module RailsPGExtras
   QUERIES = RubyPGExtras::QUERIES
+  DEFAULT_ARGS = RubyPGExtras::DEFAULT_ARGS
 
   QUERIES.each do |query_name|
-    define_singleton_method query_name do |options = { in_format: :display_table }|
+    define_singleton_method query_name do |options = {}|
       run_query(
         query_name: query_name,
-        in_format: options.fetch(:in_format)
+        in_format: options.fetch(:in_format, :display_table),
+        args: options.fetch(:args, {})
       )
     end
   end
 
-  def self.run_query(query_name:, in_format:)
-    result = connection.execute(
+  def self.run_query(query_name:, in_format:, args: {})
+    sql = if (custom_args = DEFAULT_ARGS[query_name].merge(args)) != {}
+      RubyPGExtras.sql_for(query_name: query_name) % custom_args
+    else
       RubyPGExtras.sql_for(query_name: query_name)
-    )
+    end
+
+    result = connection.execute(sql)
 
     RubyPGExtras.display_result(
       result,

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

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails-pg-extras
 version: !ruby/object:Gem::Version
-  version: 1.2.4
+  version: 1.5.1
 platform: ruby
 authors:
 - pawurb
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-10-13 00:00:00.000000000 Z
+date: 2021-02-13 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: 1.2.4
+        version: 1.5.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.2.4
+        version: 1.5.1
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
@@ -108,7 +108,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
 summary: Rails PostgreSQL performance database insights