https://github.com/caffkane/dbml_parser
Parse DBML files with ease (Database Markup Language).
https://github.com/caffkane/dbml_parser
dbml hacktoberfest rails ruby
Last synced: 4 months ago
JSON representation
Parse DBML files with ease (Database Markup Language).
- Host: GitHub
- URL: https://github.com/caffkane/dbml_parser
- Owner: caffkane
- License: mit
- Created: 2020-10-09T20:17:20.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2020-10-09T20:49:58.000Z (over 4 years ago)
- Last Synced: 2024-08-13T07:15:43.907Z (8 months ago)
- Topics: dbml, hacktoberfest, rails, ruby
- Language: Ruby
- Homepage:
- Size: 8.79 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- jimsghstars - caffkane/dbml_parser - Parse DBML files with ease (Database Markup Language). (Ruby)
README
# DbmlParser
DBML Parser is a gem for parsing [Database Markup Language (DBML)](https://www.dbml.org/).
It ingests a .dbml file in the given directory (default root dir), and returns a schema.rb based on that file. It can also suggest tables that needed to be created that are not currently in your schema.rb. It will generate those migrations if needed.
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'dbml_parser'
```
And then execute:
$ bundle install
Or install it yourself as:
$ gem install dbml_parser
## Usage
```Ruby
# To generate a schema.rb
bundle exec rails generate dbml:schema
# To generate missing migrations
bundle exec rails generate dbml:migrations
```
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. 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 tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/dbml_parser. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/dbml_parser/blob/master/CODE_OF_CONDUCT.md).
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
## Code of Conduct
Everyone interacting in the DbmlParser project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/dbml_parser/blob/master/CODE_OF_CONDUCT.md).