Skip to content

Add Migration Execute Rule #376

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
a-lavis wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add Migration Execute Rule #376

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions README.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1323,6 +1323,29 @@ class ModifyDefaultStatusForProducts < ActiveRecord::Migration
end
----

=== `execute` in Migrations [[migration-execute]]

Use `execute` instead of `connection.execute` in migrations.

Using `execute` directly provides useful terminal output while the migration is running.

[source,ruby]
----
# bad
class AddIndexToUsers < ActiveRecord::Migration[7.0]
def up
connection.execute('CREATE INDEX index_users_on_email ON users(email)')
end
end

# good
class AddIndexToUsers < ActiveRecord::Migration[7.0]
def up
execute('CREATE INDEX index_users_on_email ON users(email)')
end
end
----

=== Meaningful Foreign Key Naming [[meaningful-foreign-key-naming]]

Name your foreign keys explicitly instead of relying on Rails auto-generated FK names. (https://guides.rubyonrails.org/active_record_migrations.html#foreign-keys)
Expand Down