PHPackages                             pongee/database-schema-visualization - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Database & ORM](/categories/database)
4. /
5. pongee/database-schema-visualization

ActiveLibrary[Database & ORM](/categories/database)

pongee/database-schema-visualization
====================================

Database schema visualization

4.0.0(1y ago)46.2k↓40%1MITPHPPHP >=8.1

Since Jan 5Pushed 1y ago1 watchersCompare

[ Source](https://github.com/pongee/database-schema-visualization)[ Packagist](https://packagist.org/packages/pongee/database-schema-visualization)[ RSS](/packages/pongee-database-schema-visualization/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (2)Dependencies (8)Versions (13)Used By (0)

Database schema visualization
=============================

[](#database-schema-visualization)

[![Latest Stable Version](https://camo.githubusercontent.com/a243c11cf8a8b0fad2bdddf2fda3a12c863302359ccc20ba9eac12f1917c4b80/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f706f6e6765652f64617461626173652d736368656d612d76697375616c697a6174696f6e2e737667)](https://packagist.org/packages/pongee/database-schema-visualization)[![Minimum PHP Version](https://camo.githubusercontent.com/e254d2360ba947036667c1479973c00c113b48a313a5244927fa0247862600f0/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f7068702d762f706f6e6765652f64617461626173652d736368656d612d76697375616c697a6174696f6e)](https://php.net/)[![License](https://camo.githubusercontent.com/73eb09f1570cda4c860af0030775fbff220e1cca3e3ad1cc59dbe41100241cd2/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6c6963656e73652f706f6e6765652f64617461626173652d736368656d612d76697375616c697a6174696f6e)](https://github.com/pongee/database-schema-visualization/blob/main/LICENSE)[![GitHub code size in bytes](https://camo.githubusercontent.com/472e74898183ef2c801b270c0b3c1f7d9f12d15b1e32b5eaeeb32f84a0d4cb18/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6c616e6775616765732f636f64652d73697a652f706f6e6765652f64617461626173652d736368656d612d76697375616c697a6174696f6e)](https://camo.githubusercontent.com/472e74898183ef2c801b270c0b3c1f7d9f12d15b1e32b5eaeeb32f84a0d4cb18/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6c616e6775616765732f636f64652d73697a652f706f6e6765652f64617461626173652d736368656d612d76697375616c697a6174696f6e)

Project goal
------------

[](#project-goal)

The aim of this project is to generate database documentation from sql schema.

Supported databases
-------------------

[](#supported-databases)

- MySQL
- MariaDB
- Apache Cassandra (Basics)

Supported Output formats
------------------------

[](#supported-output-formats)

- PNG, SVG image
- Plantuml raw text
- Json

Pre Installation
----------------

[](#pre-installation)

-

Installation
------------

[](#installation)

```
$ composer require pongee/database-schema-visualization
or add it the your composer.json and make a composer update pongee/database-schema-visualization.
```

Usage
-----

[](#usage)

### In console

[](#in-console)

#### PNG export

[](#png-export)

```
$  php ./database-schema-visualization mysql:image ./example/schema/sakila.sql > ./example/img/sakila.png
$  php ./database-schema-visualization mysql:image --type png ./example/schema/sakila.sql > ./example/img/sakila.png
```

Output: [![Example output](example/img/sakila.png?raw=true "Output")](example/img/sakila.png?raw=true)

#### SVG export

[](#svg-export)

```
$  php ./database-schema-visualization mysql:image --type svg ./example/schema/sakila.sql > ./example/img/sakila.svg
```

#### Json export

[](#json-export)

```
$  php ./database-schema-visualization mysql:json ./example/schema/sakila.sql
```

#### Plantuml export

[](#plantuml-export)

```
$  php ./database-schema-visualization mysql:plantuml ./example/schema/sakila.sql
```

### PHP

[](#php)

#### Png export

[](#png-export-1)

```