rails-pg-extras 1.2.3 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 96b32211012cd93252e2fd58f870713a4717f57eaed8071b6fd3c32aeac31264
-  data.tar.gz: e4001940a894b757284e650c50400357f3d01e2e0273841fdf243099e88a8042
+  metadata.gz: 897f027634b0313e42a13d864678eac7f0280c00a9a39ca5d668cabbba970b02
+  data.tar.gz: d23efda1f8afcbd989278b9362baacb4882796115d7e70263a812787f95de340
 SHA512:
-  metadata.gz: 6ccc4603aa90aba0229aa0c2c7ac76c9377e90e8e8704a107d52588472b5c4e05b8d3aeb8acb7ba2a6ff4a5fc9003c17c797932c6baaa337270314fb70ff47db
-  data.tar.gz: c73c394b1d2c5692eafa973f0daf6751e6e72b33b7baba67d69bc7385a60d058ada88a1d6ff6e52812daab647b6e5109bacef1cb4fd1cea23049fe1a2f9ca2c0
+  metadata.gz: 612408e64b97f03c70dcab7525cce2be8cafa4b9cf5eca27dd88013b5d74ffd08c5e68532599158c697d8754b9fa1ee534bbb698a9603df489d7394b1d036dab
+  data.tar.gz: f9c66eb8837a6720de96132e0941364aa3e83f627d52a04221efbbe2d361c1c9f2a24635057868c631ecee54fe42a9aa599b9a354f82341f84cd7a0ff2a524b2

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,6 +78,13 @@ 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`
@@ -106,7 +115,7 @@ $ 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`
 
@@ -157,7 +166,7 @@ $ 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`
 
@@ -183,7 +192,7 @@ $ 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.
 
@@ -283,7 +292,7 @@ $ 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`
 
@@ -317,6 +326,22 @@ $ 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
+
+$ 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`
 
 ```
@@ -343,7 +368,7 @@ $ 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`
 
@@ -409,7 +434,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`
 

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/tasks/all.rake

@@ -3,9 +3,19 @@
 require 'rails-pg-extras'
 
 namespace :pg_extras do
+  task :establish_connection do
+    if ENV['DATABASE_URL'].present?
+      ActiveRecord::Base.establish_connection(ENV['DATABASE_URL'])
+    else
+      db_config_file = File.read('config/database.yml')
+      db_config = YAML::load(ERB.new(db_config_file).result)
+      ActiveRecord::Base.establish_connection(db_config[Rails.env])
+    end
+  end
+
   RailsPGExtras::QUERIES.each do |query_name|
     desc RubyPGExtras.description_for(query_name: query_name)
-    task query_name.to_sym => :environment do
+    task query_name.to_sym => :establish_connection do
       RailsPGExtras.public_send(query_name)
     end
   end

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

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails-pg-extras
 version: !ruby/object:Gem::Version
-  version: 1.2.3
+  version: 1.5.0
 platform: ruby
 authors:
 - pawurb
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-10-08 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.3
+        version: 1.5.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.2.3
+        version: 1.5.0
 - !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