schemadoc gem - document your database schemas (tables, columns, etc.)
The schemadoc
gem includes a command line tool named - surprise, surprise - schemadoc
. Try:
resulting in:
schemadoc 1.0.0 - Lets you document your database tables, columns, etc.
Usage: schemadoc [options]
-o, --output PATH Output path (default is '.')
-v, --verbose Show debug trace
Examples:
schemadoc # defaults to ./schemadoc.yml
schemadoc football.yml
The schemadoc
command line tool requires a configuration file (defaults to ./schemadoc.yml
if not passed along).
Database Connection Settings - database
Section
Use the database
section to configure you database connection settings. Example:
database:
adapter: sqlite3
database: ./football.db
Schema Sections
All other sections are interpreted as database schemas. The first section is the "default" schema, that is, all tables not listed in other schemas will get auto-added to the "default" schema.
Example - schemadoc.yml
## connection spec
database:
adapter: sqlite3
database: ./football.db
## main tables
football:
name: Football
## world tables
world:
name: World
tables:
- continents
- countries
- regions
- cities
- places
- names
- langs
- usages
The schemadoc
tool writes out two json files:
database.json
- includes all schemas, tables, columns, etc.symbols.json
- includes all symbols from a to zExamples. See the football.db - database.json
, symbols.json
or beer.db - database.json
, symbols.json
live examples.
To generate web pages from you json files use a static site generator and a template pack (theme). For example, to use the schemadoc/schemadoc-theme
theme copy your json files in the _data/
folder and rebuild the site (e.g. $ jekyll build
). That's it. Enjoy your database schema docu.
Examples. See the football.db or beer.db live examples.
Free Schemadoc Template Packs / Themesschemadoc/schemadoc-theme
- free schemadoc theme; works w/ Jekyll (and GitHub Pages) static site generatorJust install the gem:
In addition, install Active Record
and your database adapter's gem such as mysql2
$ gem install activerecord
$ gem install mysql2
The schemadoc
scripts are dedicated to the public domain. Use it as you please with no restrictions whatsoever.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4