ec-pg 0.1.3 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 615463774272fc429a2f2dfe75db88f133cdd4507b5d5d94147ff84da214a220
-  data.tar.gz: f23f77f305c261f719a37a79d9728aba485a7b214332b08abc87abcab2330421
+  metadata.gz: 63b59448c98ca14882ddcd20aab8efd9e35c3d970891ca2f97722a539ec31bd1
+  data.tar.gz: 592bba1d9afb65ca9ad8b49baa45b217c0f6872e5558abb90a0044e0e8a7b6ea
 SHA512:
-  metadata.gz: 27e2de6ff3980f2ff75160147fcfc87dd1ad2b5f4f3965bde1601883c23bfa637fc0c38ce93d6b7a3b4f2d537eb8835252026781e162a7324e3951f2e216ae22
-  data.tar.gz: f8135d52f5fd32e97a6e992b6930b0a19b14a27d3e926d6ef03ae19df960baf72ca54557c8d8e5dad0184b6f4360b69cae9be961cac084bc452558362fb7e35f
+  metadata.gz: 38921ca6212c3e0a5468db148a1b663adccc23c463c8fc12c2b00a497b6696a83109e8b76c2597c947e06afbf1878607beb235532ab2b64157f7497c2d913391
+  data.tar.gz: aa7e5b7f89c86a26c0f1171f227fb4a5664a2fc6d381f263c69368a11347acb8c8571da3b1f22baff9322468d34c5a1e0c9c2e58f15fa0061d0bdc3a5c99472a

data/lib/ec/pg/migrator.rb

@@ -5,116 +5,58 @@ module Ec
     # Runs ActiveRecord migrations in the context of a specific schema or shard.
     #
     # == Schema migrations
-    #
-    # Sets search_path to the target schema before running migrations so that
-    # Rails creates (and tracks via schema_migrations) tables inside that schema.
-    #
-    #   Migrator.migrate_schema("tenant_abc")
-    #   Migrator.migrate_schema("tenant_abc", version: 20240101120000)
-    #   Migrator.rollback_schema("tenant_abc", steps: 2)
-    #
-    #   Migrator.migrate_each_schema(["tenant_a", "tenant_b"])
-    #
-    # == Shard migrations
-    #
-    # Connects to the target shard before running migrations.
-    #
-    #   Migrator.migrate_shard(:shard_one)
-    #   Migrator.rollback_shard(:shard_one, steps: 1)
-    #
-    #   # Migrate all shards derived from configuration.number_of_shards
-    #   Migrator.migrate_each_shard
-    #
-    #   # Or supply an explicit list
-    #   Migrator.migrate_each_shard([:shard_one, :shard_two])
-    #
     class Migrator
       class << self
-        # Runs pending migrations with search_path set to +schema_name+.
-        #
-        # @param schema_name [String]
-        # @param paths   [Array<String>] migration paths (defaults to Rails configured paths)
-        # @param version  [Integer, nil] target version; migrates to latest when nil
-        def migrate_schema(connection, schema_name, paths: nil, version: nil)
-          Ec::Pg.dprint("Running migration for: #{schema_name}".red)
-          connection.schema_search_path = schema_name
-          run_migrations(connection, paths: paths, version: version)
-        end
 
+        # Runs pending migrations on all schemas
+        #
         def migrate_all_schemas 
           Ec::Pg::SchemaMixin.registered_models.each do |model|
             model.schemas.each do |shard, schemas|
               Ec::Pg.switch(shard: shard) do 
-                schemas.each do |schema|
-                  Ec::Pg.dprint("migrating model: #{model}, shard: #{shard}, schema: #{schema}")
-                    migrate_schema(model.connection, schema)
+                schemas.each do |schema_name|
+                  Ec::Pg.dprint("migrating model: #{model}, shard: #{shard}, schema: #{schema_name}".red)
+                  migrate_schema(model.connection, schema_name)
                 end
               end
             end
           end
         end
 
-        # Calls {migrate_schema} for each name in +schema_names+.
+        # Rollsback schemas
         #
-        # @param schema_names [Array<String>]
-        def migrate_each_schema(connection, schema_names, paths: nil, version: nil)
-          schema_names.each { |name| migrate_schema(connection, name, paths: paths, version: version) }
-        end
-
-        # Rolls back +steps+ migrations with search_path set to +schema_name+.
-        #
-        # @param schema_name [String]
-        # @param steps  [Integer] number of migrations to roll back (default 1)
-        def rollback_schema(schema_name, steps: 1, paths: nil)
-          SchemaManager.with_schema(schema_name) do
-            build_context(paths).rollback(steps)
+        def rollback_all_schemas(steps: 1)
+          Ec::Pg::SchemaMixin.registered_models.each do |model|
+            model.schemas.each do |shard, schemas|
+              Ec::Pg.switch(shard: shard) do 
+                schemas.each do |schema_name|
+                  Ec::Pg.dprint("rolling back model: #{model}, shard: #{shard}, schema: #{schema_name}".red)
+                  rollback_schema(model.connection, schema_name, steps)
+                end
+              end
+            end
           end
         end
 
-        # Runs pending migrations connected to +shard_name+.
-        #
-        # @param shard_name [Symbol]
-        # @param paths  [Array<String>]
-        # @param version [Integer, nil]
-        def migrate_shard(shard_name, paths: nil, version: nil)
-          ShardManager.with_shard(shard_name) do
-            run_migrations(paths: paths, version: version)
-          end
-        end
 
-        # Calls {migrate_shard} for each name in +shard_names+.
-        # When +shard_names+ is omitted, derives +:shard_1+ through +:shard_N+
-        # from +configuration.number_of_shards+.
-        #
-        # @param shard_names [Array<Symbol>, nil]
-        def migrate_each_shard(shard_names = nil, paths: nil, version: nil)
-          (shard_names || default_shards).each do |name|
-            migrate_shard(name, paths: paths, version: version)
+        private
+
+        def rollback_schema(connection, schema_name, steps)
+          with_pool(connection, schema_name) do |pool|
+            pool.migration_context.rollback(steps)
           end
         end
 
-        # Rolls back +steps+ migrations connected to +shard_name+.
-        #
-        # @param shard_name [Symbol]
-        # @param steps  [Integer]
-        def rollback_shard(shard_name, steps: 1, paths: nil)
-          ShardManager.with_shard(shard_name) do
-            build_context(paths).rollback(steps)
+        def migrate_schema(pool, schema_name)
+          with_pool(connection, schema_name) do |pool|
+            pool.migration_context.migrate
           end
         end
 
-        private
-
-        def run_migrations(connection, paths: nil, version: nil)
-          Ec::Pg.dprint("migrations_path: #{paths}")
-
+        def with_pool(connection, schema_name)
           ActiveRecord::Base.establish_connection(connection.pool.db_config)
-          connection.pool.migration_context.migrate
-        end
-
-        def default_shards
-          n = Ec::Pg.configuration.number_of_shards
-          (1..n).map { |i| :"shard_#{i}" }
+          connection.schema_search_path = schema_name
+          yield(connection.pool)
         end
       end
     end

data/lib/ec/pg/version.rb

@@ -2,6 +2,6 @@
 
 module Ec
   module Pg
-    VERSION = "0.1.3"
+    VERSION = "0.1.5"
   end
 end

data/lib/tasks/ec_pg_migrate.rake

@@ -4,9 +4,9 @@ namespace :ec_pg do
   # ---------------------------------------------------------------------------
   # Migrations
   # ---------------------------------------------------------------------------
-  namespace :migrate do
+  namespace :schemas do
     task preload_models: :environment do  
-      if ENV['CPG_DEBUG']
+      if ENV['ECPG_DEBUG']
         ActiveRecord::Base.logger = Logger.new(STDOUT)
       end
 
@@ -15,46 +15,15 @@ namespace :ec_pg do
       end
     end
 
-    desc "Migrate a single schema.  Usage: rake 'ec_pg:migrate:schema[name]'"
-    task :schema, [:name] => :environment do |_, args|
-      name = args[:name] or abort "Usage: rake 'ec_pg:migrate:schema[schema_name]'"
-      Ec::Pg::Migrator.migrate_schema(name)
-      puts "Schema '#{name}' migrated."
-    end
-
-    desc "Migrate comma-separated schemas.  Usage: rake 'ec_pg:migrate:schemas[tenant_a,tenant_b]'"
-    task :schemas => :preload_models do 
+    desc "Migrate all schemas including public."
+    task :migrate => :preload_models do 
       Ec::Pg::Migrator.migrate_all_schemas
     end
 
-    desc "Roll back a schema.  Usage: rake 'ec_pg:migrate:rollback_schema[name]' or '[name,2]'"
-    task :rollback_schema, [:name, :steps] => :environment do |_, args|
-      name  = args[:name]  or abort "Usage: rake 'ec_pg:migrate:rollback_schema[name]'"
-      steps = args[:steps]&.to_i || 1
-      Ec::Pg::Migrator.rollback_schema(name, steps: steps)
-      puts "Rolled back #{steps} migration(s) in schema '#{name}'."
-    end
-
-    desc "Migrate a single shard.  Usage: rake 'ec_pg:migrate:shard[shard_one]'"
-    task :shard, [:name] => :environment do |_, args|
-      name = args[:name] or abort "Usage: rake 'ec_pg:migrate:shard[shard_name]'"
-      Ec::Pg::Migrator.migrate_shard(name.to_sym)
-      puts "Shard '#{name}' migrated."
-    end
-
-    desc "Migrate all shards (derived from configuration.number_of_shards, or explicit list)"
-    task :shards, [:names] => :environment do |_, args|
-      shards = args[:names]&.split(",")&.map { |s| s.strip.to_sym }
-      Ec::Pg::Migrator.migrate_each_shard(shards)
-      puts "All shards migrated."
-    end
-
-    desc "Roll back a shard.  Usage: rake 'ec_pg:migrate:rollback_shard[shard_one]' or '[shard_one,2]'"
-    task :rollback_shard, [:name, :steps] => :environment do |_, args|
-      name  = args[:name]  or abort "Usage: rake 'ec_pg:migrate:rollback_shard[name]'"
-      steps = args[:steps]&.to_i || 1
-      Ec::Pg::Migrator.rollback_shard(name.to_sym, steps: steps)
-      puts "Rolled back #{steps} migration(s) in shard '#{name}'."
+    desc "Rollback all schemas including public. Usage: rake 'ec_pg:schemas:rollback[2]"
+    task :rollback, [:steps] => :preload_models do |_, args|
+      steps  = args[:steps]&.to_i || 1
+      Ec::Pg::Migrator.rollback_all_schemas(steps: steps)
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ec-pg
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.5
 platform: ruby
 authors:
 - gmhawash