https://github.com/openpotato/sqldocs

A cross-platform console application build with .NET 8 to create nice looking schema documentations for SQL databases.
https://github.com/openpotato/sqldocs

dotnet sql sqldocs

Last synced: 10 days ago
JSON representation

A cross-platform console application build with .NET 8 to create nice looking schema documentations for SQL databases.

• Host: GitHub
• URL: https://github.com/openpotato/sqldocs
• Owner: openpotato
• License: agpl-3.0
• Created: 2023-07-28T13:47:14.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2023-11-21T11:26:19.000Z (over 2 years ago)
• Last Synced: 2025-01-14T01:16:07.998Z (over 1 year ago)
• Topics: dotnet, sql, sqldocs
• Language: C#
• Homepage: https://github.com/openpotato/sqldocs/wiki
• Size: 137 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          


  

# SQLDocs


[![.Net](https://img.shields.io/badge/.NET-5C2D91?style=for-the-badge&logo=.net&logoColor=white)](https://dotnet.microsoft.com/)

[![GitHub License](https://img.shields.io/github/license/openpotato/sqldocs?style=for-the-badge)](./LICENSE)

[![Documentation](https://img.shields.io/badge/docs-available-brightgreen?style=for-the-badge)](https://github.com/openpotato/sqldocs/wiki)



SQLDocs is a cross-platform console application build with [.NET 10](https://dotnet.microsoft.com/) to create nice looking [MkDocs](https://www.mkdocs.org/) schema documentations for relational databases. Currently the following database systems are supported:

+ [Firebird](https://firebirdsql.org/)

+ [PostgreSQL](https://www.postgresql.org/)

SQLDocs first extracts the metadata of the desired database and stores it in a normalised JSON file. This JSON file can be manually extended with additional information (descriptions, valid data values, etc.). 

In a second step, the information from the JSON file is used to create or update a MkDocs project (with [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/) as theme).

Both the JSON file and the MkDocs project can be versioned in a Git repository.

## Examples

If you would like to see what documentation created with SQLDocs looks like:

+ [Sample documentation for a Firebird database](https://openpotato.github.io/sqldocs.sample/firebird)

+ [Sample documentation for a PostgreSQL database](https://openpotato.github.io/sqldocs.sample/postgres)

## Documentation

Documentation is available in the [GitHub wiki](https://github.com/openpotato/sqldocs/wiki).

## To-do list

+ Support for additional DBMS (e.g. MySQL or MS SQL Server)

+ Support for additional table types (e.g. external tables, temporary tables)

+ Support for domains and custom types

+ Support for generators/sequences

+ Support for triggers

+ Support for stored procedures

+ (Maybe) support for alternative static-site generators (e.g. [Docusaurus](https://docusaurus.io/))

## Can I help?

Yes, that would be much appreciated. The best way to help is to post a response via the Issue Tracker and/or submit a Pull Request.