OnlineMigrations changelog

Changelog History

• v0.5.2 Changes

  October 04, 2022

  • 🛠 Fix sequence resetting in tests that use fixtures

  • Fix update_column_in_batches for SQL subquery values

    It generated inefficient queries before, e.g.:

    update_column_in_batches(:users, :comments_count, Arel.sql(<<~SQL))
      (select count(*) from comments where comments.user_id = users.id)
    SQL
    

    Generated SQL queries before:

    update users
    set comments_count = (..count subquery..)
    where comments_count is null or comments_count != (..count subquery..)
    

    Generated SQL queries now:

    update users set comments_count = (..count subquery..)
    

  • 🛠 Fix check for add_column with default: nil for PostgreSQL < 11

  • Replacing a unique index when other unique index with the prefix of columns exists is safe

• v0.5.1 Changes

  July 19, 2022

  • Raise for possible index corruption in all environments (previously, the check was made only in the production environment)

• v0.5.0 Changes

  June 23, 2022

  • ➕ Added check for index corruption with PostgreSQL 14.0 to 14.3

  • 🚚 No need to separately remove indexes when removing a column from the small table

  • ➕ Add ability to perform specific action on a relation or individual records using background migrations

    Example, assuming you have lots and lots of fraud likes:

    class DeleteFraudLikes < ActiveRecord::Migration[7.0]
      def up
        perform_action_on_relation_in_background("Like", { fraud: true }, :delete_all)
      end
    end
    

    Example, assuming you added a new column to the users and want to populate it:

    class User < ApplicationRecord
      def generate_invite_token
        self.invite_token = # some complex logic
      end
    end
    
    perform_action_on_relation_in_background("User", { invite_token: nil }, :generate_invite_token)
    

    You can use delete_all/destroy_all/update_all for the whole relation or run specific methods on individual records.

  • ➕ Add ability to delete records associated with a parent object using background migrations

      class Link < ActiveRecord::Base
        has_many :clicks
      end
    
      class Click < ActiveRecord::Base
        belongs_to :link
      end
    
      class DeleteSomeLinkClicks < ActiveRecord::Migration[7.0]
        def up
          some_link = ...
          delete_associated_records_in_background("Link", some_link.id, :clicks)
        end
      end
    

  • ➕ Add ability to delete orphaned records using background migrations

      class User < ApplicationRecord
        has_many :posts
      end
    
      class Post < ApplicationRecord
        belongs_to :author, class_name: 'User'
      end
    
      class DeleteOrphanedPosts < ActiveRecord::Migration[7.0]
        def up
          delete_orphaned_records_in_background("Post", :author)
        end
      end
    

• v0.4.1 Changes

  March 21, 2022

  • 🛠 Fix missing options in suggested command for columns removal
  • 🛠 Fix retrieving raw postgresql connection

• v0.4.0 Changes

  March 17, 2022

  • Lazy load this gem

  • ➕ Add ability to reset counter caches using background migrations

      class User < ApplicationRecord
        has_many :projects
      end
    
      class Project < ApplicationRecord
        belongs_to :user, counter_cache: true
      end
    
      class ResetUsersProjectsCount < ActiveRecord::Migration[7.0]
        def up
          reset_counters_in_background("User", :projects)
        end
      end
    

  • Accept 0 as batch_pause value for background migrations

  • 0️⃣ Ignore default scopes in CopyColumn and BackfillColumn background migrations

  • 👍 Raise an error for unsupported database versions

  • 🛠 Fix backfilling code in suggestion for changing column's NOT NULL

  🆕 New safe operations

  • Changing between text and citext when not indexed
  • Changing a string column to a citext column when not indexed
  • Changing a citext column to a string column with no length limit
  • Increasing the :precision of an interval column
  • Changing a cidr column to an inet column
  • Changing an xml column to a text column
  • Changing an xml column to a string column with no :limit
  • Changing a bit column to a bit_varying column
  • Increasing or removing the :limit of a bit_varying column

  🆕 New unsafe operations

  • Decreasing :precision of a datetime column
  • Decreasing :limit of a timestamptz column
  • Decreasing :limit of a bit_varying column
  • ➕ Adding a :limit to a bit_varying column

• v0.3.0 Changes

  February 10, 2022

  • 👌 Support ActiveRecord 7.0+ versioned schemas

  • Check for addition of single table inheritance column

    See Adding a single table inheritance column for details

  • ➕ Add a way to log every SQL query to stdout

    See Verbose SQL logs for details

  • Ignore new tables when checking for removing table with multiple fkeys

  • Fix backfilling column in add_column_with_default when default is an expression

• v0.2.0 Changes

  January 31, 2022

  • Check removing a table with multiple foreign keys

  • Check for mismatched reference column types

    For example, it detects cases like:

    class AddUserIdToProjects < ActiveRecord::Migration[7.0]
      def change
        add_column :projects, :user_id, :integer
      end
    end
    

    where users.id is of type bigint.

  • Add support for multiple databases to start_after and target_version configuration options

    OnlineMigrations.configure do |config|
      config.start_after = { primary: 20211112000000, animals: 20220101000000 }
      config.target_version = { primary: 10, animals: 14.1 }
    end
    

  • Do not suggest ignored_columns when removing columns for Active Record 4.2 (ignored_columns was introduced in 5.0)

  • Check replacing indexes

    For example, you have an index on projects.creator_id. But decide, it is better to have a multicolumn index on [creator_id, created_at]:

    class AddIndexOnCreationToProjects < ActiveRecord::Migration[7.0]
      disable_ddl_transaction!
    
      def change
        remove_index :projects, :creator_id, algorithm: :concurrently # (1)
        add_index :projects, [:creator_id, :created_at], algorithm: :concurrently # (2)
      end
    end
    

    If there is no existing indexes covering creator_id, removing an old index (1) before replacing it with the new one (2) might result in slow queries while building the new index. A safer approach is to swap removing the old and creation of the new index operations.

• v0.1.0 Changes

  January 17, 2022

  • 🚀 First release