mysql-documentation

Creates a list of all tables and columns for a MySQL database with anchor links for foreign key relationships

Example Output

users

• id int

• username varchar

• email_primary varchar

• member_id int

  • Foreign Key To

  • members.id

• created_date datetime

• updated_date datetime

members

• id int

  • Referenced By

  • users.member_id

• created_date datetime

• updated_date datetime

Installation

npm i mysql-documentation

Usage

MYSQL_HOST=127.0.0.1 \
MYSQL_USER=root \
MYSQL_PASS=password \
MYSQL_DB=test \
OUT_PATH=.. \
OUT_NAME=test \ # will produce test.md and test.html
./node_modules/.bin/mysql-documentation