README

从数据库模式生成 Markdown 文档和 Laravel Eloquent 模型类的核心库。

安装

使用 Composer 进行安装

composer require mileschou/schemarkdown

使用以下命令生成模式文档

cd /path/to/your-laravel-project
php artisan schema:markdown

模式文档默认存储在 docs/schema 目录。使用 --path 选项可以更改它。

在其他框架中，您必须提供类似 Laravel 的配置文件。使用 --config 选项指定自定义配置。

该工具将在加载配置之前加载 .env 文件。使用 --env 选项指定 .env 路径。

使用 --database 选项指定 Laravel 配置中的 连接名称 以生成单个数据库的文档。

如果您想覆盖现有文档，请使用 --overwrite 选项。

使用以下命令生成 Eloquent 模型

cd /path/to/your-laravel-project
php artisan schema:model

它将生成模型代码到 app/Models 目录（Laravel 8 默认），使用 --path 选项可以更改输出目录。如果要更改命名空间，请使用 --namespace 选项。

在其他框架中使用 Eloquent ORM 库的项目中，您必须提供类似 Laravel 项目的配置文件。使用 --config 选项指定自定义配置。

如果您只想构建一个连接，请使用 --database 选项指定。

如果您想覆盖现有代码，请使用 --overwrite 选项。

以下是示例 SQL，导入 MySQL 并运行以下命令

php artisan schemarkdown --config=tests/Fixtures/database.php --database=examples --output-dir=examples

它将生成这些 Markdown 文档。

使用 -vv 选项查看信息日志。

MIT 许可证 (MIT)。有关更多信息，请参阅许可证文件。