partitioner_pg 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: b4fb71f05532ad74b92aed33d82c8ba773818fb6
-  data.tar.gz: bac1502e2523fc7a3819feb15f427883d02cba79
+SHA256:
+  metadata.gz: e30a831e9e29196be95988158811a18398422ae7bd0ad6301906778f4f1fcd0a
+  data.tar.gz: 134c8445b3610c98365fca4b0a066ef668b368592b4094c53479acca5961ef33
 SHA512:
-  metadata.gz: ae342aa32bef1f79728cf5e4e8d700362f1b0f576e7b4bd9e82cbbee679f4d582cecee4a535c16ada96cbab5fa03a78c4cb066b7e33355dee4e4ac523819d5d5
-  data.tar.gz: b0b9b211ae6db60edda1cb7cebf2f379fb3158dfdde81cc1d0f8c784330b817df80c386539cceaed43761a2a6680e5a150780fce6e08dbf68e3df17ac75537c6
+  metadata.gz: 7630fafde31ad687310dfce98bfa55719cf52038ec6a293be0bf484b875d0902f782d038ab188e8bfe823ac7f07f5d60295a476ad520d5d35e02ec71f5be2e6b
+  data.tar.gz: 2c940f85492295a3eb8cd23bc324c397991cd6bebacb0a360f7b07fcb3419bdd18defbf25f3f228e9a20c9ddf656b1d5ae3550b63d6222e3cf485d258bda7a71

data/README.md

@@ -1,36 +1,79 @@
-# Partitioner
+# PartitionerPg
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/partitioner`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+It's a gem for a partitioning Postgresql tables in Ruby on Rails.
+Now gem can help you with partitioning tables by months. New table for each month.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'partitioner'
+gem 'partitioner_pg'
 ```
 
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install partitioner
-
 ## Usage
 
-TODO: Write usage instructions here
-
-## Development
+1) Include PartitionerPg into your model: `include PartitionerPg`. Also, you can specify parting column and some indexes.
+Example:
+```ruby
+class YourModelName < ActiveRecord::Base
+  include PartitionerPg
+  
+  # Point date or datetime column which will be used for monthly partitioning. Optional (:created_at uses by default)
+  def self.parting_column
+    :date
+  end
+
+  # List of indexes. Names of indexes will be generated by active migration. Optional.
+  def self.partition_table_indexes
+    [
+      %w[column1 column2]
+    ]
+  end
+  
+  # Map of indexes. Full name of named index will be generated as "index_[partition_name]_[name_of_index_from_map]". Optional.
+  def self.partition_table_named_indexes
+    {
+      :three_cols => %w[column1 column2 column3]
+    }  
+  end
+  
+  # List of unique indexes. Names of indexes wiil be generated by active migration. Optional.
+  def self.partition_table_unique_indexes
+    [
+      %w[column1 column2 column3 column4]
+    ]
+  end
+  
+  # Map of named unique indexes. Optional.
+  def self.partition_table_named_unique_indexes
+    {
+      :uniq => %w[column5 column6 column7]
+    }
+  end
+end
+```
+2) Create migration and add some instructions to it. Generate migration:
 
-After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+```
+rails g migration make_partitioning_of_you_table
+```
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+add instructions to migration:
 
-## Contributing
+```ruby
+class YouMigrationClassName
+  def change
+    YourModel.create_partitioning_by_month_trigger_sql
+    YourModel.create_month_table
+    YourModel.create_next_month_table
+  end
+end
+```
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/partitioner. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+3) For correct work you need to create next partition every month.
+  We recommend you to create a rake task and run it once a month by crontab. Code for a rake task:
 
+```ruby
+YourModel.create_next_month_table
+```

data/lib/partitioner_pg/separation_type/month.rb

@@ -12,12 +12,18 @@ module PartitionerPg
       def create_month_table(date=Date.today)
         date_start = date.at_beginning_of_month
         date_end = date.at_beginning_of_month.next_month
-        sql = "CREATE TABLE IF NOT EXISTS #{name_of_partition_table(date)} (
-               CHECK ( created_at >= DATE('#{date_start}') AND created_at < DATE('#{date_end}') )
+        partition_table_name = name_of_partition_table(date)
+        sql = "CREATE TABLE IF NOT EXISTS #{partition_table_name} (
+               CHECK ( #{parting_column} >= DATE('#{date_start}') AND #{parting_column} < DATE('#{date_end}') )
                ) INHERITS (#{table_name});"
         execute_sql(sql)
-        sql = "ALTER TABLE #{name_of_partition_table(date)} ADD PRIMARY KEY (id);"
+        sql = "ALTER TABLE #{partition_table_name} ADD PRIMARY KEY (id);"
         execute_sql(sql)
+
+        create_partition_indexes(partition_table_name)
+        create_partition_named_indexes(partition_table_name)
+        create_partition_unique_indexes(partition_table_name)
+        create_partition_named_unique_indexes(partition_table_name)
       end
 
       def drop_month_table(date=Date.today)
@@ -33,8 +39,8 @@ module PartitionerPg
              curM varchar(2);
              tbl varchar(30);
            BEGIN
-              select cast(DATE_PART('year', new.created_at) as varchar) into curY;
-              select lpad(cast(DATE_PART('month', new.created_at) as varchar), 2, '0') into curM;
+              select cast(DATE_PART('year', new.#{parting_column}) as varchar) into curY;
+              select lpad(cast(DATE_PART('month', new.#{parting_column}) as varchar), 2, '0') into curM;
               tbl := '#{table_name}_y' || curY || 'm' || curM;
               EXECUTE format('INSERT into %I values ($1.*);', tbl) USING NEW;
               return NEW;
@@ -72,9 +78,76 @@ module PartitionerPg
          DROP FUNCTION #{table_name}_delete_trigger();"
       end
 
+      def create_partition_indexes(partition_table_name)
+        custom_indexes = partition_table_indexes.presence
+        return unless custom_indexes
+
+        custom_indexes.each { |custom_index| create_custom_index(partition_table_name, custom_index) }
+      end
+
+      def create_partition_named_indexes(partition_table_name)
+        custom_indexes = partition_table_named_indexes.presence
+        return unless custom_indexes
+
+        custom_indexes.map{|name, custom_index|
+          index_name = "index_#{partition_table_name}_#{name}"
+          create_custom_named_index(partition_table_name, custom_index, index_name)
+        }
+      end
+
+      def create_partition_unique_indexes(partition_table_name)
+        custom_unique_indexes = partition_table_unique_indexes.presence
+        return unless custom_unique_indexes
+
+        custom_unique_indexes.each { |custom_index| create_custom_index(partition_table_name, custom_index, true) }
+      end
+
+      def create_partition_named_unique_indexes(partition_table_name)
+        custom_indexes = partition_table_named_unique_indexes.presence
+        return unless custom_indexes
+
+        custom_indexes.map{|name, custom_index|
+          index_name = "index_#{partition_table_name}_#{name}"
+          create_custom_named_index(partition_table_name, custom_index, index_name, true)
+        }
+      end
+
+      def create_custom_index(table_name, index_fields, is_unique = false)
+        ActiveRecord::Migration.add_index table_name, index_fields, unique: is_unique
+      end
+
+      def create_custom_named_index(table_name, index_fields, name, is_unique = false)
+        ActiveRecord::Migration.add_index table_name, index_fields, name: name, unique: is_unique
+      end
+
       def name_of_partition_table(date=Date.today)
         date.strftime("#{table_name}_y%Ym%m")
       end
+
+      # Template method
+      # Column which will determine partition for row (must be date or datetime type). Default value is :created_at
+      def parting_column
+        :created_at
+      end
+
+      # Template method
+      def partition_table_indexes
+        #
+      end
+
+      def partition_table_named_indexes
+        #
+      end
+
+      # Template method
+      def partition_table_unique_indexes
+        #
+      end
+
+      # Template method
+      def partition_table_named_unique_indexes
+        #
+      end
     end
   end
 end

data/lib/partitioner_pg/version.rb

@@ -1,3 +1,3 @@
 module PartitionerPg
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: partitioner_pg
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Aleksander Nikulin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-08-24 00:00:00.000000000 Z
+date: 2018-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -76,7 +76,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: Gem for a partitoning PG tables