{"id":26204903,"url":"https://github.com/wilsonehusin/sqldoc","last_synced_at":"2025-06-14T18:32:19.021Z","repository":{"id":236865003,"uuid":"793199676","full_name":"wilsonehusin/sqldoc","owner":"wilsonehusin","description":"Generate markdown documentation from SQL tables.","archived":false,"fork":false,"pushed_at":"2024-08-05T22:04:32.000Z","size":333,"stargazers_count":5,"open_issues_count":4,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-28T17:57:16.401Z","etag":null,"topics":["database","documentation","documentation-generator","postgres","postgresql","sql"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/wilsonehusin.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-04-28T17:51:16.000Z","updated_at":"2024-05-06T21:32:49.000Z","dependencies_parsed_at":"2024-06-19T11:25:01.890Z","dependency_job_id":"585a4996-1ca4-4ef4-a055-7072ef54e0a8","html_url":"https://github.com/wilsonehusin/sqldoc","commit_stats":null,"previous_names":["wilsonehusin/sqldoc"],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wilsonehusin%2Fsqldoc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wilsonehusin%2Fsqldoc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wilsonehusin%2Fsqldoc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wilsonehusin%2Fsqldoc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/wilsonehusin","download_url":"https://codeload.github.com/wilsonehusin/sqldoc/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249025020,"owners_count":21200231,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["database","documentation","documentation-generator","postgres","postgresql","sql"],"created_at":"2025-03-12T04:31:36.501Z","updated_at":"2025-04-15T07:24:31.435Z","avatar_url":"https://github.com/wilsonehusin.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# SQLDoc\n\nSQLDoc is a markdown documentation for SQL tables. Inspired by Rails ActiveRecord `schema.rb` and [drwl/annotaterb](https://github.com/drwl/annotaterb).\n\n![Demo of SQLDoc](demo/demo.gif)\n\n## Installation\n\n### Using Go\n\nRecommended if you have Go toolchain already set up.\n\n```sh\ngo install go.husin.dev/sqldoc@latest\n```\n\n### Prebuilt binaries\n\nDownload the latest release from [GitHub releases](https://github.com/wilsonehusin/sqldoc/releases).\n\n## Features\n\n- [x] Show columns\n- [x] Show column types\n- [x] Show column nullability and defaults\n- [ ] Show column indexes\n- [ ] Show column constraints\n\nSupported database engines:\n\n- [x] PostgreSQL\n- [ ] MySQL\n- [ ] SQLite\n\n## Why?\n\nProjects often manages their schema roll out through migrations (e.g. [golang-migrate/migrate](https://github.com/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.\n\nIn Rails, `schema.rb` provides that insight, while extensions like [drwl/annotaterb](https://github.com/drwl/annotaterb) goes further to co-locate the schema documentation with the model definitions.\n\nSQLDoc makes it easy to look at Markdown documentation for SQL tables, which I prefer over running `psql -c \"\\d+ table_name\"`.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwilsonehusin%2Fsqldoc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwilsonehusin%2Fsqldoc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwilsonehusin%2Fsqldoc/lists"}