sqldoc

README

SQLDoc

SQLDoc is a markdown documentation for SQL tables. Inspired by Rails ActiveRecord schema.rb and drwl/annotaterb.

Installation

Using Go

Recommended if you have Go toolchain already set up.

go install go.husin.dev/sqldoc@latest

Prebuilt binaries

Download the latest release from GitHub releases.

Features

• Show columns
• Show column types
• Show column nullability and defaults
• Show column indexes
• Show column constraints

Supported database engines:

• PostgreSQL
• MySQL
• SQLite

Why?

Projects often manages their schema roll out through migrations (e.g. golang-migrate/migrate). As a project matures, it's quite common to encounter several ALTER TABLE commands, which makes it difficult to have a near-instant idea of what the schema looks like.

In Rails, schema.rb provides that insight, while extensions like drwl/annotaterb goes further to co-locate the schema documentation with the model definitions.

SQLDoc makes it easy to look at Markdown documentation for SQL tables, which I prefer over running psql -c "\d+ table_name".