Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/djezzzl/database_consistency
The tool to avoid various issues due to inconsistencies and inefficiencies between a database schema and application models.
https://github.com/djezzzl/database_consistency
activerecord consistency database optimization performance rails ruby ruby-on-rails tool
Last synced: about 1 month ago
JSON representation
The tool to avoid various issues due to inconsistencies and inefficiencies between a database schema and application models.
- Host: GitHub
- URL: https://github.com/djezzzl/database_consistency
- Owner: djezzzl
- License: mit
- Created: 2018-10-30T11:13:51.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-12-18T07:02:57.000Z (6 months ago)
- Last Synced: 2024-04-14T02:29:26.836Z (about 2 months ago)
- Topics: activerecord, consistency, database, optimization, performance, rails, ruby, ruby-on-rails, tool
- Language: Ruby
- Homepage:
- Size: 597 KB
- Stars: 978
- Watchers: 9
- Forks: 42
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Lists
- awesome-ruby - Database Consistency - An easy way to check that application constraints and database constraints are in sync. (Database Tools)
- awesome-ruby-cli-apps - database_consistency - Checks database constraints for consistency with Rails model validations. (Awesome Ruby CLIs / Database)
- awesome-ruby - Database Consistency - An easy way to check that application constraints and database constraints are in sync. (Database Tools)
- awesome-ruby - Database Consistency - An easy way to check that application constraints and database constraints are in sync. (Database Tools)
- awesome-stars - djezzzl/database_consistency - The tool to avoid various issues due to inconsistencies and inefficiencies between a database schema and application models. (Ruby)
README
# DatabaseConsistency
[](https://badge.fury.io/rb/database_consistency)
[](https://github.com/djezzzl/database_consistency/actions/workflows/tests.yml?query=event%3Aschedule)
[](https://github.com/djezzzl/database_consistency/actions/workflows/rubocop.yml?query=event%3Aschedule)
[](https://opencollective.com/database_consistency#support)
The main goal of the project is to help you avoid various issues due to inconsistencies and inefficiencies between a database schema and application models.
> If the project helps you or your organization, I would be very grateful if you [contribute](https://github.com/djezzzl/database_consistency#contributing) or [donate](https://opencollective.com/database_consistency#support).
> Your support is an incredible motivation and the biggest reward for my hard work.
For detailed information, please read the [wiki](https://github.com/djezzzl/database_consistency/wiki).
Currently, the tool can:
- [find missing null constraints](https://github.com/djezzzl/database_consistency/wiki/columnpresencechecker)
- [find missing length validations](https://github.com/djezzzl/database_consistency/wiki/lengthconstraintchecker)
- [find missing presence validations](https://github.com/djezzzl/database_consistency/wiki/nullconstraintchecker)
- [find missing uniqueness validations](https://github.com/djezzzl/database_consistency/wiki/uniqueindexchecker)
- [find missing foreign keys for `BelongsTo` associations](https://github.com/djezzzl/database_consistency/wiki/foreignkeychecker)
- [find missing unique indexes for uniqueness validation](https://github.com/djezzzl/database_consistency/wiki/missinguniqueindexchecker)
- [find missing indexes for `HasOne` and `HasMany` associations](https://github.com/djezzzl/database_consistency/wiki/missingindexchecker)
- [find primary keys with integer/serial type](https://github.com/djezzzl/database_consistency/wiki/primarykeytypechecker)
- [find mismatching primary key types with their foreign keys](https://github.com/djezzzl/database_consistency/wiki/foreignkeytypechecker)
- [find redundant non-unique indexes](https://github.com/djezzzl/database_consistency/wiki/redundantindexchecker)
- [find redundant uniqueness constraints](https://github.com/djezzzl/database_consistency/wiki/redundantuniqueindexchecker)
- [find mismatching enum types with their values](https://github.com/djezzzl/database_consistency/wiki/enumtypechecker)
- [find mismatching foreign key cascades](https://github.com/djezzzl/database_consistency/wiki/foreignkeycascadechecker)
- [find inconsistent values between enums in the database and ActiveRecord's enums/inclusion validations](https://github.com/djezzzl/database_consistency/wiki/enumvaluechecker)
- [find redundant `case_sensitive: false` option for unique validations for case-insensitive types](https://github.com/djezzzl/database_consistency/wiki/casesensitiveuniquevalidationchecker)
- [find missing null constraints on boolean fields](https://github.com/djezzzl/database_consistency/wiki/threestatebooleanchecker)
- [find broken associations that refer undefined models](https://github.com/djezzzl/database_consistency/wiki/missingassociationclasschecker)
- [find models that have missing tables](https://github.com/djezzzl/database_consistency/wiki/missingtablechecker)
- [find models with UUID primary keys without specified ordering column](https://github.com/djezzzl/database_consistency/wiki/implicitorderingchecker)
Besides that, the tool provides:
- [auto-correction](https://github.com/djezzzl/database_consistency/wiki/auto-correction)
- [flexible configuration](https://github.com/djezzzl/database_consistency/wiki/configuration)
- [slow start with TODO files](https://github.com/djezzzl/database_consistency/wiki/generate-todo)
We support the following databases: `SQLite3`, `PostgreSQL` and `MySQL`.
We support [ActiveRecord](https://github.com/rails/rails/tree/master/activerecord) only at the moment.
Please upvote the request for other frameworks if you're interested.
Follow me and stay tuned for the updates:
- [LinkedIn](https://www.linkedin.com/in/evgeniydemin/)
- [Medium](https://evgeniydemin.medium.com/)
- [Twitter](https://twitter.com/EvgeniyDemin/)
- [GitHub](https://github.com/djezzzl)
## Usage
Add this line to your application's Gemfile:
```ruby
gem 'database_consistency', group: :development, require: false
```
And then execute:
```bash
$ bundle install
```
### Example
```bash
$ bundle exec database_consistency
NullConstraintChecker fail User code column is required in the database but does not have a validator disallowing nil values
NullConstraintChecker fail User company_id column is required in the database but do not have presence validator for association (company)
LengthConstraintChecker fail Company note column has limit in the database but do not have length validator
MissingUniqueIndexChecker fail User name+email model should have proper unique index in the database
ForeignKeyChecker fail User company should have foreign key in the database
ForeignKeyTypeChecker fail User company associated model key (id) with type (integer) mismatches key (company_id) with type (integer(8))
MissingIndexChecker fail Company user associated model should have proper index in the database
ForeignKeyTypeChecker fail Company user associated model key (company_id) with type (integer(8)) mismatches key (id) with type (integer)
MissingIndexChecker fail Country users associated model should have proper index in the database
ColumnPresenceChecker fail User phone column should be required in the database
ColumnPresenceChecker fail User name column is required but there is possible null value insert
UniqueIndexChecker fail User index_users_on_name_and_slug index is unique in the database but do not have uniqueness validator
RedundantUniqueIndexChecker fail User index_users_on_name_and_slug index uniqueness is redundant as (index_users_on_slug) covers it
RedundantIndexChecker fail User index_users_on_phone index is redundant as (index_users_on_phone_and_slug) covers it
ColumnPresenceChecker fail User tmp column (tmp) is missing in table (users) but used for presence validation
ForeignKeyTypeChecker fail User something association (something) of class (User) relies on field (something_id) of table (users) but it is missing
ThreeStateBooleanChecker fail Company active boolean column should have NOT NULL constraint
MissingAssociationClassChecker fail Company anything refers to undefined model "Anything"
MissingTableChecker fail LegacyModel should have a table in the database
ImplicitOrderingChecker fail Secondary::User id implicit_order_column is recommended when using uuid column type for primary key
```
## Funding
### Open Collective Backers
You're an individual who wants to support the project with a monthly donation. Your logo will be available on the Github page. [[Become a backer](https://opencollective.com/database_consistency#backer)]
### Open Collective Sponsors
You're an organization that wants to support the project with a monthly donation. Your logo will be available on the Github page. [[Become a sponsor](https://opencollective.com/database_consistency#sponsor)]
## Contributing
[Bug reports](https://github.com/djezzzl/database_consistency/issues) and [pull requests](https://github.com/djezzzl/database_consistency/pulls) are welcome on GitHub.
This project is intended to be a safe, welcoming space for collaboration, and contributors are expected
to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
### Contributors
## Code of Conduct
Everyone interacting in the *DatabaseConsistency* project’s codebases, issue trackers, chat rooms
and mailing lists is expected to
follow the [code of conduct](CODE_OF_CONDUCT.md).
## Changelog
*DatabaseConsistency*'s changelog is available [here](CHANGELOG.md).
## Copyright
Copyright (c) Evgeniy Demin. See [LICENSE.txt](LICENSE.txt) for further details.