Output a warning when the index kwarg is passed to #add_column. - #39834
Closed
d12 wants to merge 1 commit into
Closed
Output a warning when the index kwarg is passed to #add_column.#39834d12 wants to merge 1 commit into
index kwarg is passed to #add_column.#39834d12 wants to merge 1 commit into
Conversation
cc rails#20400 cc rails#39230 cc https://makandracards.com/makandra/32353-psa-index-true-in-rails-migrations-does-not-work-as-you-d-expect The `index: true` kwarg works on many methods in ActiveRecord migrations but does _not_ work in `add_column`. Rather than failing silently, provide a big QoL improvement and let the user know that their migration _did not_ create an index.
d12
force-pushed
the
warn_on_add_column_with_index_kwarg
branch
from
July 14, 2020 00:20
f8c0577 to
9e76341
Compare
Contributor
I currently have a PR that tackles this #39659. |
|
This pull request has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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: truekwarg 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
indexkwarg but we'll break backwards compatibility of old mutations withindexkwargs.Many cases of people mistakenly using
index: truewithadd_column: https://github.com/search?q=%22add_column%22+%22index%3A+true%22&type=Code