{"id":19478150,"url":"https://github.com/decathlon/dblinter","last_synced_at":"2025-10-19T07:05:18.856Z","repository":{"id":254440078,"uuid":"846530871","full_name":"Decathlon/dblinter","owner":"Decathlon","description":"A static analysis tool for postgresql databases","archived":false,"fork":false,"pushed_at":"2025-10-03T14:21:45.000Z","size":287,"stargazers_count":6,"open_issues_count":1,"forks_count":3,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-10-03T16:24:23.986Z","etag":null,"topics":["database","quality","validation"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Decathlon.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":null,"code_of_conduct":"code-of-conduct.md","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":"2024-08-23T12:07:50.000Z","updated_at":"2025-10-03T14:18:58.000Z","dependencies_parsed_at":"2025-10-03T16:13:42.470Z","dependency_job_id":"67658621-81e9-498b-81bb-236088ccf641","html_url":"https://github.com/Decathlon/dblinter","commit_stats":null,"previous_names":["decathlon/dblinter"],"tags_count":7,"template":false,"template_full_name":null,"purl":"pkg:github/Decathlon/dblinter","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Decathlon%2Fdblinter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Decathlon%2Fdblinter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Decathlon%2Fdblinter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Decathlon%2Fdblinter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Decathlon","download_url":"https://codeload.github.com/Decathlon/dblinter/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Decathlon%2Fdblinter/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279731815,"owners_count":26217761,"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","status":"online","status_checked_at":"2025-10-19T02:00:07.647Z","response_time":64,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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","quality","validation"],"created_at":"2024-11-10T19:47:21.871Z","updated_at":"2025-10-19T07:05:18.825Z","avatar_url":"https://github.com/Decathlon.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# dblinter\n\nStatic conformity is largely used in the dev world but there is no such tool for databases schemas.\nThis tool connect to a postgres database to check good practices in schema design and output a file in [Sarif][2] format.\nA configuration file describe the rule to enforce and acceptable threshold\n\nAn example of the output is: ![dblinter output](docs/dblinter-output.png)\n\n## Launch dblinter\n\n### Docker\n\nYou can use the docker image if you prefer not to install python on your computer.\n\nLaunch the docker image\n\n```sh\ndocker run --rm -t decathlon/dblinter:latest  --dbname $PGDATABASE --host $PGHOST --user $PGUSER --password $PGPASSWORD --port $PGPORT\n```\n\n## Directly from the source\n\nYou can launch dblinter directly from the source code. You will need python and poetry to install the dependencies:\n\n```shell\n# Install poetry\ncurl -sSL https://install.python-poetry.org | python3 -\n# Install dependencies\npoetry install --with dev\n# Launch the program\npoetry run python -m dblinter --dbname $PGDATABASE --host $PGHOST --user $PGUSER --password $PGPASSWORD --port $PGPORT\n```\n\n## Usage\n\n```shell\n\n Usage: python -m dblinter [OPTIONS]\n\n╭─ Options ─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮\n│ *  --user      -U      TEXT                                                 pg username [env var: PGUSER] [default: None]         │\n│                                                                             [required]                                            │\n│ *  --password  -W      TEXT                                                 pg pwd     [env var: PGPASSWORD] [default: None]      │\n│                                                                             [required]                                            │\n│ *  --host      -h      TEXT                                                 pg hostname [env var: PGHOST] [default: None]         │\n│                                                                             [required]                                            │\n│    --port      -p      TEXT                                                 pg port [env var: PGPORT] [default: 5432]             │\n│ *  --dbname    -d      TEXT                                                 pg dbname  [env var: PGDATABASE] [default: None]      │\n│                                                                             [required]                                            │\n│    --sslmode   -s      [allow|prefer|require|verify-ca|verify-full|simple|  pg sslmode                 [env var: PGSSLMODE]       │\n│                        disable]                                             [default: SslMode.disable]                            │\n│    --describe  -b      TEXT                                                 describe is added in sarif invocation field           │\n│                                                                             [default: None]                                       │\n│    --filename  -f      TEXT                                                 rules configuration file                              │\n│    --append    -a                                                           sarif report is append to output file [default: True] │\n│    --output    -o      TEXT                                                 report output file [default: None]                    │\n│    --loglevel  -l      [DEBUG|INFO|WARNING|ERROR|CRITICAL]                  log level [default: LogLevels.warning]                │\n│    --schema    -n      TEXT                                                 tables in schema only filter                          │\n│    --exclude   -x      TEXT                                                 Exclude table filter                                  │\n│    --include   -i      TEXT                                                 Include table filter                                  │\n│    --quiet     -q                                                           Quiet mode [env var:QUIET]                            │\n│    --help                                                                   Show this message and exit.                           │\n╰───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯\n\n```\n\n## Contributing\n\nWe welcome contributions from the community. For more details on contributing to the project (including requirements), please refer to \"[Getting Started with Contributing](CONTRIBUTING.md).\"\n\n\u003c!--\nLinks\n--\u003e\n[2]: https://docs.oasis-open.org/sarif/sarif/v2.1.0/sarif-v2.1.0.html\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdecathlon%2Fdblinter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdecathlon%2Fdblinter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdecathlon%2Fdblinter/lists"}