pghero 1.1.4 → 1.2.0

data/lib/pghero/tasks.rb

@@ -5,4 +5,9 @@ namespace :pghero do
   task capture_query_stats: :environment do
     PgHero.capture_query_stats
   end
+
+  desc "autoindex"
+  task autoindex: :environment do
+    PgHero.autoindex_all(create: true)
+  end
 end

data/lib/pghero/version.rb

@@ -1,3 +1,3 @@
 module PgHero
-  VERSION = "1.1.4"
+  VERSION = "1.2.0"
 end

data/test/best_index_test.rb

@@ -0,0 +1,131 @@
+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: 10000,
+      row_estimates: {"login_attempts" => 333, "created_at" => 1},
+      row_progression: [10000, 333, 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_in
+    assert_best_index ({table: "users", columns: ["city_id"]}), "SELECT * FROM users WHERE city_id IN (1, 2)"
+  end
+
+  def test_between
+    skip
+    assert_best_index ({table: "users", columns: ["city_id"]}), "SELECT * FROM users WHERE city_id BETWEEN 1 AND 2"
+  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_multiple_tables
+    assert_no_index "Unknown structure", "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 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/explain_test.rb

@@ -0,0 +1,18 @@
+require_relative "test_helper"
+
+class ExplainTest < 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
+end

data/test/suggested_indexes_test.rb

@@ -0,0 +1,14 @@
+require_relative "test_helper"
+
+class SuggestedIndexesTest < Minitest::Test
+  def setup
+    PgHero.reset_query_stats
+  end
+
+  def test_basic
+    User.where(email: "person1@example.org").first
+    # User.where(email: "person1@example.org", city_id: 1).first
+    # User.where(city_id: 1).to_a
+    assert_equal [{table: "users", columns: ["email"]}], PgHero.suggested_indexes.map { |q| q.except(:queries) }
+  end
+end

data/test/test_helper.rb

@@ -2,15 +2,57 @@ require "bundler/setup"
 Bundler.require(:default)
 require "minitest/autorun"
 require "minitest/pride"
+require "pg_query"
 
 # for Minitest < 5
 Minitest::Test = MiniTest::Unit::TestCase unless defined?(Minitest::Test)
 
 ActiveRecord::Base.establish_connection adapter: "postgresql", database: "pghero_test"
 
-ActiveRecord::Migration.create_table :users, force: true do
-  # just id
+ActiveRecord::Migration.create_table :cities, force: true do |t|
+  t.string :name
+end
+
+class City < ActiveRecord::Base
+end
+
+class State < ActiveRecord::Base
 end
 
 class User < ActiveRecord::Base
 end
+
+if ENV["SEED"]
+  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.timestamp :created_at
+  end
+
+  User.transaction do
+    10000.times do |i|
+      city_id = i % 100
+      User.create!(
+        city_id: city_id,
+        email: "person#{i}@example.org",
+        login_attempts: rand(30),
+        zip_code: i % 40 == 0 ? nil : "12345",
+        created_at: Time.now - rand(50).days
+      )
+    end
+  end
+  ActiveRecord::Base.connection.execute("VACUUM ANALYZE users")
+
+  ActiveRecord::Migration.create_table :states, force: true do |t|
+    t.string :name
+  end
+
+  State.transaction do
+    50.times do |i|
+      State.create!(name: "State #{i}")
+    end
+  end
+  ActiveRecord::Base.connection.execute("VACUUM ANALYZE states")
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pghero
 version: !ruby/object:Gem::Version
-  version: 1.1.4
+  version: 1.2.0
 platform: ruby
 authors:
 - Andrew Kane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-09 00:00:00.000000000 Z
+date: 2015-12-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -99,11 +99,13 @@ files:
 - app/views/pg_hero/home/_live_queries_table.html.erb
 - app/views/pg_hero/home/_queries_table.html.erb
 - app/views/pg_hero/home/_query_stats_slider.html.erb
+- app/views/pg_hero/home/_suggested_index.html.erb
 - app/views/pg_hero/home/connections.html.erb
 - app/views/pg_hero/home/explain.html.erb
 - app/views/pg_hero/home/index.html.erb
 - app/views/pg_hero/home/index_usage.html.erb
 - app/views/pg_hero/home/live_queries.html.erb
+- app/views/pg_hero/home/maintenance.html.erb
 - app/views/pg_hero/home/queries.html.erb
 - app/views/pg_hero/home/space.html.erb
 - app/views/pg_hero/home/system.html.erb
@@ -114,6 +116,7 @@ files:
 - guides/Linux.md
 - guides/Query-Stats.md
 - guides/Rails.md
+- guides/Suggested-Indexes.md
 - lib/generators/pghero/query_stats_generator.rb
 - lib/generators/pghero/templates/query_stats.rb
 - lib/pghero.rb
@@ -122,10 +125,12 @@ files:
 - lib/pghero/tasks.rb
 - lib/pghero/version.rb
 - pghero.gemspec
+- test/best_index_test.rb
+- test/explain_test.rb
 - test/gemfiles/activerecord31.gemfile
 - test/gemfiles/activerecord32.gemfile
 - test/gemfiles/activerecord40.gemfile
-- test/pghero_test.rb
+- test/suggested_indexes_test.rb
 - test/test_helper.rb
 homepage: https://github.com/ankane/pghero
 licenses:
@@ -157,8 +162,11 @@ test_files:
 - guides/Linux.md
 - guides/Query-Stats.md
 - guides/Rails.md
+- guides/Suggested-Indexes.md
+- test/best_index_test.rb
+- test/explain_test.rb
 - test/gemfiles/activerecord31.gemfile
 - test/gemfiles/activerecord32.gemfile
 - test/gemfiles/activerecord40.gemfile
-- test/pghero_test.rb
+- test/suggested_indexes_test.rb
 - test/test_helper.rb

data/test/pghero_test.rb

@@ -1,18 +0,0 @@
-require_relative "test_helper"
-
-class TestPgHero < Minitest::Test
-  def setup
-    User.delete_all
-  end
-
-  def test_explain
-    User.create!
-    PgHero.explain("ANALYZE DELETE FROM users")
-    assert_equal 1, User.count
-  end
-
-  def test_explain_multiple_statements
-    User.create!
-    assert_raises(ActiveRecord::StatementInvalid) { PgHero.explain("ANALYZE DELETE FROM users; DELETE FROM users; COMMIT") }
-  end
-end