Database diagram builder for https://dbdiagram.io/

readme.md

composer require doctrine/dbal

dbdiagram-builder.php

<?php

namespace App\Console\Commands;

use Doctrine\DBAL\Schema\AbstractSchemaManager;
use Illuminate\Console\Command;
use Illuminate\Database\ConnectionInterface;
use Illuminate\Support\Arr;

class BuildDatabaseSchemaDiagramCommand extends Command
{
    /**
     * The name and signature of the console command.
     *
     * @var string
     */
    protected $signature = 'db:diagram-build';

    /**
     * The console command description.
     *
     * @var string
     */
    protected $description = 'Build database schema diagram';

    protected $tables = [];

    /**
     * Execute the console command.
     * @param ConnectionInterface $connection
     */
    public function handle(ConnectionInterface $connection)
    {
        /** @var AbstractSchemaManager $schema */
        $schema = $connection->getDoctrineSchemaManager();

        foreach ($schema->listTables() as $table) {
            $data = [
                'columns' => [],
                'indexes' => [],
                'refs' => [],
            ];

            foreach ($table->getColumns() as $column) {
                $props = [];
                if ($column->getNotnull()) {
                    $props[] = 'not null';
                }
                if ($column->getDefault()) {
                    $props[] = 'default: `' . $column->getDefault() . '`';
                }

                if ($column->getComment()) {
                    $props[] = 'note: "' . $column->getComment() . '"';
                }

                $data['columns'][$column->getName()] = [
                    'type' => strtolower(str_replace('Type', '', class_basename($column->getType()))),
                    'props' => $props,
                ];
            }

            foreach ($table->getIndexes() as $index) {
                if ($index->isPrimary()) {
                    $data['indexes'][] = [
                        'columns' => $index->getColumns(),
                        'props' => ['pk'],
                    ];
                }

                if ($index->isUnique()) {
                    $data['indexes'][] = [
                        'columns' => $index->getColumns(),
                        'props' => ['unique'],
                    ];
                }
            }

            foreach ($table->getForeignKeys() as $foreignKey) {
                $data['refs'][] = [
                    $foreignKey->getLocalTableName() . '.' . Arr::first($foreignKey->getLocalColumns()),
                    $foreignKey->getForeignTableName() . '.' . Arr::first($foreignKey->getForeignColumns()),
                ];
            }

            $this->tables[$table->getName()] = $data;
        }

        foreach ($this->tables as $table => $defs) {
            echo 'Table ' . $table . ' {' . PHP_EOL;

            foreach ($defs['columns'] as $key => $data) {
                echo "\t";
                echo $key . ' ' . $data['type'];

                if (!empty($data['props'])) {
                    echo ' [' . implode(',', $data['props']) . ']';
                }
                echo PHP_EOL;
            }

            if (!empty($defs['indexes'])) {
                echo "\t";
                echo 'Indexes {' . PHP_EOL;
                foreach ($defs['indexes'] as $index) {
                    if (empty($index['props'])) {
                        continue;
                    }

                    echo "\t\t";
                    echo '(' . implode(', ', $index['columns']) . ') [' . implode(', ', $index['props']) . ']';
                    echo PHP_EOL;
                }

                echo "\t}" . PHP_EOL;
            }

            echo '}' . PHP_EOL . PHP_EOL;

            if (!empty($defs['refs'])) {
                foreach ($defs['refs'] as $ref) {
                    echo 'Ref: ' . implode(' > ', $ref);
                    echo PHP_EOL . PHP_EOL;
                }
            }
        }
    }
}