pg_partitioner 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ad50f500db988df0b9399ef603c453e2bc9b0ce6d7ce0b125649a59e17790239
+  data.tar.gz: cfa5c1befeecc7a4029a28423ae106e5e23ce855d018c1a58b02bb05e475e6e9
+SHA512:
+  metadata.gz: 996cac41d300d33993934556b190f44beb9aef5816ae5b478d2cc7a18ea13fe3ab654e871e40d0565a426f77ba0931cda4a09e9248f2be68fc2dc7df89cac987
+  data.tar.gz: d32a8af42bcd352cf688b1db13e69cfc156fb64029e7ebb608eced97ced5a0fb88bb173dddc70051358b57c29e0e47d21dc5454f3ecbbbfe0a960d14111ef45b

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in partitioner_pg.gemspec
+gemspec

data/README.md

@@ -0,0 +1,79 @@
+# PgPartitioner
+
+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_pg'
+```
+
+## Usage
+
+1) Include PartitionerPg into your model: `include PartitionerPg`. Also, you can specify parting column and some indexes.
+Example:
+```ruby
+class YourModelName < ActiveRecord::Base
+  extend PartitionerPg::SeparationType::Month
+
+  # 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:
+
+```
+rails g migration make_partitioning_of_you_table
+```
+
+add instructions to migration:
+
+```ruby
+class YouMigrationClassName
+  def change
+    YourModel.create_partitioning_by_month_trigger_sql
+    YourModel.create_current_month_table
+    YourModel.create_next_month_table
+  end
+end
+```
+
+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/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "partitioner"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/partitioner_pg/separation_type/month.rb

@@ -0,0 +1,155 @@
+module PartitionerPg
+  module SeparationType
+    module Month
+      def create_current_month_table
+        create_month_tablecreate_month_table(Date.today)
+      end
+
+      def create_next_month_table
+        create_month_table(Date.today.next_month)
+      end
+
+      def drop_old_month_table
+        drop_month_table(Date.today.prev_month.prev_month)
+      end
+
+      def create_month_table(date = Date.today)
+        date_start = date.at_beginning_of_month
+        date_end = date.at_beginning_of_month.next_month
+        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 #{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)
+        sql = "DROP TABLE IF EXISTS #{name_of_partition_table(date)};"
+        execute_sql(sql)
+      end
+
+      def create_partitioning_by_month_trigger_sql
+        sql = "CREATE OR REPLACE FUNCTION #{table_name}_insert_trigger() RETURNS trigger AS
+    $$
+           DECLARE
+             curY varchar(4);
+             curM varchar(2);
+             tbl varchar(30);
+           BEGIN
+              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;
+           END;
+           $$
+         LANGUAGE plpgsql;
+
+         CREATE TRIGGER #{table_name}_insert
+         BEFORE INSERT ON #{table_name}
+         FOR EACH ROW
+         EXECUTE PROCEDURE #{table_name}_insert_trigger();
+
+         -- Trigger function to delete from the master table after the insert
+         CREATE OR REPLACE FUNCTION #{table_name}_delete_trigger() RETURNS trigger
+             AS $$
+         DECLARE
+             r #{table_name}%rowtype;
+         BEGIN
+             DELETE FROM ONLY #{table_name} where id = new.id returning * into r;
+             RETURN r;
+         end;
+         $$
+         LANGUAGE plpgsql;
+
+         CREATE TRIGGER #{table_name}_after_insert
+         AFTER INSERT ON #{table_name}
+         FOR EACH ROW
+         EXECUTE PROCEDURE #{table_name}_delete_trigger();"
+
+        execute_sql(sql)
+      end
+
+      def drop_partitioning_by_month_trigger_sql
+        "DROP TRIGGER #{table_name}_insert ON #{table_name};
+         DROP FUNCTION #{table_name}_insert_trigger();
+         DROP TRIGGER #{table_name}_after_insert ON #{table_name};
+         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 do |name, custom_index|
+          index_name = "index_#{partition_table_name}_#{name}"
+          create_custom_named_index(partition_table_name, custom_index, index_name)
+        end
+      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 do |name, custom_index|
+          index_name = "index_#{partition_table_name}_#{name}"
+          create_custom_named_index(partition_table_name, custom_index, index_name, true)
+        end
+      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
+
+      def execute_sql(sql_string)
+        ActiveRecord::Base.connection.execute(sql_string)
+      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

@@ -0,0 +1,3 @@
+module PartitionerPg
+  VERSION = '0.1.0'
+end

data/lib/partitioner_pg.rb

@@ -0,0 +1,28 @@
+require "partitioner_pg/version"
+require "partitioner_pg/separation_type/month"
+
+module PartitionerPg
+  extend ActiveSupport::Concern
+
+  #available types - :month
+  def initialize(type)
+    @type = type
+  end
+
+  module ClassMethods
+    include SeparationType::Month
+
+    def partitioner_pg(type)
+      new(type.to_sym)
+      puts TEST0
+    end
+
+    private
+
+    def execute_sql(sql)
+      connection.execute(sql)
+    end
+
+  end
+
+end

data/partitioner_pg.gemspec

@@ -0,0 +1,33 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'partitioner_pg/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'pg_partitioner'
+  spec.version       = PartitionerPg::VERSION
+  spec.authors       = ['Ovsapyan Mishel']
+  spec.email         = ['ovasapyan.mn@gmail.com']
+
+  spec.summary       = 'Gem for a partitoning PG tables'
+  spec.description   = 'Gem for a partitoning PG tables'
+  spec.homepage      = 'http://appodeal.com'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
+  end
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: pg_partitioner
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ovsapyan Mishel
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-10-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Gem for a partitoning PG tables
+email:
+- ovasapyan.mn@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/partitioner_pg.rb
+- lib/partitioner_pg/separation_type/month.rb
+- lib/partitioner_pg/version.rb
+- partitioner_pg.gemspec
+homepage: http://appodeal.com
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key:
+specification_version: 4
+summary: Gem for a partitoning PG tables
+test_files: []