glenux/rakenne
1
0
Fork 0
Code Issues Pull requests Packages Projects 1 Releases Wiki Activity
🟠 Draft | A diagram-as-code database modeling tool
18 commits 1 branch 0 tags 69 KiB
Go to file
Glenn Y. Rolland 0347d2c14e
Update erd-dsl.md
2020-05-17 21:20:09 +02:00
doc Update erd-dsl.md 2020-05-17 21:20:09 +02:00
src Add basic structure for Crystal 2020-05-17 17:39:36 +02:00
README.md Update README: set status & links to documentation 2020-05-17 21:00:36 +02:00
shard.yml Add basic structure for Crystal 2020-05-17 17:39:36 +02:00

README.md

Rakenne

Rakenne is a database modeling tool for command line written in Crystal.

For now, It is a toy project to improve author's skills with the language and its various libraries. It is very early stage and is not supposed to work (yet). Please don't use it in production. ⚠️

Note: rakenne means structure in Finnish.

Roadmap

  • ➡️ define a DSL for modeling database
    • ➡️ describe entity-relationship diagrams (ERD) using MERISE notation ⇒ doc/erd-dsl.md
    • ➡️ describe physical diagrams (PD) ⇒ doc/erd-dsl.md
  • ❌ provide a command-line tool for all operations
  • ❌ render models into diagrams
    • ❌ ERD to MERISE MCD diagrams
    • ❌ ERD to Chen notation diagrams
    • ❌ PD to MERISE MLD diagrams
  • ❌ validate model
  • ❌ convert across different database reprentations
    • ❌ convert ERD to PD
    • ❌ convert PD to database specific SQL
    • ❌ reverse-engineer database-specific SQL to PD
    • ❌ reverse-engineer PD to ERD
  • ❌ support multiple physical models
    • ❌ sql
    • ❌ nosql
  • ❌ support multiple SQL and NoSQL languages
    • ❌ SQL: postgresql
    • ❌ SQL: mariadb
    • ❌ NoSQL: redis
    • ❌ NoSQL: mongodb
    • ❌ NoSQL: cassandra CQL

Contributing

  1. Fork it ( http://github.com/glenux/rakenne/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

Authors & contributors

  • Glenn Y. Rolland - creator and maintainer
  • You? Fork the project and become a contributor!

Sponsors

Rakenne is an independent project whose development and maintenance is made possible thanks to the support of its patrons.

If you wish to join them and support the work of its author, just participate with this link:

>>> Become a patron or sponsor on Patreon <<<

License

Rakenne is Copyright © 2020 Glenn ROLLAND. It is free software, and may be redistributed under the terms specified in the LICENSE.txt file.

References