rails-pg-extras 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e9d6f8bc147f14fc0aa89bdb07e0f781e18b38c5abc01fe7d44e910ae08a326b
-  data.tar.gz: 123eed80a930a20d69abcbbab8968ced75fcc046165b70637b1b39ee3cbdadbd
+  metadata.gz: bb4905b231d556cd0a389c53a77b59e74f6d11faf45d6e3fa9e17b456cd0349a
+  data.tar.gz: 94e5c6c7ba1d48f403b069b5f7b7d24ae25e20f072166cf59d54fa891bf4662a
 SHA512:
-  metadata.gz: 49890c367f5f4998d63876cade207260e20dfab9ca0b6dd54fc8f764b234fecb7b152c630435e445f3b3c7f0a744b4d29f3c70acd3670b50f4381078dfab12ad
-  data.tar.gz: 5b832ab6911073cb95024e26d698ee98acec40c1eb14976cda51e00adb9fb24c576e26f7a9cb6be932ba2abba640f1d504a0a7e1d1c66ff6249c37fba1cad46c
+  metadata.gz: 3c41ba2e65e0d892690469fb232d09e58e02aa138ee17155014795963fc86a9be94d4c1d6482ca6e3564ab14a8b9263e1f7828c18ab7173cc3d0f16190ad4e12
+  data.tar.gz: 1aa1554a5c26f89501e59462ed4af2efc90b7d3c16b07922d71a3c7d2140096ffac47c19584edda2b4af0bc45261ea8c35f48431c94451ba86d900b51dd5a705

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

@@ -4,7 +4,19 @@ Rails port of [Heroku PG Extras](https://github.com/heroku/heroku-pg-extras) wit
 
 Included rake tasks and Ruby methods can be used to obtain information about a Postgres instance, that may be useful when analyzing performance issues. This includes information about locks, index usage, buffer cache hit ratios and vacuum statistics. Ruby API enables developers to easily integrate the tool into e.g. automatic monitoring tasks.
 
-Not using Rails? Check out the core dependency [pure Ruby version](https://github.com/pawurb/ruby-pg-extras).
+You can check out this blog post for detailed step by step tutorial on how to [optimize PostgreSQL using PG Extras library](https://pawelurbanek.com/postgresql-fix-performance).
+
+Alternative versions:
+
+- Core dependency - [Ruby](https://github.com/pawurb/ruby-pg-extras)
+
+- [NodeJS](https://github.com/pawurb/node-postgres-extras)
+
+- [Elixir](https://github.com/pawurb/ecto_psql_extras)
+
+- [Python](https://github.com/pawurb/ecto_psql_extras)
+
+- [Haskell](https://github.com/pawurb/haskell-pg-extras)
 
 ## Installation
 
@@ -14,6 +26,19 @@ In your Gemfile
 gem "rails-pg-extras"
 ```
 
+Some of the queries (e.g., `calls` and `outliers`) require [pg_stat_statements](https://www.postgresql.org/docs/current/pgstatstatements.html) extension enabled.
+
+You can check if it is enabled in your database by running:
+
+```ruby
+RailsPGExtras.extensions
+```
+You should see the similar line in the output:
+
+```bash
+| pg_stat_statements  | 1.7  | 1.7 | track execution statistics of all SQL statements executed |
+```
+
 ## Usage
 
 Each command can be used as a rake task, or a directly from the Ruby code.
@@ -83,7 +108,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`
 
@@ -134,7 +159,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`
 
@@ -160,7 +185,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.
 
@@ -248,7 +273,7 @@ This command displays the size of each table and materialized view in the databa
 ### `table_indexes_size`
 
 ```
-$ rake pg_extras:table-indexes-size
+$ rake pg_extras:table_indexes_size
 
                              table                             | indexes_size
 ---------------------------------------------------------------+--------------
@@ -260,7 +285,7 @@ $ rake pg_extras:table-indexes-size
 (truncated results for brevity)
 ```
 
-This command displays the total size of indexes for each table, 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`
 
@@ -277,7 +302,7 @@ $ rake pg_extras:total_table_size
 (truncated results for brevity)
 ```
 
-This command displays the total size of each table in the database, in MB. It is calculated by using the system administration function `pg_total_relation_size()`, which includes table size, total index size and TOAST data.
+This command displays the total size of each table and materialized view in the database, in MB. It is calculated by using the system administration function `pg_total_relation_size()`, which includes table size, total index size and TOAST data.
 
 ### `unused_indexes`
 
@@ -320,7 +345,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`
 
@@ -386,7 +411,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`
 
@@ -398,6 +423,16 @@ RailsPGExtras.kill_all
 
 This commands kills all the currently active connections to the database. It can be useful as a last resort when your database is stuck in a deadlock.
 
+### `extensions`
+
+```ruby
+
+RailsPGExtras.extensions
+
+```
+
+This command lists all the currently installed and available PostgreSQL extensions.
+
 ### mandelbrot
 
 ```
@@ -405,9 +440,3 @@ $ rake pg_extras:mandelbrot
 ```
 
 This command outputs the Mandelbrot set, calculated through SQL.
-
-## FAQ
-
-* Does is not violate the Heroku PG Extras license?
-
-The original plugin is MIT based so it means that copying and redistribution in any format is permitted.

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,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsPGExtras
-  VERSION = "1.2.0"
+  VERSION = "1.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails-pg-extras
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - pawurb
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-05-13 00:00:00.000000000 Z
+date: 2021-01-22 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.0
+        version: 1.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: 1.3.0
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
@@ -93,7 +93,7 @@ homepage: http://github.com/pawurb/rails-pg-extras
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -108,8 +108,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Rails PostgreSQL performance database insights
 test_files: