vitess-activerecord-migration 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3eae6c9228eb8d3d5ebae767cef06ff65c89b073e6598bf690ddbd0907e995a0
-  data.tar.gz: bed613b3ec15ac973a5dabd1957e054d68b5d7adaefb0938af03fba3b7b2be6e
+  metadata.gz: e4e6886e3311d81a26675589df0420f5e4ea72ef3f5b7a4288029ef2feb4542f
+  data.tar.gz: 407235b276dc0f370663348491e03e2cfa6a2ae7b108c67fbd3f66967162561e
 SHA512:
-  metadata.gz: bf5fef0a1132c9cc35a7af3314b64da6669653813d90dc50ddb65018ecfa456dc2c25d1b234a8c9a66a7d8f0838b186a0fa281f05249ef58b15e25b084410085
-  data.tar.gz: 213b03855f9303882dd237db331a7b030f1dfe704d18b70895b71b7dffb120165ce012bb932016dc8ce2ce45e9f18d9722ad77b1b65d6c5acd44ae4e0cf1aec5
+  metadata.gz: d867e55428ac7f48b5a87c34faece5d2de9deab0aa63779b759917e52becb7361cd2c13e8cafb2765008238df62c910392843aa1e2da8795a27c41f97d03820b
+  data.tar.gz: 115075f6113b7b0cf64d2a52b2148048271130c7ded01cdb6ef2367c25b9307b047f3c9ab5990b386f88d9829a816cd765da17d2c318ed99e3e1c97ba385b675

data/README.md

@@ -22,7 +22,7 @@ ActiveRecord::Migration.prepend(Vitess::Activerecord::Migration)
 
 The default ddl strategy is `vitess` with no options.
 
-When you want to set the ddl strategy and its options for one shot, you can set them in the migration file.
+When you want to change the ddl strategy and its options for one shot, you can set them in the migration file.
 
 ```ruby
 def default_ddl_strategy
@@ -35,7 +35,7 @@ def change
 end
 ```
 
-When you want to set the default ddl strategy and its options, you can override the following methods.
+When you want to change the default ddl strategy and its options, you can override the following methods.
 
 ```ruby
 # lib/vitess/activerecord/app_migration.rb
@@ -57,6 +57,24 @@ ActiveRecord::Migration.prepend(Vitess::Activerecord::Migration)
 ActiveRecord::Migration.prepend(Vitess::Activerecord::AppMigration)
 ```
 
+When you want to change the log parameters during the migration, you can override the following method.
+
+```ruby
+# lib/vitess/activerecord/app_migration.rb
+module Vitess
+  module Activerecord
+    module AppMigration
+      def migration_log_columns
+        %w[
+          migration_uuid
+          progress
+          eta_seconds
+        ]
+      end
+    end
+  end
+end
+```
 
 ## Development
 

data/lib/vitess/activerecord/migration/version.rb

@@ -3,7 +3,7 @@
 module Vitess
   module Activerecord
     module Migration
-      VERSION = "0.1.0"
+      VERSION = "0.2.0"
     end
   end
 end

data/lib/vitess/activerecord/migration.rb

@@ -24,6 +24,23 @@ module Vitess
         7200 # 120 minutes
       end
 
+      # Returns the columns of SHOW VITESS_MIGRATIONS to log during the run.
+      #
+      # Override this method if you want to change the default columns.
+      def migration_log_columns
+        %w[
+          migration_uuid
+          migration_statement
+          added_timestamp
+          started_timestamp
+          last_throttled_timestamp
+          last_cutover_attempt_timestamp
+          is_immediate_operation
+          progress
+          eta_seconds
+        ]
+      end
+
       # Override exec_migration to set the default DDL strategy to vitess.
       # This method is called every time a migration is executed.
       # If you want to use a different DDL strategy, call with_ddl_strategy inside the change method or elsewhere.
@@ -103,8 +120,7 @@ module Vitess
             id = migration["id"]
             next if @stopped_uuid.include?(id)
 
-            details = %w[migration_uuid migration_statement added_timestamp started_timestamp is_immediate_operation progress eta_seconds retries]
-            detail_message = details.map { |column| "#{column}: #{migration[column]}" }.join(" | ")
+            detail_message = migration_log_columns.map { |column| "#{column}: #{migration[column]}" }.join(" | ")
             Rails.logger.info("Vitess Migration #{id} checking status, #{detail_message}")
 
             status = migration["migration_status"]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vitess-activerecord-migration
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Yohei Yoshimuta
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-10-07 00:00:00.000000000 Z
+date: 2024-10-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord