history_extension 1.4.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 169fa2f7f855056c7a79fab871e46ad69afe8b65ba42207c95a0d87d82791518
+  data.tar.gz: '086d78982b855aed16c845a4d05b74a3958bdde63b3e5e1531cc04a1f8d79b64'
+SHA512:
+  metadata.gz: dd604fc72a189ab2db6c289da4aff04dd59dcd5e7ab099be8fe713d49e904db6ef6e21cfbc526565f528a5437c9e3ddbc8de8bfee82e96b05a299897285c2126
+  data.tar.gz: e7cb39f842a18bc17cd74842c07a475d5e9f98429d27a2de6d22c7bc7923b2960ce901342c89c5881f88670ab40cabb16bc1a8df2daf256a9d9160222f57f159

data/.gitignore

@@ -0,0 +1,50 @@
+# These are some examples of commonly ignored file patterns.
+# You should customize this list as applicable to your project.
+# Learn more about .gitignore:
+#     https://www.atlassian.com/git/tutorials/saving-changes/gitignore
+
+# Node artifact files
+node_modules/
+dist/
+
+# Compiled Java class files
+*.class
+
+# Compiled Python bytecode
+*.py[cod]
+
+# Log files
+*.log
+
+# Package files
+*.jar
+
+# Maven
+target/
+dist/
+
+# JetBrains IDE
+.idea/
+
+# Unit test reports
+TEST*.xml
+
+# Generated by MacOS
+.DS_Store
+
+# Generated by Windows
+Thumbs.db
+
+# Applications
+*.app
+*.exe
+*.war
+
+# Large media files
+*.mp4
+*.tiff
+*.avi
+*.flv
+*.mov
+*.wmv
+

data/Gemfile

@@ -0,0 +1,3 @@
+source 'http://gems.sd.laxino.com'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    history_extension (1.4.1)
+      bundler (~> 1.12)
+      sequel (= 5.23.0)
+
+GEM
+  remote: http://gems.sd.laxino.com/
+  specs:
+    diff-lcs (1.3)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.2)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.2)
+    sequel (5.23.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  history_extension!
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.6

data/README.md

@@ -0,0 +1,126 @@
+# History Database Extension for Sequel
+
+## Objective
+
+For all application service, we will create a history database to archive the data record from application operation database. The difference of database schema between operation database and history database is mainly in following two points:
+1. Remove index with option operation: :only;
+2. Remove all foreign key constrain;
+3. Remove column with option operation: :only
+
+Before this, we need to maintain two git repositories of the application, one for original application code repository, another mainly for storing the migration script for history database. This approach is facing many challenge when data schema change in term of migration script synchronisation between these two git repository, and this approach need to repeat in all applications.
+
+How to eliminate this challenge? So that we can remain only one migration script in original application code repository, that can run on operation database and history database without any changes.
+
+## Solution
+
+The solution is simple. We create a sequel extension to ignore constrain during index and foreign key creation, so than we can apply this extension on whatever the migration script is applied.
+After read code of sequel and here is the methods in database class need to be overwrite:
+
+```ruby
+=====Index Method=====
+index(columns, opts = OPTS)
+add_index(columns, opts = OPTS)
+drop_index(columns, options=OPTS)
+=====Foreign Key Method=====
+foreign_key(name, table=nil, opts = OPTS)
+add_foreign_key(name, table, opts = OPTS)
+drop_composite_foreign_key(columns, opts)
+add_composite_foreign_key(columns, table, opts)
+=====Support operation options=====
+add_column(name, type, opts = OPTS)
+rename_column(name, new_name, opts = OPTS)
+drop_column(name, opts=OPTS)
+
+```
+
+Detail pls checkout my private repository[histroy_extension](http://stash.mo.laxino.com/users/ben.wu/repos/history_extension/browse)
+
+## Usage
+
+### Foreign Key Removal
+
+Current version of history_extension is 1.1.1, which is deployed to the gem server. To use this gem, first need to add this gem in Gemfile:
+
+```ruby
+gem 'history_extension', '1.0.1'
+```
+
+Next, we need to determine environment valuable to control enable this extension, such as HISTORY and update sequel.rake file:
+
+```ruby
+ namespace :db do
+    require 'sequel'
+------------Add from Here------------------------------
+    if ENV['HISTORY']
+      require 'sequel/extensions/history_extension'
+      Sequel::Database.register_extension(:history_extension, Sequel::HistoryExtension)
+      Sequel::Database.extension :history_extension
+    end
+-----------To Here---------------------------------
+    namespace :migrate do
+      Sequel.extension :migration
+```
+
+### Operation Only Column Removal
+
+In order to remove the column only existing in operation database, we need to add an option to indication it is operation only column and will not migration to history database, here is example in migration script
+
+```ruby
+create_table :properties do
+  primary_key :id
+  String :name
+  String :description
+  Datetime :purge_at, operation: :only
+  index :name
+end
+
+create_table :games do
+  primary_key :id
+  String :name
+  String :description
+  column :purge_at, DateTime, operation: :only
+  index :name, operation: :only
+end
+
+alter_table(:rounds) do
+  add_column :purge_at, DateTime, operation: :only
+end
+
+alter_table(:rounds) do
+  rename_column :purge_at, :purged_at, operation: :only
+end
+```
+
+Currently, we support these column operation to indicate operation option:
+
+* Create Table
+  1. Missing method to define column(such as: DateTime :purge_at, operation: :only)
+  2. column method to define column(such as: column :purge_at, operation: :only)
+
+* Alter Table
+  1. add_column to define column(such as: add_column :purge_at, operation: :only)
+  2. rename_column to rename column(such as: rename_column :purge_at, operation: :only)
+
+But we still have some operations of column are not support operation option:
+1.set_column_default
+2.set_column_type
+3.set_column_allow_null
+4.set_column_allow_not_null
+
+### Command
+Above to check HISTORY environment, if defined, then require extension, register, and extend it in Database Class.
+Here is command to execute for history database migration(using axle as example)
+
+```bash
+HISTORY=true DATABASE_URL='mysql2://laxino:password@10.0.1.2:3306/axle__history' rake db:migrate:up
+```
+
+### Todo
+- [ ] set_column_default
+- [ ] set_column_type
+- [ ] set_column_allow_null
+- [ ] set_column_allow_not_null
+
+
+## Thank you!
+Pls let me know if you have any problems.

data/example/.ruby-version

@@ -0,0 +1 @@
+ruby-2.5.0

data/example/Gemfile

@@ -0,0 +1,6 @@
+source 'http://gems.sd.laxino.com'
+
+gem 'mysql2', '0.5.1'
+gem 'sequel', '5.23.0'
+gem 'rake',   '12.3.1'
+gem 'history_extension', '1.4.0'

data/example/Gemfile.lock

@@ -0,0 +1,21 @@
+GEM
+  remote: http://gems.sd.laxino.com/
+  specs:
+    history_extension (1.4.0)
+      bundler (~> 1.12)
+      sequel (= 5.23.0)
+    mysql2 (0.5.1)
+    rake (12.3.1)
+    sequel (5.23.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  history_extension (= 1.4.0)
+  mysql2 (= 0.5.1)
+  rake (= 12.3.1)
+  sequel (= 5.23.0)
+
+BUNDLED WITH
+   1.16.6

data/example/MIGRATION_SCRIPT_WRITING_GUIDELINE.md

@@ -0,0 +1,3 @@
+# Migration Script Writing Guideline
+
+Pls refer confluence page: http://conf.sd.laxino.com/display/OP/Migration+Script+Writing+Guideline

data/example/Rakefile.rb

@@ -0,0 +1,12 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+# require(File.join(File.dirname(__FILE__), 'config', 'boot'))
+
+require 'rake'
+require 'rake/testtask'
+#require 'rake/rdoctask'
+require 'rdoc/task'
+Dir.glob('tasks/*.rake').each { |r| import r }
+
+task :default => :spec

data/example/db/migrations/201703210929_create_properties.rb

@@ -0,0 +1,18 @@
+Sequel.migration do
+  up do
+    create_table :properties do |t|
+      primary_key :id
+      column :created_at, DateTime, null: false
+      column :updated_at, DateTime, null: false
+      column :purge_at,   DateTime, operation: :only
+    end
+
+    alter_table :properties do |t|
+      set_column_type(:id, "int unsigned")
+    end
+  end
+
+  down do
+    drop_table :properties
+  end
+end

data/example/db/migrations/201703210930_create_players.rb

@@ -0,0 +1,17 @@
+Sequel.migration do
+  up do
+    create_table :players do |t|
+      primary_key :id
+      foreign_key :property_id, :properties, type: "int unsigned", null: false, key: [:id]
+      String :name
+      String :description
+      Datetime :purge_at, operation: :only
+      index :name
+      index :purge_at, operation: :only
+    end
+  end
+
+  down do
+    drop_table :players
+  end
+end

data/example/db/migrations/201703291142_add_token_to_players.rb

@@ -0,0 +1,13 @@
+Sequel.migration do
+  up do
+    alter_table :players do |t|
+      add_column :token, String, operation: :only
+    end
+  end
+
+  down do
+    alter_table :players do |t|
+      drop_column :token, operation: :only
+    end
+  end
+end

data/example/db/migrations/201703291144_add_index_to_players_token.rb

@@ -0,0 +1,13 @@
+Sequel.migration do
+  up do
+    alter_table :players do |t|
+      add_index :token, operation: :only
+    end
+  end
+
+  down do
+    alter_table :players do |t|
+      drop_index :token, operation: :only
+    end
+  end
+end

data/example/db/migrations/201703291145_add_index_to_players_description.rb

@@ -0,0 +1,13 @@
+Sequel.migration do
+  up do
+    alter_table :players do |t|
+      add_index :description, operation: :only
+    end
+  end
+
+  down do
+    alter_table :players do |t|
+      drop_index :description, operation: :only
+    end
+  end
+end

data/example/tasks/sequel.rake

@@ -0,0 +1,46 @@
+  namespace :db do
+    require 'sequel'
+    if ENV['HISTORY']
+      require 'sequel/extensions/history_extension'
+      Sequel::Database.register_extension(:history_extension, Sequel::HistoryExtension)
+      Sequel::Database.extension :history_extension
+    end
+    namespace :migrate do
+      Sequel.extension :migration
+      task :connect do
+        url = ENV['DATABASE_URL'] || "#{ENV.fetch('MYSQL_ADAPTER', 'mysql2')}://#{ENV.fetch('MYSQL_USER', 'laxino')}:#{ENV.fetch('MYSQL_PASSWORD', 'password')}@#{ENV.fetch('MYSQL_HOST', 'db')}/#{ENV.fetch('MYSQL_DATABASE', 'application')}"
+        DB = Sequel.connect(url)
+      end
+
+      desc 'Perform migration reset (full erase and migration up).'
+      task :reset => [:connect] do
+        Sequel::Migrator.run(DB, 'db/migrations', :target => 0, :allow_missing_migration_files => true)
+        Sequel::Migrator.run(DB, 'db/migrations', :allow_missing_migration_files => true)
+        puts '*** db:migrate:reset executed ***'
+      end
+
+      desc 'Perform migration up/down to VERSION.'
+      task :to => [:connect] do
+        version = ENV['VERSION'].to_i
+        if version == 0
+          puts 'VERSION must be larger than 0. Use rake db:migrate:down to erase all data.'
+          exit false
+        end
+
+        Sequel::Migrator.run(DB, 'db/migrations', :target => version, :allow_missing_migration_files => true)
+        puts "*** db:migrate:to VERSION=[#{version}] executed ***"
+      end
+
+      desc 'Perform migration up to latest migration available.'
+      task :up => [:connect] do
+        Sequel::Migrator.run(DB, 'db/migrations', :allow_missing_migration_files => true)
+        puts '*** db:migrate:up executed ***'
+      end
+
+      desc 'Perform migration down (erase all data).'
+      task :down => [:connect] do
+        Sequel::Migrator.run(DB, 'db/migrations', :target => 0, :allow_missing_migration_files => true)
+        puts '*** db:migrate:down executed ***'
+      end
+    end
+  end

data/history_extension.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "history_extension"
+  spec.version       = Sequel::HistoryExtension::VERSION
+  spec.authors       = ["Ben Wu"]
+  spec.email         = ["ben.wu@laxino.com"]
+
+  spec.summary       = %q{Sequel Extension for History DB Migration.}
+  spec.description   = %q{Sequel Extension for History DB Migration, to remove index and foreign key constrain}
+  spec.homepage      = "http://github.com/cheokman"
+
+  # 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 { |f| f.match(%r{^(test|spec|features)/}) }
+  #spec.files         =  %w(LICENSE CHANGELOG.md README.md) + Dir["{spec,lib}/**/*.{rb,RB}"]
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "rspec", "~> 3.0"
+
+  spec.add_dependency "bundler", "~> 1.12"
+  spec.add_runtime_dependency 'sequel', '5.23.0'
+end

data/lib/sequel/extensions/history_extension.rb

@@ -0,0 +1,82 @@
+module Sequel
+  module HistoryExtension
+    def create_table_generator(&block)
+      super do
+        extend HistoryCreateExtensionMethods
+        instance_eval(&block) if block
+      end
+    end
+
+    def alter_table_generator(&block)
+      super do
+        extend HistoryAlterExtensionMethods
+        instance_eval(&block) if block
+      end
+    end
+
+    module HistoryCreateExtensionMethods
+      def column(name, type, opts = OPTS)
+        return if opts[:operation] == :only
+        self.class.instance_method(:column).bind(self).call(name, type, opts)
+      end
+
+      def index(columns, opts = OPTS)
+        return if opts[:operation] == :only
+        self.class.instance_method(:index).bind(self).call(columns, opts)
+      end
+
+      def foreign_key(name, table=nil, opts = OPTS)
+        self.class.instance_method(:foreign_key).bind(self).call(name,nil,opts)
+      end
+
+      private
+
+      # Add a composite foreign key constraint
+      def composite_foreign_key(columns, opts); end
+    end
+
+    module HistoryAlterExtensionMethods
+      #
+      # TODO support column operation:
+      #. set_column_default
+      #. set_column_type
+      #. set_column_allow_null
+      #. set_column_allow_not_null
+      #
+      def add_index(columns, opts = OPTS)
+        return if opts[:operation] == :only
+        self.class.instance_method(:add_index).bind(self).call(columns, opts)
+      end
+
+      def drop_index(columns, opts=OPTS)
+        return if opts[:operation] == :only
+        self.class.instance_method(:drop_index).bind(self).call(columns, opts)
+      end
+
+      def add_column(name, type, opts = OPTS)
+        return if opts[:operation] == :only
+        self.class.instance_method(:add_column).bind(self).call(name, type, opts)
+      end
+
+      def rename_column(name, new_name, opts = OPTS)
+        return if opts[:operation] == :only
+        self.class.instance_method(:rename_column).bind(self).call(name, new_name, opts)
+      end
+
+      def drop_column(name, opts=OPTS)
+        return if opts[:operation] == :only
+        self.class.instance_method(:drop_column).bind(self).call(name, opts)
+      end
+
+      def add_foreign_key(name, table, opts = OPTS)
+        self.class.instance_method(:add_foreign_key).bind(self).call(name, nil, opts)
+      end
+
+      private
+
+      def drop_composite_foreign_key(columns, opts); end
+
+      def add_composite_foreign_key(columns, table, opts); end
+    end
+  end
+end

data/lib/version.rb

@@ -0,0 +1,5 @@
+module Sequel
+  module HistoryExtension
+    VERSION = '1.4.1'
+  end
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: history_extension
+version: !ruby/object:Gem::Version
+  version: 1.4.1
+platform: ruby
+authors:
+- Ben Wu
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2024-06-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: sequel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 5.23.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 5.23.0
+description: Sequel Extension for History DB Migration, to remove index and foreign
+  key constrain
+email:
+- ben.wu@laxino.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- README.md
+- example/.ruby-version
+- example/Gemfile
+- example/Gemfile.lock
+- example/MIGRATION_SCRIPT_WRITING_GUIDELINE.md
+- example/Rakefile.rb
+- example/db/migrations/201703210929_create_properties.rb
+- example/db/migrations/201703210930_create_players.rb
+- example/db/migrations/201703291142_add_token_to_players.rb
+- example/db/migrations/201703291144_add_index_to_players_token.rb
+- example/db/migrations/201703291145_add_index_to_players_description.rb
+- example/tasks/sequel.rake
+- history_extension.gemspec
+- lib/sequel/extensions/history_extension.rb
+- lib/version.rb
+homepage: http://github.com/cheokman
+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.0.3.1
+signing_key: 
+specification_version: 4
+summary: Sequel Extension for History DB Migration.
+test_files: []