{"id":16872254,"url":"https://github.com/hywan/database-to-plantuml","last_synced_at":"2025-04-06T02:08:29.930Z","repository":{"id":56987820,"uuid":"95676633","full_name":"Hywan/Database-to-PlantUML","owner":"Hywan","description":"Compile PostgreSQL and MySQL table information into a PlantUML description.","archived":false,"fork":false,"pushed_at":"2019-12-01T19:20:38.000Z","size":5610,"stargazers_count":191,"open_issues_count":6,"forks_count":23,"subscribers_count":9,"default_branch":"master","last_synced_at":"2025-03-30T01:06:21.405Z","etag":null,"topics":["database","mysql","plantuml","postgresql","visualisation"],"latest_commit_sha":null,"homepage":"","language":"PHP","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/Hywan.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-06-28T14:17:15.000Z","updated_at":"2024-09-03T07:58:31.000Z","dependencies_parsed_at":"2022-08-21T09:40:30.344Z","dependency_job_id":null,"html_url":"https://github.com/Hywan/Database-to-PlantUML","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Hywan%2FDatabase-to-PlantUML","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Hywan%2FDatabase-to-PlantUML/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Hywan%2FDatabase-to-PlantUML/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Hywan%2FDatabase-to-PlantUML/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Hywan","download_url":"https://codeload.github.com/Hywan/Database-to-PlantUML/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247423514,"owners_count":20936626,"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","mysql","plantuml","postgresql","visualisation"],"created_at":"2024-10-13T15:14:04.863Z","updated_at":"2025-04-06T02:08:29.911Z","avatar_url":"https://github.com/Hywan.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Database to PlantUML\n\nThis utility renders a graphical 2D visualisation of a database.\n\nCurrently, the only supported frontends are **PostgreSQL** and\n**MySQL**. There are 2 backends: `commonmark` and `plantuml`. The\n`plantuml` backend allows to generate visualisations into the\nfollowing formats:\n\n  * PNG,\n  * SVG,\n  * EPS,\n  * PDF,\n  * VDX,\n  * XMI,\n  * HTML,\n  * TXT,\n  * UTXT,\n  * LaTeX.\n\n# Installation\n\nWith [Composer](https://getcomposer.org/), simply run the following command:\n\n```sh\n$ composer install\n```\n\nIf you would like to use it as a dependency of your project, then:\n\n```sh\n$ composer require hywan/database-to-plantuml\n```\n\nTo use the `plantuml` backend, you can use the JAR in `resource/plantuml.jar`.\n\n# Examples with…\n\n## … PostgreSQL\n\nTaking as an example the famous `employees` use case:\n\n```sh\n# Import the schema.\n$ psql -f resource/samples/pgsql-employees.sql postgres\n\n# Generate the visualisation.\n$ bin/database-to-plantuml -d 'pgsql:dbname=employees' -u hywan -s employees | \\\n      java -jar resource/plantuml.jar -verbose -pipe \u003e output.png\n```\n\n![Output with PostgreSQL](https://cldup.com/UMsPg3WKh0.png)\n\n## … MySQL\n\nWith the same `employees` use case:\n\n```sh\n# Import the schema.\n$ mysql -u root \u003c resource/samples/mysql-employees.sql\n\n# Generate the visualisation.\n$ bin/database-to-plantuml -d 'mysql:dbname=employees' -u root -s employees | \\\n      java -jar resource/plantuml.jar -verbose -pipe \u003e output.png\n```\n\n![Output with MySQL](https://cldup.com/Cgn7bqdEz5.png)\n\nNote: Outputs differ because the `employees` examples are not exactly\nthe same. They are here to illustrate the tool only.\n\n# License\n\nBSD-3-License, but seriously, do what ever you want!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhywan%2Fdatabase-to-plantuml","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhywan%2Fdatabase-to-plantuml","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhywan%2Fdatabase-to-plantuml/lists"}