sql-gen-doc

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

★ 12 Open GitHub ↗

a tool to automatically generate sql documentation! :crystal_ball:

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# sql-gen-doc
[![GoDoc](https://godoc.org/github.com/ntindall/sql-gen-doc?status.svg)](https://godoc.org/github.com/ntindall/sql-gen-doc) [![CircleCI](https://circleci.com/gh/ntindall/sql-gen-doc.svg?style=svg)](https://circleci.com/gh/ntindall/sql-gen-doc)

A tool to automatically generate sql documentation.

## Installation
```sh
  go get -u github.com/ntindall/sql-gen-doc
```

## Usage

`sql-gen-doc` will connect to a database and generate a markdown table
corresponding to the current state of each table in the database. This is useful
for databases that undergo frequent migrations. You can set up your CI to run
this tool whenever a new migration is added.

```sh
$ ./bin/sql-gen-doc --help
Usage of ./bin/sql-gen-doc:
  -dsn string
      a data source name for the database, e.g. user:password@tcp(mysql:3306)/database_name
  -o string
      the outfile to write the documentation to, if no outfile is specified, the output is written to stdout
  --sort-tables
      outputs tables in alphabetical order

$ ./bin/sql-gen-doc -dsn 'user:password@tcp(localhost:3306)/database_to_generate' -o outfile.md --sort-tables
```

Additionally, the markdown file can be annotated with comments in order to have
`sql-gen-doc` insert the table into a specific location in an existing file. For this
to work, just add these comments to your markdown file and then specify it as the
outfile via the command line flag.

```markdown
# fake markdown

database documentation will go here!

sql-gen-doc

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README