partitioned 1.0.1 → 1.1.0

data/examples/created_at_referencing_awards.rb

@@ -105,7 +105,7 @@
 #    partitioned do |partition|
 #      partition.foreign_key lambda {|model, *partition_key_values|
 #        return Configurator::Data::ForeignKey.
-#                    new(:employee_id, Employee.partition_name(*partition_key_values), :id)
+#                    new(:employee_id, Employee.partition_table_name(*partition_key_values), :id)
 #      }
 #    end
 #  end
@@ -702,7 +702,7 @@ class Award < ByEmployeeCreatedAt
 
   partitioned do |partition|
     partition.foreign_key lambda {|model, *partition_key_values|
-      return Configurator::Data::ForeignKey.new(:employee_id, Employee.partition_name(*partition_key_values), :id)
+      return Configurator::Data::ForeignKey.new(:employee_id, Employee.partition_table_name(*partition_key_values), :id)
     }
   end
   

data/lib/monkey_patch_activerecord.rb

@@ -13,6 +13,40 @@ module ActiveRecord
   # Patches for Persistence to allow certain partitioning (that related to the primary key) to work.
   #
   module Persistence
+    # Deletes the record in the database and freezes this instance to reflect
+    # that no changes should be made (since they can't be persisted).
+    def destroy
+      destroy_associations
+
+      if persisted?
+        IdentityMap.remove(self) if IdentityMap.enabled?
+        pk         = self.class.primary_key
+        column     = self.class.columns_hash[pk]
+        substitute = connection.substitute_at(column, 0)
+
+        using_arel_table = self.respond_to?(:dynamic_arel_table) ? dynamic_arel_table() : self.class.arel_table
+        relation = self.class.unscoped.where(
+          using_arel_table[pk].eq(substitute))
+
+        relation.bind_values = [[column, id]]
+        relation.delete_all
+      end
+
+      @destroyed = true
+      freeze
+    end
+
+    # Updates the associated record with values matching those of the instance attributes.
+    # Returns the number of affected rows.
+    def update(attribute_names = @attributes.keys)
+      attributes_with_values = arel_attributes_values(false, false, attribute_names)
+      return 0 if attributes_with_values.empty?
+      klass = self.class
+      using_arel_table = self.respond_to?(:dynamic_arel_table) ? dynamic_arel_table() : klass.arel_table
+      stmt = klass.unscoped.where(using_arel_table[klass.primary_key].eq(id)).arel.compile_update(attributes_with_values)
+      klass.connection.update stmt
+    end
+
     #
     # patch the create method to prefetch the primary key if needed
     #
@@ -65,7 +99,7 @@ module ActiveRecord
       # that are used to determine the child table this insert should be
       # redirected to)
       #
-      actual_arel_table = @klass.dynamic_arel_table(Hash[*values.map{|k,v| [k.name,v]}.flatten]) if @klass.respond_to? :dynamic_arel_table
+      actual_arel_table = @klass.dynamic_arel_table(Hash[*values.map{|k,v| [k.name,v]}.flatten]) if @klass.respond_to?(:dynamic_arel_table)
       actual_arel_table = @table unless actual_arel_table
       im.into actual_arel_table
 

data/lib/monkey_patch_postgres.rb

@@ -1,6 +1,7 @@
 require 'active_record'
 require 'active_record/base'
 require 'active_record/connection_adapters/abstract_adapter'
+require 'active_record/connection_adapters/postgresql_adapter'
 
 #
 # Patching {ActiveRecord::ConnectionAdapters::TableDefinition} and
@@ -28,6 +29,23 @@ module ActiveRecord::ConnectionAdapters
   # to take advantage of these SQL builders.
   #
   class PostgreSQLAdapter < AbstractAdapter
+
+    #
+    # Returns the sequence name for a table's primary key or some other specified key.
+    #
+    # the default version strips off the schema name on the table (if it exists), as:
+    #   serial_sequence(table_name, pk || 'id').split('.').last
+    # i can't see any good reason for that -- in fact, it seems completely
+    # broken -- if you have a table public.foos and other.foos, you'll fail to
+    # get the correct schema if you fetch the default schema name from model
+    # associated with other.foos
+    #
+    def default_sequence_name(table_name, pk = nil) #:nodoc:
+      serial_sequence(table_name, pk || 'id')
+    rescue ActiveRecord::StatementInvalid => e
+      "#{table_name}_#{pk || 'id'}_seq"
+    end
+
     #
     # Get the next value in a sequence. Used on INSERT operation for
     # partitioning like by_id because the ID is required before the insert
@@ -36,7 +54,7 @@ module ActiveRecord::ConnectionAdapters
     # @param [String] sequence_name the name of the sequence to fetch the next value from
     # @return [Integer] the value from the sequence
     def next_sequence_value(sequence_name)
-      return execute("select nextval('#{sequence_name}')").field_values("nextval").first
+      return execute("select nextval('#{sequence_name}')").field_values("nextval").first.to_i
     end
 
     #

data/lib/partitioned/active_record_overrides.rb

@@ -23,7 +23,7 @@ module Partitioned
     # @return [Hash] hash of key value pairs associated with persistent attributes
     def arel_attributes_values(include_primary_key = true, include_readonly_attributes = true, attribute_names = @attributes.keys)
       attrs = super
-      actual_arel_table = dynamic_arel_table(self.class.table_name)
+      actual_arel_table = dynamic_arel_table()
       return Hash[*attrs.map{|k,v| [actual_arel_table[k.name], v]}.flatten]
     end
 

data/lib/partitioned/bulk_methods_mixin.rb

@@ -81,7 +81,7 @@ module Partitioned
         # set :created_at if need be
         row[:created_at] ||= created_at_value
       end.group_by do |row|
-        respond_to?(:partition_name) ? partition_name(*partition_key_values(row)) : table_name
+        respond_to?(:partition_table_name) ? partition_table_name(*partition_key_values(row)) : table_name
       end.each do |table_name, rows_for_table|
         column_names = rows_for_table[0].keys.sort{|a,b| a.to_s <=> b.to_s}
         sql_insert_string = "insert into #{table_name} (#{column_names.join(',')}) values "
@@ -189,7 +189,7 @@ module Partitioned
       returning = []
 
       rows.group_by do |row|
-        respond_to?(:partition_name) ? partition_name(*partition_key_values(row)) : table_name
+        respond_to?(:partition_table_name) ? partition_table_name(*partition_key_values(row)) : table_name
       end.each do |table_name, rows_for_table|
         column_names = rows_for_table[0].keys.sort{|a,b| a.to_s <=> b.to_s}
         rows_for_table.each_slice(options[:slice_size]) do |update_slice|

data/lib/partitioned/by_integer_field.rb

@@ -23,6 +23,11 @@ module Partitioned
       return integer_field_value / partition_table_size * partition_table_size
     end
 
+    def self.partition_generate_range(start_value, end_value, step = :default)
+      step = partition_table_size if step == :default
+      return Range.new(start_value, end_value).step(step)
+    end
+
     partitioned do |partition|
       partition.on lambda {|model| return model.partition_integer_field }
 

data/lib/partitioned/partitioned_base/configurator/data.rb

@@ -40,8 +40,9 @@ module Partitioned
 
         attr_accessor :on_field, :indexes, :foreign_keys, :last_partitions_order_by_clause,
            :schema_name, :name_prefix, :base_name,
-           :part_name, :table_name, :parent_table_schema_name,
-           :parent_table_name, :check_constraint, :encoded_name
+           :part_name, :table_name, :table_alias_name, :parent_table_schema_name,
+           :parent_table_name, :check_constraint, :encoded_name,
+           :janitorial_creates_needed, :janitorial_archives_needed, :janitorial_drops_needed
         
         def initialize
           @on_field = nil
@@ -57,6 +58,7 @@ module Partitioned
           @part_name = nil
 
           @table_name = nil
+          @table_alias_name = nil
 
           @parent_table_schema_name = nil
           @parent_table_name = nil
@@ -64,6 +66,10 @@ module Partitioned
           @check_constraint = nil
 
           @encoded_name = nil
+
+          @janitorial_creates_needed = nil
+          @janitorial_archives_needed = nil
+          @janitorial_drops_needed = nil
         end
       end
     end

data/lib/partitioned/partitioned_base/configurator/dsl.rb

@@ -550,6 +550,11 @@ module Partitioned
           data.table_name = value
         end
 
+        # a reasonable alias for this table
+        def table_alias_name(value)
+          data.table_alias_name = value
+        end
+
         #
         # The table name of the table who is the direct ancestor of a child table.
         #
@@ -627,6 +632,20 @@ module Partitioned
         def parent_table_schema_name(value)
           data.parent_table_schema_name = value
         end
+
+        #
+
+        def janitorial_creates_needed(value)
+          data.janitorial_creates_needed = value
+        end
+
+        def janitorial_archives_needed(value)
+          data.janitorial_archives_needed = value
+        end
+
+        def janitorial_drops_needed(value)
+          data.janitorial_drops_needed = value
+        end
       end
     end
   end

data/lib/partitioned/partitioned_base/configurator/reader.rb

@@ -26,6 +26,10 @@ module Partitioned
           @parent_table_name = nil
 
           @encoded_name = nil
+
+          @janitorial_creates_needed = nil
+          @janitorial_archives_needed = nil
+          @janitorial_drops_needed = nil
         end
 
         #
@@ -100,6 +104,13 @@ module Partitioned
           return collect_first(*partition_key_values, &:table_name)
         end
 
+        #
+        # A reasonable alias for this partition table
+        #
+        def table_alias_name(*partition_key_values)
+          return collect_first(*partition_key_values, &:table_alias_name)
+        end
+
         #
         # The name of the child table without the schema name or name prefix.
         #
@@ -135,6 +146,26 @@ module Partitioned
           return @last_partitions_order_by_clause
         end
 
+        def janitorial_creates_needed
+          unless @janitorial_creates_needed
+            @janitorial_creates_needed = collect_first(&:janitorial_creates_needed)
+          end
+          return @janitorial_creates_needed
+        end
+
+        def janitorial_archives_needed
+          unless @janitorial_archives_needed
+            @janitorial_archives_needed = collect_first(&:janitorial_archives_needed)
+          end
+          return @janitorial_archives_needed
+        end
+
+        def janitorial_drops_needed
+          unless @janitorial_drops_needed
+            @janitorial_drops_needed = collect_first(&:janitorial_drops_needed)
+          end
+          return @janitorial_drops_needed
+        end
 
         protected
 

data/lib/partitioned/partitioned_base/partition_manager.rb

@@ -14,6 +14,17 @@ module Partitioned
         @parent_table_class = parent_table_class
       end
 
+      #
+      # Archive partitions that need such.
+      # uses #archive_old_partition_key_values_set as the list of
+      # partitions to remove.
+      #
+      def archive_old_partitions
+        archive_old_partition_key_values_set.each do |*partition_key_values|
+          archive_old_partition(*partition_key_values)
+        end
+      end
+
       #
       # Drop partitions that are no longer necessary.
       # uses #old_partition_key_values_set as the list of
@@ -64,10 +75,20 @@ module Partitioned
       # Used by #create_new_partitions and generally called once a day to update
       # the database with new soon-to-be needed child tables.
       #
-      # Typically overridden by the concrete class as this is pure business logic.
-      #
       def new_partition_key_values_set
-        []
+        return configurator.janitorial_creates_needed
+      end
+
+      #
+      # An array of key values (each key value is an array of keys) that represent
+      # the child partitions that should be archived probably because they are
+      # about to be dropped.
+      #
+      # Used by #archive_old_partitions and generally called once a day to clean up
+      # unneeded child tables.
+      #
+      def archive_old_partition_key_values_set
+        return configurator.janitorial_archives_needed
       end
 
       #
@@ -77,10 +98,16 @@ module Partitioned
       # Used by #drop_old_partitions and generally called once a day to clean up
       # unneeded child tables.
       #
-      # Typically overridden by the concrete class as this is pure business logic.
-      #
       def old_partition_key_values_set
-        []
+        return configurator.janitorial_drops_needed
+      end
+
+      #
+      # Archive a specific partition from the database given
+      # the key value(s) of its check constraint columns.
+      #
+      def archive_old_partition(*partition_key_values)
+        archive_partition_table(*partition_key_values)
       end
 
       #
@@ -131,10 +158,24 @@ module Partitioned
       # :method: partition_table_name
       # delegated to Partitioned::PartitionedBase::PartitionManager::SqlAdapter#partition_table_name
 
+      ##
+      # :method: partition_table_alias_name
+      # delegated to Partitioned::PartitionedBase::PartitionManager::SqlAdapter#partition_table_alias_name
+
+      ##
+      # :method: sql_adapter
+      # delegated to Partitioned::PartitionedBase#sql_adapter
+
+      ##
+      # :method: configurator
+      # delegated to Partitioned::PartitionedBase#configurator
+
       extend Forwardable
-      def_delegators :parent_table_class, :sql_adapter
+      def_delegators :parent_table_class, :sql_adapter, :configurator
       def_delegators :sql_adapter, :drop_partition_table, :create_partition_table, :add_partition_table_index,
-         :add_references_to_partition_table, :create_partition_schema, :add_parent_table_rules, :partition_table_name
+         :add_references_to_partition_table, :create_partition_schema, :add_parent_table_rules,
+         :partition_table_name, :partition_table_alias_name
+
     end
   end
 end

data/lib/partitioned/partitioned_base/sql_adapter.rb

@@ -126,6 +126,13 @@ module Partitioned
         return configurator.table_name(*partition_key_values)
       end
 
+      #
+      # A reasonable alias for the partition table
+      #
+      def partition_table_alias_name(*partition_key_values)
+        return configurator.table_alias_name(*partition_key_values)
+      end
+
       #
       # Create a single child table.
       #

data/lib/partitioned/partitioned_base.rb

@@ -61,7 +61,7 @@ module Partitioned
     # @return [String] the fully qualified name of the database table, ie: foos_partitions.p17
     def partition_table_name
       symbolized_attributes = attributes.symbolize_keys
-      return self.class.partition_name(*self.class.partition_keys.map{|attribute_name| symbolized_attributes[attribute_name]})
+      return self.class.partition_table_name(*self.class.partition_keys.map{|attribute_name| symbolized_attributes[attribute_name]})
     end
 
     #
@@ -119,7 +119,7 @@ module Partitioned
       new_arel_table = @arel_tables[key_values]
       arel_engine_hash = {:engine => self.arel_engine}
       arel_engine_hash[:as] = as unless as.blank?
-      new_arel_table = Arel::Table.new(self.partition_name(*key_values), arel_engine_hash)
+      new_arel_table = Arel::Table.new(self.partition_table_name(*key_values), arel_engine_hash)
       return new_arel_table
     end
 
@@ -135,19 +135,8 @@ module Partitioned
       return self.class.dynamic_arel_table(key_values, as)
     end
 
-    # :from_partition_scope is generally not used directly,
-    # use helper self.from_partition so that the derived class
-    # can be passed into :from_partition_scope
     #
-    # @return [Hash] the from scoping
-    scope :from_partition_scope, lambda { |target_class, *partition_field|
-      {
-        :from => "#{target_class.partition_name(*partition_field)} AS #{target_class.table_name}"
-      }
-    }
-
-    #
-    # Real scope (uses #from_partition_scope).  This scope is used to target the
+    # This scoping is used to target the
     # active record find() to a specific child table and alias it to the name of the
     # parent table (so activerecord can generally work with it)
     #
@@ -157,29 +146,16 @@ module Partitioned
     #
     # where KEY is the key value(s) used as the check constraint on Foo's table.
     #
-    # Because the scope is specific to a class (a class method) but unlike
-    # class methods is not inherited, one  must use this form (#from_partition) instead
-    # of #from_partition_scope to get the most derived classes specific active record scope.
-    #
     # @param [*Array<Object>] partition_field the field values to partition on
     # @return [Hash] the scoping
     def self.from_partition(*partition_field)
-      from_partition_scope(self, *partition_field)
+      table_alias_name = partition_table_alias_name(*partition_field)
+      from("#{partition_table_name(*partition_field)} AS #{table_alias_name}").
+        tap{|relation| relation.table.table_alias = table_alias_name}
     end
 
-    # :from_partitioned_without_alias_scope is generally not used directly,
-    # use helper self.from_partitioned_without_alias so that the derived class
-    # can be passed into :from_partitioned_without_alias_scope
     #
-    # @return [Hash] the from scoping
-    scope :from_partitioned_without_alias_scope, lambda { |target_class, *partition_field|
-      {
-        :from => target_class.partition_name(*partition_field)
-      }
-    }
-
-    #
-    # Real scope (uses #from_partitioned_without_alias_scope). This scope is used to target the
+    # This scope is used to target the
     # active record find() to a specific child table. Is probably best used in advanced
     # activerecord queries when a number of tables are involved in the query.
     #
@@ -205,7 +181,9 @@ module Partitioned
     # @param [*Array<Object>] partition_field the field values to partition on
     # @return [Hash] the scoping
     def self.from_partitioned_without_alias(*partition_field)
-      from_partitioned_without_alias_scope(self, *partition_field)
+      table_alias_name = partition_table_name(*partition_field)
+      from(table_alias_name).
+        tap{|relation| relation.table.table_alias = table_alias_name}
     end
 
     #
@@ -252,8 +230,24 @@ module Partitioned
       #
       # For a parent table name foos, that would be foos_partitions
       #
+      # N.B.: if the parent table is not in the default schema ("public") the name of the
+      # partition schema is prefixed by the schema name of the parent table and an
+      # underscore.  That is, if a parent table schema/table name is "other.foos"
+      # the schema for its partitions will be "other_foos_partitions"
+      #
       partition.schema_name lambda {|model|
-        return model.table_name + '_partitions'
+        schema_parts = []
+        table_parts = model.table_name.split('.')
+        # table_parts should be either ["table_name"] or ["schema_name", "table_name"]
+        if table_parts.length == 2
+          # XXX should we find the schema_path here and accept anything in the path as "public"
+          unless table_parts.first == "public"
+            schema_parts << table_parts.first
+          end
+        end
+        schema_parts << table_parts.last
+        schema_parts << 'partitions'
+        return schema_parts.join('_')
       }
 
       #
@@ -272,7 +266,9 @@ module Partitioned
       # The child table is defined by the partition key values passed in.
       #
       partition.parent_table_schema_name lambda {|model, *partition_key_values|
-        # this should be a connection_adapter thing
+        table_parts = model.table_name.split('.')
+        # table_parts should be either ["table_name"] or ["schema_name", "table_name"]
+        return table_parts.first if table_parts.length == 2
         return "public"
       }
 
@@ -308,6 +304,13 @@ module Partitioned
         return "#{configurator.schema_name}.#{configurator.part_name(*partition_key_values)}"
       }
 
+      #
+      # A reasonable alias for this table
+      #
+      partition.table_alias_name lambda {|model, *partition_key_values|
+        return model.configurator.parent_table_name(*partition_key_values).gsub('.', '_')
+      }
+
       #
       # The name of the child table without a schema name or prefix. this is used to
       # build child table names for multi-level partitions.
@@ -366,6 +369,13 @@ module Partitioned
       partition_manager.add_parent_table_rules(*partition_key_values)
     end
 
+    ##
+    # :method: archive_old_partitions
+    # delegated to Partitioned::PartitionedBase::PartitionManager#archive_old_partitions
+    def self.archive_old_partitions
+      partition_manager.archive_old_partitions
+    end
+
     ##
     # :method: drop_old_partitions
     # delegated to Partitioned::PartitionedBase::PartitionManager#drop_old_partitions
@@ -380,6 +390,13 @@ module Partitioned
       partition_manager.create_new_partitions
     end
 
+    ##
+    # :method: archive_old_partition
+    # delegated to Partitioned::PartitionedBase::PartitionManager#archive_old_partition
+    def self.archive_old_partition(*partition_key_values)
+      partition_manager.archive_old_partition(*partition_key_values)
+    end
+
     ##
     # :method: drop_old_partition
     # delegated to Partitioned::PartitionedBase::PartitionManager#drop_old_partition
@@ -421,5 +438,12 @@ module Partitioned
     def self.partition_name(*partition_key_values)
       return partition_manager.partition_table_name(*partition_key_values)
     end
+
+    ##
+    # :method: partition_table_alias_name
+    # delegated to Partitioned::PartitionedBase::PartitionManager#partition_table_alias_name
+    def self.partition_table_alias_name(*partition_key_values)
+      return partition_manager.partition_table_alias_name(*partition_key_values)
+    end
   end
 end

data/lib/partitioned/version.rb

@@ -1,4 +1,4 @@
 module Partitioned
   # the current version of this gem
-  VERSION = "1.0.1"
+  VERSION = "1.1.0"
 end

data/partitioned.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |s|
  s.name        = 'partitioned'
  s.version     = Partitioned::VERSION
  s.license     = 'New BSD License'
- s.date        = '2012-03-07'
+ s.date        = '2012-09-11'
  s.summary     = "Postgres table partitioning support for ActiveRecord."
  s.description = "A gem providing support for table partitioning in ActiveRecord. Support is only available for postgres databases. Other features include child table management (creation and deletion) and bulk data creating and updating."
  s.authors     = ["Keith Gabryelski", "Aleksandr Dembskiy"]

data/spec/monkey_patch_posgres_spec.rb

@@ -45,12 +45,12 @@ module ActiveRecord::ConnectionAdapters
       describe "next_sequence_value" do
 
         it "returns next_sequence_value" do
-          ActiveRecord::Base.connection.next_sequence_value(Employee.sequence_name).should == "1"
+          ActiveRecord::Base.connection.next_sequence_value(Employee.sequence_name).should == 1
           ActiveRecord::Base.connection.execute <<-SQL
             insert into employees(name, company_id) values ('Nikita', 1);
           SQL
-          ActiveRecord::Base.connection.next_sequence_value(Employee.sequence_name).should == "3"
-          ActiveRecord::Base.connection.next_sequence_value(Employee.sequence_name).should == "4"
+          ActiveRecord::Base.connection.next_sequence_value(Employee.sequence_name).should == 3
+          ActiveRecord::Base.connection.next_sequence_value(Employee.sequence_name).should == 4
         end
 
       end # next_sequence_value
@@ -173,4 +173,4 @@ module ActiveRecord::ConnectionAdapters
 
   end # PostgreSQLAdapter
 
-end # ActiveRecord::ConnectionAdapters
+end # ActiveRecord::ConnectionAdapters

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: partitioned
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-07 00:00:00.000000000 Z
+date: 2012-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pg
@@ -175,18 +175,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -2034428678854769428
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -2034428678854769428
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24