pg_party 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 11489588c1a9cccdbb8f39a73ebd3b91367c45640677211df0ff73afcb267598
-  data.tar.gz: 0e2e6184b88e80afa186173c291ae3044976e1bd909f8d3501d35f780c024c09
+  metadata.gz: 5996516e7f3b76373b6fc4f9a29c9e31f48d9edb086b7e0f217031f0ed3707ea
+  data.tar.gz: d4e5d12b2bdb80ab928153efe9ec49e11b7e6e413f0a0edbeddfe2f24a7d4276
 SHA512:
-  metadata.gz: 1dddde1408aeeee28b7bd0474c39483b3df2ccba68de294eeacc77421e8f8aae0508685f2c5926c695ab3c129d9ae0ffec45fca8d99be7ec8f15e4a7d7e5ead5
-  data.tar.gz: dc26fa61e8c0d026e7c102c0100d275c9b1d1f5baf2880b6bca82fde7f3fa700d48ed30394e15d3d85fdf786d008148e8b90c23662c43914d4e852a80e976657
+  metadata.gz: fac73650e2065c300fabb4ad826e59b8877310033490778b81835d28f297135796befec74a3ca5f6f6d5b3204f65a0f6686d58875df53e1332d96b6ef09edbac
+  data.tar.gz: 0fec1b06196dc2fecd95464694ae1d9742fb72687ac676b5a6def977b1a965a2f137b70edb85310f273237d8a7f6370aaa6a193d5c926487e30710d53de720f0

data/README.md

@@ -48,6 +48,32 @@ $ gem install pg_party
 Note that the gemspec does not require `pg`, as some model methods _may_ work for other databases.
 Migration methods will be unavailable unless `pg` is installed.
 
+## Configuration
+
+These values can be accessed and set via `PgParty.config` and `PgParty.configure`.
+
+- `caching`
+  - Whether to cache currently attached partitions and anonymous model classes
+  - Default: `true`
+- `caching_ttl`
+  - Length of time (in seconds) that cache entries are considered valid
+  - Default: `-1` (never expire cache entries)
+- `schema_exclude_partitions`
+  - Whether to exclude child partitions in `rake db:structure:dump` (supported in ActiveRecord 5.2+)
+  - Default: `true`
+
+Note that caching is done in-memory for each process of an application. Attaching / detaching partitions _will_ clear the cache, but only for the process that initiated the request. For multi-process web servers, it is recommended to use a TTL or disable caching entirely.
+
+### Example
+
+```ruby
+# in a Rails initializer
+PgParty.configure do |c|
+  c.caching_ttl = 60
+  c.schema_exclude_partitions = false
+end
+```
+
 ## Usage
 
 ### Migrations

data/lib/pg_party.rb

@@ -1,8 +1,28 @@
 # frozen_string_literal: true
 
 require "pg_party/version"
+require "pg_party/config"
+require "pg_party/cache"
 require "active_support"
 
+module PgParty
+  @config = Config.new
+  @cache = Cache.new
+
+  class << self
+    attr_reader :config, :cache
+
+    def configure(&blk)
+      blk.call(config)
+    end
+
+    def reset
+      @config = Config.new
+      @cache = Cache.new
+    end
+  end
+end
+
 ActiveSupport.on_load(:active_record) do
   require "pg_party/model/methods"
 
@@ -20,6 +40,12 @@ ActiveSupport.on_load(:active_record) do
     PgParty::Hacks::SchemaCache
   )
 
+  require "pg_party/hacks/database_tasks"
+
+  ActiveRecord::Tasks::DatabaseTasks.extend(
+    PgParty::Hacks::DatabaseTasks
+  )
+
   begin
     require "active_record/connection_adapters/postgresql_adapter"
     require "pg_party/adapter/postgresql_methods"

data/lib/pg_party/adapter_decorator.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require "digest"
-require "pg_party/cache"
 
 module PgParty
   class AdapterDecorator < SimpleDelegator
@@ -61,7 +60,7 @@ module PgParty
         DETACH PARTITION #{quote_table_name(child_table_name)}
       SQL
 
-      PgParty::Cache.clear!
+      PgParty.cache.clear!
     end
 
     private
@@ -118,7 +117,7 @@ module PgParty
         FOR VALUES #{constraint_clause}
       SQL
 
-      PgParty::Cache.clear!
+      PgParty.cache.clear!
     end
 
     # Rails 5.2 now returns boolean literals

data/lib/pg_party/cache.rb

@@ -6,32 +6,66 @@ module PgParty
   class Cache
     LOCK = Mutex.new
 
-    class << self
-      def clear!
-        LOCK.synchronize { store.clear }
+    def initialize
+      # automatically initialize a new hash when
+      # accessing an object id that doesn't exist
+      @store = Hash.new { |h, k| h[k] = { models: {}, partitions: nil } }
+    end
+
+    def clear!
+      LOCK.synchronize { @store.clear }
+
+      nil
+    end
+
+    def fetch_model(key, child_table, &block)
+      return block.call unless caching_enabled?
+
+      LOCK.synchronize { fetch_value(@store[key][:models], child_table.to_sym, block) }
+    end
+
+    def fetch_partitions(key, &block)
+      return block.call unless caching_enabled?
+
+      LOCK.synchronize { fetch_value(@store[key], :partitions, block) }
+    end
+
+    private
+
+    def caching_enabled?
+      PgParty.config.caching
+    end
+
+    def fetch_value(subhash, key, block)
+      entry = subhash[key]
 
-        nil
+      if entry.nil? || entry.expired?
+        entry = Entry.new(block.call)
+        subhash[key] = entry
       end
 
-      def fetch_model(key, child_table, &block)
-        LOCK.synchronize do
-          store[key][:models][child_table.to_sym] ||= block.call
-        end
+      entry.value
+    end
+
+    class Entry
+      attr_reader :value
+
+      def initialize(value)
+        @value = value
+        @timestamp = Time.now
       end
 
-      def fetch_partitions(key, &block)
-        LOCK.synchronize do
-          store[key][:partitions] ||= block.call
-        end
+      def expired?
+        ttl.positive? && Time.now - @timestamp > ttl
       end
 
       private
 
-      def store
-        # automatically initialize a new hash when
-        # accessing an object id that doesn't exist
-        @store ||= Hash.new { |h, k| h[k] = { models: {}, partitions: nil } }
+      def ttl
+        PgParty.config.caching_ttl
       end
     end
+
+    private_constant :Entry
   end
 end

data/lib/pg_party/config.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module PgParty
+  class Config
+    attr_accessor \
+      :caching,
+      :caching_ttl,
+      :schema_exclude_partitions
+
+    def initialize
+      @caching = true
+      @caching_ttl = -1
+      @schema_exclude_partitions = true
+    end
+  end
+end

data/lib/pg_party/hacks/database_tasks.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module PgParty
+  module Hacks
+    module DatabaseTasks
+      def structure_dump(*)
+        old_ignore_list = ActiveRecord::SchemaDumper.ignore_tables
+
+        if PgParty.config.schema_exclude_partitions
+          new_ignore_list = partitions.map { |table| "*.#{table}" }
+        else
+          new_ignore_list = []
+        end
+
+        ActiveRecord::SchemaDumper.ignore_tables = old_ignore_list + new_ignore_list
+
+        super
+      ensure
+        ActiveRecord::SchemaDumper.ignore_tables = old_ignore_list
+      end
+
+      def partitions
+        ActiveRecord::Base.connection.select_values(
+          "SELECT DISTINCT inhrelid::regclass::text FROM pg_inherits"
+        )
+      rescue
+        []
+      end
+    end
+  end
+end

data/lib/pg_party/model/shared_methods.rb

@@ -6,11 +6,19 @@ module PgParty
   module Model
     module SharedMethods
       def reset_primary_key
-        PgParty::ModelDecorator.new(self).partition_primary_key
+        if self != base_class
+          base_class.primary_key
+        elsif partition_name = partitions.first
+          in_partition(partition_name).get_primary_key(base_class.name)
+        else
+          get_primary_key(base_class.name)
+        end
       end
 
       def table_exists?
-        PgParty::ModelDecorator.new(self).partition_table_exists?
+        target_table = partitions.first || table_name
+
+        connection.schema_cache.data_source_exists?(target_table)
       end
 
       def partitions

data/lib/pg_party/model_decorator.rb

@@ -1,27 +1,9 @@
 # frozen_string_literal: true
 
-require "pg_party/cache"
-
 module PgParty
   class ModelDecorator < SimpleDelegator
-    def partition_primary_key
-      if self != base_class
-        base_class.primary_key
-      elsif partition_name = partitions.first
-        in_partition(partition_name).get_primary_key(base_class.name)
-      else
-        get_primary_key(base_class.name)
-      end
-    end
-
-    def partition_table_exists?
-      target_table = partitions.first || table_name
-
-      connection.schema_cache.data_source_exists?(target_table)
-    end
-
     def in_partition(child_table_name)
-      PgParty::Cache.fetch_model(cache_key, child_table_name) do
+      PgParty.cache.fetch_model(cache_key, child_table_name) do
         Class.new(__getobj__) do
           self.table_name = child_table_name
 
@@ -41,6 +23,11 @@ module PgParty
           def self.new(*args, &blk)
             superclass.new(*args, &blk)
           end
+
+          # to avoid unnecessary db lookups
+          def self.partitions
+            []
+          end
         end
       end
     end
@@ -76,7 +63,7 @@ module PgParty
     end
 
     def partitions
-      PgParty::Cache.fetch_partitions(cache_key) do
+      PgParty.cache.fetch_partitions(cache_key) do
         connection.select_values(<<-SQL)
           SELECT pg_inherits.inhrelid::regclass::text
           FROM pg_tables

data/lib/pg_party/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PgParty
-  VERSION = "1.1.0"
+  VERSION = "1.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pg_party
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Ryan Krage
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-07 00:00:00.000000000 Z
+date: 2019-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -219,6 +219,8 @@ files:
 - lib/pg_party/adapter/postgresql_methods.rb
 - lib/pg_party/adapter_decorator.rb
 - lib/pg_party/cache.rb
+- lib/pg_party/config.rb
+- lib/pg_party/hacks/database_tasks.rb
 - lib/pg_party/hacks/schema_cache.rb
 - lib/pg_party/model/list_methods.rb
 - lib/pg_party/model/methods.rb