pg_query_optimizer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1ce5a4026e2bb5739220739b2e273dfc78661657e2ed9ae4ede358b508c8282a
+  data.tar.gz: 218f3542fa3912a8e002c642733d867f1c6385dd82db497e32c941ff5d187255
+SHA512:
+  metadata.gz: 03f381c2b3c74fe83c395c2c788265af67e41ed67ea07b7666157d298018eaab6b433d5f5e077f117dfe030903bcd10d2ef64243e6358ed566a161fbbe4ebfea
+  data.tar.gz: 8852fcaacd8bb317d1a20fa8518a0d3c75b8473d20e6725946369e8f0490de4c44cc28e168ea05c9e384950c01834a0615bce38623bcf3e8aa1bafebfcd796c4

data/lib/pg_query_optimizer/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module PgQueryOptimizer
+  VERSION = "0.1.0"
+end

data/lib/pg_query_optimizer.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+require_relative "pg_query_optimizer/version"
+require 'active_record'
+
+module PgQueryOptimizer
+
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+
+  module ClassMethods
+   
+    DEFAULT_SETTINGS = {
+      max_parallel_workers_per_gather: 4,
+      parallel_setup_cost: 1000,
+      parallel_tuple_cost: 0.1,
+      min_parallel_table_scan_size: '8MB',
+      min_parallel_index_scan_size: '512kB'
+    }.freeze
+
+    def store_current_values
+      @previous_values = {
+        max_parallel_workers_per_gather: ActiveRecord::Base.connection.execute("SHOW max_parallel_workers_per_gather").first["max_parallel_workers_per_gather"],
+        parallel_setup_cost: ActiveRecord::Base.connection.execute("SHOW parallel_setup_cost").first["parallel_setup_cost"],
+        parallel_tuple_cost: ActiveRecord::Base.connection.execute("SHOW parallel_tuple_cost").first["parallel_tuple_cost"],
+        min_parallel_table_scan_size: ActiveRecord::Base.connection.execute("SHOW min_parallel_table_scan_size").first["min_parallel_table_scan_size"],
+        min_parallel_index_scan_size: ActiveRecord::Base.connection.execute("SHOW min_parallel_index_scan_size").first["min_parallel_index_scan_size"]
+      }
+    end
+
+    def estore_previous_values
+      @previous_values.each do |key, value|
+        ActiveRecord::Base.connection.execute("SET #{key} = '#{value}'")
+      end
+    end
+
+    def sufficient_resources?
+      # Implement checks to ensure system has sufficient resources
+      total_memory = `free -m | grep Mem: | awk '{print $2}'`.to_i
+      required_memory = 1024 # required memory in MB
+
+      total_memory >= required_memory
+    end
+
+    def enable_parallel_execution
+      store_current_values
+      DEFAULT_SETTINGS.each do |key, value|
+        ActiveRecord::Base.connection.execute("SET #{key} = '#{value}'")
+      end
+    end
+
+    def reset_parallel_execution
+      restore_previous_values
+    end
+
+    def pg_optimize(max_workers: 4)
+      verify_postgresql_adapter!
+      if sufficient_resources?
+        enable_parallel_execution
+        yield
+      else
+        # If resources are insufficient, run the query without parallel execution
+        yield
+      end
+    ensure
+      reset_parallel_execution 
+    end
+
+    def verify_postgresql_adapter!
+      unless ActiveRecord::Base.connection.adapter_name.downcase == 'postgresql'
+        raise UnsupportedDatabaseError, "PgQueryOptimizer only supports PostgreSQL"
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.include(PgQueryOptimizer)

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: pg_query_optimizer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- jana
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2024-06-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.21'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.21'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: pg_query_optimizer is a gem that provides a method to enable and manage
+  parallel execution of PostgreSQL queries, improving the performance of complex queries.
+email:
+- shanmugamjanarthan24@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/pg_query_optimizer.rb
+- lib/pg_query_optimizer/version.rb
+homepage: https://github.com/janarthanan-shanmugam/pg_query_optimizer
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/janarthanan-shanmugam/pg_query_optimizer
+  source_code_uri: https://github.com/janarthanan-shanmugam/pg_query_optimizer
+  changelog_uri: https://github.com/janarthanan-shanmugam/pg_query_optimizer
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.11
+signing_key: 
+specification_version: 4
+summary: Optimizes PostgreSQL queries for better performance by enabling parallel
+  execution.
+test_files: []