pghero 2.1.1 → 2.2.0

data/guides/Suggested-Indexes.md

@@ -1,19 +0,0 @@
-# How PgHero Suggests Indexes
-
-1. Get the most time-consuming queries from [pg_stat_statements](https://www.postgresql.org/docs/current/static/pgstatstatements.html).
-
-2. Parse queries with [pg_query](https://github.com/lfittl/pg_query).  Look for a single table with a `WHERE` clause that consists of only `=`, `IN`, `IS NULL` or `IS NOT NULL` and/or an `ORDER BY` clause.
-
-3. Use the [pg_stats](https://www.postgresql.org/docs/current/static/view-pg-stats.html) view to get estimates about distinct rows and percent of `NULL` values for each column.
-
-4. For each column in the `WHERE` clause, sort by the highest [cardinality](https://en.wikipedia.org/wiki/Cardinality_(SQL_statements)) (most unique values). This allows the database to narrow its search the fastest. Perform [row estimation](https://www.postgresql.org/docs/current/static/row-estimation-examples.html) to get the expected number of rows as we add columns to the index.
-
-5. Continue this process with columns in the `ORDER BY` clause.
-
-6. To make sure we don’t add useless columns, stop once we narrow it down to 50 rows in steps 5 or 6. Also, recheck the last columns to make sure they add value.
-
-7. Profit :moneybag:
-
-## TODO
-
-- examples

data/pghero.gemspec

@@ -1,35 +0,0 @@
-# coding: utf-8
-lib = File.expand_path("../lib", __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "pghero/version"
-
-Gem::Specification.new do |spec|
-  spec.name          = "pghero"
-  spec.version       = PgHero::VERSION
-  spec.authors       = ["Andrew Kane"]
-  spec.email         = ["andrew@chartkick.com"]
-  spec.summary       = "A performance dashboard for Postgres"
-  spec.homepage      = "https://github.com/ankane/pghero"
-  spec.license       = "MIT"
-
-  spec.files         = `git ls-files -z`.split("\x0")
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features|guides)/})
-  spec.require_paths = ["lib"]
-
-  spec.required_ruby_version = ">= 2.2.0"
-
-  spec.add_dependency "activerecord"
-
-  spec.add_development_dependency "activerecord-import"
-  spec.add_development_dependency "bundler"
-  spec.add_development_dependency "minitest"
-  spec.add_development_dependency "rake"
-
-  if RUBY_PLATFORM == "java"
-    spec.add_development_dependency "activerecord-jdbcpostgresql-adapter"
-  else
-    spec.add_development_dependency "pg", "< 1.0.0"
-    spec.add_development_dependency "pg_query"
-  end
-end

data/test/basic_test.rb

@@ -1,38 +0,0 @@
-require_relative "test_helper"
-
-class BasicTest < Minitest::Test
-  def setup
-    City.delete_all
-  end
-
-  def test_explain
-    City.create!
-    PgHero.explain("ANALYZE DELETE FROM cities")
-    assert_equal 1, City.count
-  end
-
-  def test_explain_multiple_statements
-    City.create!
-    assert_raises(ActiveRecord::StatementInvalid) { PgHero.explain("ANALYZE DELETE FROM cities; DELETE FROM cities; COMMIT") }
-  end
-
-  def test_analyze_tables
-    assert PgHero.analyze_tables
-  end
-
-  def test_relation_sizes
-    assert PgHero.relation_sizes
-  end
-
-  def test_transaction_id_danger
-    assert PgHero.transaction_id_danger(threshold: 10000000000)
-  end
-
-  def test_autovacuum_danger
-    assert PgHero.autovacuum_danger
-  end
-
-  def test_databases
-    assert PgHero.databases[:primary].running_queries
-  end
-end

data/test/best_index_test.rb

@@ -1,180 +0,0 @@
-require_relative "test_helper"
-
-class BestIndexTest < Minitest::Test
-  def test_where
-    assert_best_index ({table: "users", columns: ["city_id"]}), "SELECT * FROM users WHERE city_id = 1"
-  end
-
-  def test_all_values
-    index = PgHero.best_index("SELECT * FROM users WHERE login_attempts = 1 ORDER BY created_at")
-    expected = {
-      found: true,
-      structure: {table: "users", where: [{column: "login_attempts", op: "="}], sort: [{column: "created_at", direction: "asc"}]},
-      index: {table: "users", columns: ["login_attempts", "created_at"]},
-      rows: 5000,
-      row_estimates: {"login_attempts (=)" => 167, "created_at (sort)" => 1},
-      row_progression: [5000, 167, 0]
-    }
-    assert_equal expected, index
-  end
-
-  def test_where_multiple_columns
-    assert_best_index ({table: "users", columns: ["city_id", "login_attempts"]}), "SELECT * FROM users WHERE city_id = 1 and login_attempts = 2"
-  end
-
-  def test_where_unique
-    assert_best_index ({table: "users", columns: ["email"]}), "SELECT * FROM users WHERE city_id = 1 AND email = 'person2@example.org'"
-  end
-
-  def test_order
-    assert_best_index ({table: "users", columns: ["created_at"]}), "SELECT * FROM users ORDER BY created_at"
-  end
-
-  def test_order_multiple
-    assert_best_index ({table: "users", columns: ["login_attempts", "created_at"]}), "SELECT * FROM users ORDER BY login_attempts, created_at"
-  end
-
-  def test_order_multiple_direction
-    assert_best_index ({table: "users", columns: ["login_attempts"]}), "SELECT * FROM users ORDER BY login_attempts DESC, created_at"
-  end
-
-  def test_order_multiple_unique
-    assert_best_index ({table: "users", columns: ["id"]}), "SELECT * FROM users ORDER BY id, created_at"
-  end
-
-  def test_where_unique_order
-    assert_best_index ({table: "users", columns: ["email"]}), "SELECT * FROM users WHERE email = 'person2@example.org' ORDER BY created_at"
-  end
-
-  def test_where_order
-    assert_best_index ({table: "users", columns: ["login_attempts", "created_at"]}), "SELECT * FROM users WHERE login_attempts = 1 ORDER BY created_at"
-  end
-
-  def test_where_order_unknown
-    assert_best_index ({table: "users", columns: ["login_attempts"]}), "SELECT * FROM users WHERE login_attempts = 1 ORDER BY NOW()"
-  end
-
-  def test_where_in
-    assert_best_index ({table: "users", columns: ["city_id"]}), "SELECT * FROM users WHERE city_id IN (1, 2)"
-  end
-
-  def test_like
-    assert_best_index ({table: "users", columns: ["email gist_trgm_ops"], using: "gist"}), "SELECT * FROM users WHERE email LIKE ?"
-  end
-
-  def test_like_where
-    assert_best_index ({table: "users", columns: ["city_id"]}), "SELECT * FROM users WHERE city_id = ? AND email LIKE ?"
-  end
-
-  def test_like_where2
-    assert_best_index ({table: "users", columns: ["email gist_trgm_ops"], using: "gist"}), "SELECT * FROM users WHERE email LIKE ? AND active = ?"
-  end
-
-  def test_ilike
-    assert_best_index ({table: "users", columns: ["email gist_trgm_ops"], using: "gist"}), "SELECT * FROM users WHERE email ILIKE ?"
-  end
-
-  def test_not_equals
-    assert_best_index ({table: "users", columns: ["login_attempts"]}), "SELECT * FROM users WHERE city_id != ? and login_attempts = 2"
-  end
-
-  def test_not_in
-    assert_best_index ({table: "users", columns: ["login_attempts"]}), "SELECT * FROM users WHERE city_id NOT IN (?) and login_attempts = 2"
-  end
-
-  def test_between
-    assert_best_index ({table: "users", columns: ["city_id"]}), "SELECT * FROM users WHERE city_id BETWEEN 1 AND 2"
-  end
-
-  def test_multiple_range
-    assert_best_index ({table: "users", columns: ["city_id"]}), "SELECT * FROM users WHERE city_id > ? and login_attempts > ?"
-  end
-
-  def test_where_prepared
-    assert_best_index ({table: "users", columns: ["city_id"]}), "SELECT * FROM users WHERE city_id = $1"
-  end
-
-  def test_where_normalized
-    assert_best_index ({table: "users", columns: ["city_id"]}), "SELECT * FROM users WHERE city_id = ?"
-  end
-
-  def test_is_null
-    assert_best_index ({table: "users", columns: ["zip_code"]}), "SELECT * FROM users WHERE zip_code IS NULL"
-  end
-
-  def test_is_null_equal
-    assert_best_index ({table: "users", columns: ["zip_code", "login_attempts"]}), "SELECT * FROM users WHERE zip_code IS NULL AND login_attempts = ?"
-  end
-
-  def test_is_not_null
-    assert_best_index ({table: "users", columns: ["login_attempts"]}), "SELECT * FROM users WHERE zip_code IS NOT NULL AND login_attempts = ?"
-  end
-
-  def test_update
-    assert_best_index ({table: "users", columns: ["city_id"]}), "UPDATE users SET email = 'test' WHERE city_id = 1"
-  end
-
-  def test_delete
-    assert_best_index ({table: "users", columns: ["city_id"]}), "DELETE FROM users WHERE city_id = 1"
-  end
-
-  def test_parse_error
-    assert_no_index "Parse error", "SELECT *123'"
-  end
-
-  def test_stats_not_found
-    assert_no_index "Stats not found", "SELECT * FROM non_existent_table WHERE id = 1"
-  end
-
-  def test_unknown_structure
-    assert_no_index "Unknown structure", "SELECT NOW()"
-  end
-
-  def test_where_or
-    assert_no_index "Unknown structure", "SELECT FROM users WHERE login_attempts = 0 OR login_attempts = 1"
-  end
-
-  def test_where_nested_or
-    assert_no_index "Unknown structure", "SELECT FROM users WHERE city_id = 1 AND (login_attempts = 0 OR login_attempts = 1)"
-  end
-
-
-  def test_multiple_tables
-    assert_no_index "JOIN not supported yet", "SELECT * FROM users INNER JOIN cities ON cities.id = users.city_id"
-  end
-
-  def test_no_columns
-    assert_no_index "No columns to index", "SELECT * FROM users"
-  end
-
-  def test_small_table
-    assert_no_index "No index needed if less than 500 rows", "SELECT * FROM states WHERE name = 'State 1'"
-  end
-
-  def test_system_table
-    assert_no_index "System table", "SELECT COUNT(*) AS count FROM pg_extension WHERE extname = ?"
-  end
-
-  def test_insert
-    assert_no_index "INSERT statement", "INSERT INTO users (login_attempts) VALUES (1)"
-  end
-
-  def test_set
-    assert_no_index "SET statement", "set client_encoding to 'UTF8'"
-  end
-
-  protected
-
-  def assert_best_index(expected, statement)
-    index = PgHero.best_index(statement)
-    assert_nil index[:explanation]
-    assert index[:found]
-    assert_equal expected, index[:index]
-  end
-
-  def assert_no_index(explanation, statement)
-    index = PgHero.best_index(statement)
-    assert !index[:found]
-    assert_equal explanation, index[:explanation]
-  end
-end

data/test/gemfiles/activerecord41.gemfile

@@ -1,6 +0,0 @@
-source "https://rubygems.org"
-
-# Specify your gem's dependencies in pghero.gemspec
-gemspec path: "../.."
-
-gem "activerecord", "~> 4.1.0"

data/test/gemfiles/activerecord42.gemfile

@@ -1,6 +0,0 @@
-source "https://rubygems.org"
-
-# Specify your gem's dependencies in pghero.gemspec
-gemspec path: "../.."
-
-gem "activerecord", "~> 4.2.0"

data/test/suggested_indexes_test.rb

@@ -1,18 +0,0 @@
-require_relative "test_helper"
-
-class SuggestedIndexesTest < Minitest::Test
-  def setup
-    skip if ENV["TRAVIS_CI"]
-    PgHero.reset_query_stats
-  end
-
-  def test_basic
-    User.where(email: "person1@example.org").first
-    assert_equal [{table: "users", columns: ["email"]}], PgHero.suggested_indexes.map { |q| q.except(:queries, :details) }
-  end
-
-  def test_existing_index
-    User.where("updated_at > ?", Time.now).to_a
-    assert_equal [], PgHero.suggested_indexes.map { |q| q.except(:queries, :details) }
-  end
-end

data/test/test_helper.rb

@@ -1,66 +0,0 @@
-require "bundler/setup"
-Bundler.require(:default)
-require "minitest/autorun"
-require "minitest/pride"
-require "pg_query"
-require "activerecord-import"
-
-# for Minitest < 5
-Minitest::Test = MiniTest::Unit::TestCase unless defined?(Minitest::Test)
-
-ActiveRecord::Base.establish_connection adapter: "postgresql", database: "pghero_test"
-
-ActiveRecord::Migration.enable_extension "pg_stat_statements"
-
-ActiveRecord::Migration.create_table :cities, force: true do |t|
-  t.string :name
-end
-
-ActiveRecord::Migration.create_table :states, force: true do |t|
-  t.string :name
-end
-
-ActiveRecord::Migration.create_table :users, force: true do |t|
-  t.integer :city_id
-  t.integer :login_attempts
-  t.string :email
-  t.string :zip_code
-  t.boolean :active
-  t.timestamp :created_at
-  t.timestamp :updated_at
-end
-ActiveRecord::Migration.add_index :users, :updated_at
-
-class City < ActiveRecord::Base
-end
-
-class State < ActiveRecord::Base
-end
-
-class User < ActiveRecord::Base
-end
-
-states =
-  50.times.map do |i|
-    {
-      name: "State #{i}"
-    }
-  end
-State.import states, validate: false
-ActiveRecord::Base.connection.execute("ANALYZE states")
-
-users =
-  5000.times.map do |i|
-    city_id = i % 100
-    {
-      city_id: city_id,
-      email: "person#{i}@example.org",
-      login_attempts: rand(30),
-      zip_code: i % 40 == 0 ? nil : "12345",
-      active: true,
-      created_at: Time.now - rand(50).days,
-      updated_at: Time.now - rand(50).days
-    }
-  end
-User.import users, validate: false
-ActiveRecord::Base.connection.execute("ANALYZE users")