Adds a little smarts to ActiveRecords index name generation to try and fit them into 63 characters or less for Postgres and MySQL.
Tries in the following ways:
- change polymorphic references to just the name of the relation
- e.g.
relation_type_and_relation_id
becomesrelation
- e.g.
- change
index_
toix_
- remove common strings from column names
- e.g.
field_id_1_and_field_id_2
becomesid_1_and_id_2
- e.g.
- remove leading parts of the table name until there's only one
- e.g.
very_long_table_of_items
becomeslong_table_of_items, then table_of_items, then of_items, then items
until it fits
- e.g.
- change the column names used in the index to a hash
- change the table name to a hash if shorter The end. If it's still too long, you'll have to name it manually
Add this line to your application's Gemfile:
gem "better_index_name"
And then execute:
$ bundle install
Or install it yourself as:
$ gem install better_index_name
After checking out the repo, run bin/setup
to install dependencies. You can also run bin/console
for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run bundle exec rake install
. To release a new version, update the version number in version.rb
, and then run bundle exec rake release
, which will create a git tag for the version, push git commits and the created tag, and push the .gem
file to rubygems.org.
Bug reports and pull requests are welcome on GitHub at https://github.com/bsharpe/better_index_name. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.
The gem is available as open source under the terms of the MIT License.
Everyone interacting in the BetterIndexName project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.