tobias 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 342518e2c3730a589319c0d16967f7e9fdc80affde011c3820ef2c1034fcbc3e
-  data.tar.gz: adcdc3152a07d4e1203ad6ceff26901e999f5a8110e883675aa20c9e894ae932
+  metadata.gz: 4b50326ed51ec5388f5f63528cbfe0cda2f27db4e505b0cdf1349f1cc9313311
+  data.tar.gz: e76ddcd08800005f89ddb772953df045ad623fcfc13e114090bdfcdd49c0dabb
 SHA512:
-  metadata.gz: af1341883626cda785ba564368baad44e0cec9e55751bb7c00d204b1e12cf32ebc3817002f2c7fd81e7b57a6ddd2a78be74b11fa0e1f3f837741552f8064f338
-  data.tar.gz: 58d79c4c82d5bf1cd21e42c6770dcc454c52bfab5a22a5fa1d15ed6dfe8b3abfd340d7a31b07c6205b7955787214395814176cd997307e2dad083256c29c5139
+  metadata.gz: 456a7a52310fcac42a5755ad02aeb464bb429742888a195569fb5d5df7f33416d583cef442eca92b035af9807e7ec5d17c626b0eda20b9d43998fc4c99ccb6f3
+  data.tar.gz: e8c5d112db7cd2e87f37455d90b25a6dfe53eba27e60a492c4fbc4798a941bdc9b69532b813eb39f4c69b68c34812e09112ec19a80485f90e526869e2d0c1794

data/lib/tobias/cli.rb

@@ -10,7 +10,7 @@ module Tobias
 
     desc "profile SCRIPT", "profile"
     option :database_url, type: :string, required: true
-    option :iterations, type: :numeric, default: 100
+    option :iterations, type: :numeric, default: 10
     option :debug, type: :boolean, default: false
     def profile(script)
       database = Sequel.connect(options[:database_url])
@@ -24,7 +24,6 @@ module Tobias
       end
 
       container = Container.new(code)
-      work_mems = WorkMem.valid_for(database)
       results = {}
 
       parsed = TTY::Markdown.parse(<<~MARKDOWN)
@@ -33,11 +32,7 @@ module Tobias
       puts parsed
 
       thinking_time = Benchmark.realtime do
-        container.queries.each do |name, block|
-          work_mem = Evaluation.new(database, work_mems).run(options, &block)
-
-          results[name] = work_mem
-        end
+        results = Evaluations.run(database, container, options)
       end
 
       parsed = TTY::Markdown.parse(<<~MARKDOWN)
@@ -45,18 +40,7 @@ module Tobias
 
         I thought about your queries for precisely #{thinking_time.round(2)} seconds and here is what I recommend:
 
-        | Query | Required work_mem |
-        |-------|-------------------|
-        #{results.map { |name, work_mem| "| #{name} | #{work_mem.to_sql} |" }.join("\n")}
-
-        Your application will need to run with at least #{results.values.max.to_sql} of work_mem.
-
-        To apply my recommendations, run the following SQL:
-
-        ```sql
-        ALTER SYSTEM SET work_mem = '#{results.values.max.to_sql}';
-        SELECT pg_reload_conf();
-        ```
+        #{results.join("\n")}
 
         Regards,
         ~ Tobias

data/lib/tobias/container.rb

@@ -17,4 +17,4 @@ module Tobias
       @queries[name] = block
     end
   end
-end
+end

data/lib/tobias/evaluations/base.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Tobias
+  module Evaluations
+    class Base
+      attr_reader :database, :container
+
+      def initialize(database, container)
+        @database = database
+        @container = container
+      end
+
+      def run(options, &block)
+        results = {}
+
+        container.queries.each do |name, query|
+          results.merge!(run_each(name, query, options))
+        end
+
+        to_markdown(results)
+      end
+
+      def run_each(query, options)
+        raise NotImplementedError
+      end
+
+      def to_markdown(results)
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/tobias/evaluations/work_mem.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module Tobias
+  module Evaluations
+    class WorkMem < Base
+
+      def work_mems
+        Tobias::WorkMem.valid_for(database)
+      end
+
+      def description
+        "Optional work_mem settings"
+      end
+
+      def run_each(name, query, options)
+        work_mems.each do |value|
+          database.transaction do
+            database.run("CREATE EXTENSION IF NOT EXISTS pg_stat_statements")
+            database.run("SET LOCAL work_mem = '#{value.to_sql}'")
+            database.select(Sequel.function(:pg_stat_reset)).first
+
+            query_result = database.instance_eval(&query)
+            options[:iterations].to_i.times do
+              database.run(query_result.sql)
+            end
+
+            stats = database[:pg_stat_database].where(datname: Sequel.function(:current_database)).first
+
+            if stats[:temp_files] == 0 && stats[:temp_bytes] == 0
+              return { name => value }
+            end
+          end
+        end
+
+        # TODO: Add a warning message or something.
+        return { name => nil }
+      end
+
+      def to_markdown(results)
+        current_work_mem = Tobias::WorkMem.from_sql(database.fetch("SHOW work_mem").first[:work_mem])
+
+        <<~MARKDOWN
+          ## #{description}
+
+          | Query | Required work_mem |
+          |-------|-------------------|
+          #{results.map { |name, work_mem| "| #{name} | #{work_mem.to_sql} |" }.join("\n")}
+
+          Your application will need to run with at least #{results.values.max.to_sql} of work_mem.
+
+          I see that your current work_mem setting is #{current_work_mem.to_sql}.
+
+          To apply my recommendations, run the following SQL:
+
+          ```sql
+          ALTER SYSTEM SET work_mem = '#{results.values.max.to_sql}';
+          SELECT pg_reload_conf();
+          ```
+        MARKDOWN
+      end
+    end
+  end
+end

data/lib/tobias/evaluations.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Tobias
+  module Evaluations
+    def self.run(database, container, options)
+      results = []
+      results << WorkMem.new(database, container).run(options)
+      results
+    end
+  end
+end

data/lib/tobias/version.rb

@@ -1,8 +1,7 @@
 # frozen_string_literal: true
 
 module Tobias
-  VERSION = "0.2.0"
-
+  VERSION = "0.3.0"
   SUMMARY = "Tobias is a tool to help you find the optimal work_mem for your queries."
   DESCRIPTION = "Tobias is a tool to help you find the optimal work_mem for your queries."
 end

data/lib/tobias/work_mem.rb

@@ -4,6 +4,21 @@ module Tobias
   class WorkMem
     attr_reader :amount
 
+    def self.from_sql(sql)
+      case sql
+      when /^\d+B$/
+        new(sql.to_i)
+      when /^\d+kB$/
+        new(sql.to_i * 1024)
+      when /^\d+MB$/
+        new(sql.to_i * 1024 * 1024)
+      when /^\d+GB$/
+        new(sql.to_i * 1024 * 1024 * 1024)
+      else
+        raise "Invalid work_mem setting: #{sql}"
+      end
+    end
+
     def initialize(amount)
       @amount = amount
     end
@@ -52,6 +67,7 @@ module Tobias
       [
         new(64.kilobytes),
         new(128.kilobytes),
+        new(256.kilobytes),
         new(512.kilobytes),
         new(1.megabyte),
         new(4.megabytes),
@@ -101,4 +117,4 @@ module Tobias
       self.all.select { |work_mem| work_mem.amount < bytes_per_connection.to_i }
     end
   end
-end
+end

data/lib/tobias.rb

@@ -23,9 +23,12 @@ require "tty-markdown"
 
 $LOAD_PATH.unshift File.dirname(__FILE__)
 
+require "tobias/evaluations"
+require "tobias/evaluations/base"
+require "tobias/evaluations/work_mem"
+
 module Tobias
   autoload :CLI, "tobias/cli"
   autoload :Container, "tobias/container"
-  autoload :Evaluation, "tobias/evaluation"
   autoload :WorkMem, "tobias/work_mem"
-end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: tobias
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Jon Daniel
 bindir: bin
 cert_chain: []
-date: 2025-08-03 00:00:00.000000000 Z
+date: 2025-08-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -240,7 +240,9 @@ files:
 - lib/tobias.rb
 - lib/tobias/cli.rb
 - lib/tobias/container.rb
-- lib/tobias/evaluation.rb
+- lib/tobias/evaluations.rb
+- lib/tobias/evaluations/base.rb
+- lib/tobias/evaluations/work_mem.rb
 - lib/tobias/version.rb
 - lib/tobias/work_mem.rb
 homepage: https://github.com/binarycleric/tobias

data/lib/tobias/evaluation.rb

@@ -1,36 +0,0 @@
-# frozen_string_literal: true
-
-module Tobias
-  class Evaluation
-    attr_reader :database
-
-    def initialize(database, work_mems)
-      @database = database
-      @work_mems = work_mems
-    end
-
-    def run(options, &block)
-      @work_mems.each do |value|
-        database.transaction do
-          database.run("CREATE EXTENSION IF NOT EXISTS pg_stat_statements")
-          database.run("SET LOCAL work_mem = '#{value.to_sql}'")
-          database.select(Sequel.function(:pg_stat_reset)).first
-          database.instance_eval(&block)
-
-          query = database.instance_eval(&block)
-          options[:iterations].to_i.times do
-            database.run(query.sql)
-          end
-
-          stats = database[:pg_stat_database].where(datname: Sequel.function(:current_database)).first
-
-          if stats[:temp_files] == 0 && stats[:temp_bytes] == 0
-            return value
-          end
-        end
-      end
-
-      raise "No work_mem found."
-    end
-  end
-end