{"id":14235591,"url":"https://github.com/sanpii/explain","last_synced_at":"2025-05-12T17:26:18.011Z","repository":{"id":43188637,"uuid":"247159754","full_name":"sanpii/explain","owner":"sanpii","description":"Transform postgresql explain to a graph","archived":false,"fork":false,"pushed_at":"2025-02-25T18:30:56.000Z","size":13083,"stargazers_count":57,"open_issues_count":1,"forks_count":5,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-04-01T01:01:43.247Z","etag":null,"topics":["explain","postgresql"],"latest_commit_sha":null,"homepage":"","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sanpii.png","metadata":{"files":{"readme":"docs/README.md","changelog":null,"contributing":null,"funding":"docs/FUNDING.yml","license":null,"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},"funding":{"github":["sanpii"],"liberapay":"sanpi"}},"created_at":"2020-03-13T20:53:10.000Z","updated_at":"2025-02-25T18:31:00.000Z","dependencies_parsed_at":"2024-11-06T16:43:33.027Z","dependency_job_id":null,"html_url":"https://github.com/sanpii/explain","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sanpii%2Fexplain","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sanpii%2Fexplain/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sanpii%2Fexplain/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sanpii%2Fexplain/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sanpii","download_url":"https://codeload.github.com/sanpii/explain/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253786013,"owners_count":21964077,"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":["explain","postgresql"],"created_at":"2024-08-20T21:02:07.723Z","updated_at":"2025-05-12T17:26:17.959Z","avatar_url":"https://github.com/sanpii.png","language":"Rust","funding_links":["https://github.com/sponsors/sanpii","https://liberapay.com/sanpi"],"categories":["Rust"],"sub_categories":[],"readme":"# Explain\n\n[![Github actions](https://github.com/sanpii/explain/workflows/.github/workflows/ci.yml/badge.svg)](https://github.com/sanpii/explain/actions?query=workflow%3A.github%2Fworkflows%2Fci.yml)\n[![Build Status](https://gitlab.com/sanpi/explain/badges/main/pipeline.svg)](https://gitlab.com/sanpi/explain/commits/main)\n\nTransform postgresql explain to a graph.\n\n[\u003cimg title=\"Explain plan 1\" src=\"https://raw.githubusercontent.com/sanpii/explain/main/examples/plan_1.png\" width=\"200px\" /\u003e](https://raw.githubusercontent.com/sanpii/explain/main/examples/plan_1.png)\n[\u003cimg title=\"Explain plan 2\" src=\"https://raw.githubusercontent.com/sanpii/explain/main/examples/plan_2.png\" width=\"200px\" /\u003e](https://raw.githubusercontent.com/sanpii/explain/main/examples/plan_2.png)\n[\u003cimg title=\"Explain plan 3\" src=\"https://raw.githubusercontent.com/sanpii/explain/main/examples/plan_3.png\" width=\"200px\" /\u003e](https://raw.githubusercontent.com/sanpii/explain/main/examples/plan_3.png)\n[\u003cimg title=\"Explain plan 4\" src=\"https://raw.githubusercontent.com/sanpii/explain/main/examples/plan_4.png\" width=\"200px\" /\u003e](https://raw.githubusercontent.com/sanpii/explain/main/examples/plan_4.png)\n[\u003cimg title=\"Explain plan 5\" src=\"https://raw.githubusercontent.com/sanpii/explain/main/examples/plan_5.png\" width=\"200px\" /\u003e](https://raw.githubusercontent.com/sanpii/explain/main/examples/plan_5.png)\n[\u003cimg title=\"Explain plan large\" src=\"https://raw.githubusercontent.com/sanpii/explain/main/examples/plan_large.png\" width=\"300px\" /\u003e](https://raw.githubusercontent.com/sanpii/explain/main/examples/plan_large.png)\n[\u003cimg title=\"Explain plan parallel\" src=\"https://raw.githubusercontent.com/sanpii/explain/main/examples/plan_parallel.png\" height=\"250px\" /\u003e](https://raw.githubusercontent.com/sanpii/explain/main/examples/plan_parallel.png)\n[\u003cimg title=\"Explain plan trigger\" src=\"https://raw.githubusercontent.com/sanpii/explain/main/examples/plan_trigger.png\" width=\"200px\" /\u003e](https://raw.githubusercontent.com/sanpii/explain/main/examples/plan_trigger.png)\n\n## Install\n\n[![Packaging status](https://repology.org/badge/vertical-allrepos/explain.svg)](https://repology.org/project/explain/versions)\n\nIf you use Arch Linux, explain is available in\n[AUR](https://aur.archlinux.org/packages/explain/).\n\n### Manually\n\n```bash\ngit clone https://github.com/sanpii/explain\ncd explain\nmake\nsudo make install\n```\n\n## Launch\n\nLaunch this program like `psql` and use `dot` to generate image:\n\n```\n$ explain --command 'select 1' database | dot -Tpng \u003e explain.png\n```\n\n```\n$ explain --help\nexplain 1.0.0\n\nUSAGE:\n    explain [FLAGS] [OPTIONS] [dbname]\n\nFLAGS:\n        --analyse     this option executes explain analyse /!\\ Be carful, that executes the query!\n    -n, --dry-run     Don’t execute the query, the input is already an explain plan in JSON\n        --help        Prints help information\n    -W, --password    Prompt for a password before connecting to a database\n    -V, --version     Prints version information\n\nOPTIONS:\n    -c, --command \u003ccommand\u003e    Specifies the command to execute\n    -f, --file \u003cfile\u003e          Read commands from the file, rather than standard input\n    -h, --host \u003chost\u003e          Specifies the host name of the machine on which the server is running\n    -o, --output \u003coutput\u003e      Put output into file\n    -p, --port \u003cport\u003e          Specifies the TCP port on which the server is listening for connections\n    -U, --user \u003cuser\u003e          Connect to the database as the user\n\nARGS:\n    \u003cdbname\u003e    Specifies the name of the database to connect to\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsanpii%2Fexplain","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsanpii%2Fexplain","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsanpii%2Fexplain/lists"}