Output a warning when the index
kwarg is passed to #add_column.
#39834
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #39230
cc #20400
cc https://makandracards.com/makandra/32353-psa-index-true-in-rails-migrations-does-not-work-as-you-d-expect
Summary
The
index: true
kwarg works on many methods in ActiveRecord migrations but does not work inadd_column
. Rather than failing silently, provide a big quality of life improvement and let the user know that their migration did not create an index.Other Information
I think a better long term solution would be to warn on all unexpected options keys but AR adapters could pass down random options keys that they use. Since solving perfectly is a little tricky, I'm pushing this PR up as a solid first step.
I also considered erroring on the
index
kwarg but we'll break backwards compatibility of old mutations withindex
kwargs.Many cases of people mistakenly using
index: true
withadd_column
: https://github.com/search?q=%22add_column%22+%22index%3A+true%22&type=Code