{"id":36488405,"url":"https://github.com/gsiems/db-dictionary","last_synced_at":"2026-01-12T01:53:32.786Z","repository":{"id":57648149,"uuid":"323646179","full_name":"gsiems/db-dictionary","owner":"gsiems","description":"Generate data dictionaries using database metadata","archived":false,"fork":false,"pushed_at":"2025-12-27T03:12:35.000Z","size":167,"stargazers_count":4,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-12-28T19:05:41.515Z","etag":null,"topics":["database","dictionary","mysql","oracle","postgresql","sqlite3"],"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/gsiems.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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2020-12-22T14:17:52.000Z","updated_at":"2025-12-27T03:11:00.000Z","dependencies_parsed_at":"2024-08-08T03:08:40.324Z","dependency_job_id":null,"html_url":"https://github.com/gsiems/db-dictionary","commit_stats":null,"previous_names":["gsiems/db-dictionary-core"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/gsiems/db-dictionary","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gsiems%2Fdb-dictionary","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gsiems%2Fdb-dictionary/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gsiems%2Fdb-dictionary/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gsiems%2Fdb-dictionary/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/gsiems","download_url":"https://codeload.github.com/gsiems/db-dictionary/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gsiems%2Fdb-dictionary/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28331269,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-12T00:36:25.062Z","status":"ssl_error","status_checked_at":"2026-01-12T00:36:15.229Z","response_time":60,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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","dictionary","mysql","oracle","postgresql","sqlite3"],"created_at":"2026-01-12T01:53:31.901Z","updated_at":"2026-01-12T01:53:32.777Z","avatar_url":"https://github.com/gsiems.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# db-dictionary\n\nUse relational database meta-data to generate data dictionaries.\n\n## Features/roadmap\n\n - [x] Generates static HTML pages\n\n - [x] Dictionary information for:\n\n    - [x] Schemas\n    - [x] Tables\n    - [x] Views\n    - [x] Materialized views\n    - [x] Constraints\n    - [x] Domains\n    - [x] Indexes\n    - [x] Relationhips\n\n - [x] Ability to filter tabular data on pages\n\n - [x] Ability to sort tabular data on pages\n\n    - single column sort only\n\n - [ ] Generate dependency (network) graphs (WIP)\n\n    - [ ] GraphML file (WIP)\n    - [x] Graphviz file\n    - [x] Svg (requires Graphviz)\n\n - [ ] Generate relationship (network) graphs (WIP)\n\n    - [ ] GraphML file (TODO)\n    - [ ] Graphviz file (TODO)\n    - [ ] Svg (TODO)\n\n - [x] Ability to specify different CSS/image files for theming\n\n - [x] Ability to specify additional javascript files\n\n - [x] Reasonably fast\n\n - [x] PostgreSQL support\n\n - [x] Sqlite support\n\n - [x] MySQL/Mariadb support\n\n - [ ] MS SQL-server support (WIP)\n\n - [x] Oracle support\n\n## Configuration\n\nConfigurations can be specified through a combination of configuration file, environment variables, and command line arguments.\n\n * Command line arguments take precedence over both configuration file parameters and environment variables.\n * Environment variables take precedence over configuration file parameters.\n\n| Parameter      | Command line | Environment/Config file | Description |\n| -------------- | ------------ | ----------------------- | ----------- |\n| CommentsFormat | -f           | comments_format         | The formatter to use for rendering comments {none, markdown} (default: none) |\n| ConfigFile     | -c           |                         | The configurations file to read, if any |\n| CSSFiles       | -css         | css_files               | The comma-separated list of CSS files to use in place of the default (default: none) |\n| DbComment      | -comment     | db_comment              | The comment to use for the database (for those databases that do not support ```COMMENT ON DATABASE ...```) (default: none) |\n| DbEngine       | -dbms        | dbms                    | The dbms to generate the dictionary for {oracle, postgresql, mariadb, mysql, sqlite} |\n| DbName         | -db          | db_name                 | The name of the database to connect to |\n| DSN            |              | dsn                     | The DSN to use for connecting to the database (will attempt to create one based on DbName, Host, Port, etc. if not specified) |\n| ExcludeSchemas | -x           | exclude_schemas         | The comma-separated list of schemas to exclude (default: none) |\n| File           | -file        | file                    | (Sqlite) The database file to read |\n| GraphvizCmd    | -gv          | graphviz_cmd            | The Graphviz command to run (default: fdp) |\n| HideSQL        | -nosql       | hide_sql                | Do not show the queries used for views and materialized views (default is to show queries) |\n| Host           | -host        | host                    | The database host to connect to (default: localhost) |\n| ImgFiles       | -img         | img_files               | The comma-separated list of image files to include (for use with custom CSS) (default: none) |\n| IncludeSchemas | -s           | include_schemas         | The comma-separated list of schemas to include. Takes precedence over ExcludeSchemas. If neither are specified than all non-system schemas are included. |\n| JSFiles        | -js          | js_files                | The comma-separated list of javascript files to include (default: none) |\n| Minify         | -minify      | minify                  | Indicates if the output should be minified to reduce files size (default: false) |\n| NoGraphviz     | -nogv        | no_graphviz             | Do not (attempt to) run Graphviz  (default is to run Graphviz) |\n| OutputDir      | -out         | output_dir              | The directory to write the output files to (defaults to the current directory) |\n| Port           | -port        | port                    | The port number to connect to (default depends on the database engine) |\n| SSLMode        | -sslmode     | ssl_mode                | (Postgresql) Set the SSL mode to use {disable, require, verify-ca, verify-full} (default: require) |\n| Username       | -user        | username                | The username to connect as (defaults to the current OS user) |\n| UserPass       |              | user_pass               | The password to use to connect as |\n| Verbose        | -v           | verbose                 | Indicates if additional feedback should be printed to STDOUT (default: false) |\n\n----\n\nSee [db-dictionary-example](https://github.com/gsiems/db-dictionary-example) for some sample data dictionaries.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgsiems%2Fdb-dictionary","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgsiems%2Fdb-dictionary","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgsiems%2Fdb-dictionary/lists"}