Download the PHP package pongee/database-schema-visualization without Composer
On this page you can find all versions of the php package pongee/database-schema-visualization. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package database-schema-visualization
Database schema visualization
Project goal
The aim of this project is to generate database documentation from sql schema.
Supported databases
- MySQL
- MariaDB
- Apache Cassandra (Basics)
Supported Output formats
- PNG, SVG image
- Plantuml raw text
- Json
- Markdown
Installation
Commands
Every command reads a schema file and writes the result to stdout, so redirect it into a file. Foreign keys are resolved automatically from the schema.
Each command exists for both MySQL (mysql:) and Apache Cassandra (cassandra:):
| Command | Output |
|---|---|
mysql:json / cassandra:json |
JSON |
mysql:plantuml / cassandra:plantuml |
PlantUML raw text |
mysql:markdown / cassandra:markdown |
Markdown |
mysql:image / cassandra:image |
PNG / SVG image |
Argument and options:
| Name | Description |
|---|---|
file |
Path to the schema file. Required. |
--type |
Image format for the image commands: png (default) or svg. |
--template |
Twig template used for rendering. Defaults to the bundled template. |
Usage
The command, argument and options are the same across every run mode below — see Commands for the full list.
Command line
For example:
Output:
Docker
The image is published to Docker Hub, built for both linux/amd64 and linux/arm64.
Mount your schema into the container and pass the same command and options as on the CLI:
List the available commands:
PHP
Png export
Json export
This will generate:
{
"tables": {
"foo": {
"columns": [
{
"name": "id",
"type": "INT",
"typeParameters": [
"10"
],
"otherParameters": "UNSIGNED NOT NULL",
"comment": "The id"
}
],
"indexs": {
"simple": [],
"spatial": [],
"fulltext": [],
"unique": []
},
"primaryKey": []
}
},
"connections": []
}
Markdown export
This will generate:
All versions of database-schema-visualization with dependencies
ext-json Version *
symfony/console Version ^7.0||^8.0
twig/twig Version ^3.0