vkovic/laravel-commando

收集了大多数项目需要的实用 Laravel artisan 命令

v0.2.1 2022-04-10 18:40 UTC

This package is auto-updated.

Last update: 2024-09-10 23:55:27 UTC


README

Build Downloads Stable License

收集了大多数项目需要的实用 Laravel artisan 命令

实用 artisan 命令,大多数 Laravel 项目都可以使用,不论项目类型。

你经常需要执行一些基本任务,比如创建或删除数据库,转储数据库或从 .sql 转储中加载数据,或者查看模型中存在哪些字段(和字段类型)吗?继续阅读,我保证会让这些任务,以及更多任务变得简单 🍻

兼容性

该包与 Laravel 版本 5.55.65.75.86.x7.x8.x 兼容。

由于一些命令依赖于原始控制台命令(如使用 mysqldumpdb:dump),目前仅支持 MySQL 数据库和 Linux 环境。该包设计为易于支持多种操作系统和数据库类型,应该容易实现,所以如果有人有兴趣帮忙,请随时贡献。

安装

通过 composer 安装包

如果您使用的是 Laravel 8,请运行

composer require vkovic/laravel-commando

如果您使用的是 Laravel 8 之前的版本,请运行

composer require vkovic/laravel-commando "^0.1"

可用命令

该包处于早期阶段,因此命令数量有限。我计划添加更多,所以如果您有任何建议,您可以通过问题页面(点击 问题 -> 新问题 -> 功能请求)要求功能。

模型相关
  • model:list ~ 列出所有应用程序 模型 和相关信息
  • model:fields ~ 显示单个 模型 和有用信息
数据库相关

php artisan model:list

显示所有模型和某些基本信息。

  • 模型(模型类)
  • 表(模型使用的表)
  • 表计数(模型相关表的记录总数)
  • 作用域计数(应用所有作用域后的记录数:$n = SomeModel::count()
  • 软删除(显示模型有多少软删除项)

使用示例

php artisan model list command from laravel-commando package

php artisan model:fields <model>

显示模型字段信息。

  • 字段(模型字段/表列)
  • 类型(数据库字段类型)
  • 可空(数据库值可以为空)
  • 默认值(默认数据库值)
  • 转换(属性赋值器)
  • 保护(字段不可批量赋值)
  • 填充(字段可批量赋值)

参数

  • model 可选:显示字段的模型(例如 "App\User")。如果省略,将显示所有模型列表以供选择。

使用示例

php artisan model fields command from laravel-commando package

php artisan db:exist <database>

检查数据库是否存在

参数
  • database 可选:要检查的数据库名称。如果省略,将检查默认数据库(在 .env 中定义)。

使用示例

php artisan db exists command from laravel-commando package

php artisan db:create <database>

创建数据库

参数

  • database 可选:要创建的数据库。如果省略,将使用 .env 中的名称。

使用示例

php artisan db create command from laravel-commando package

php artisan db:drop <database>

删除数据库

参数

  • database 可选:要删除的数据库。如果省略,将使用 .env 中的名称。

使用示例

php artisan db drop command from laravel-commando package

php artisan db:dump <database> <--dir>

将数据库导出到 .sql 文件

参数

  • database 可选:要导出的数据库。如果省略,将使用 .env 中的名称。

选项

  • --dir:创建导出的目录。如果省略,将使用默认的文件系统目录。

使用示例

php artisan db dump command from laravel-commando package

php artisan db:import-dump <database> <--dir>

.sql 文件导入导出数据

参数

  • database 可选:将导出导入到的数据库。如果省略,将使用 .env 中的名称。

选项

  • --dir:查找导出的目录。如果省略,将使用默认的文件系统目录。

使用示例

php artisan db import dump command from laravel-commando package

php artisan db:summon

删除默认数据库,然后执行迁移并种入数据。

在开发早期阶段,当我们频繁更改模型(迁移和种入数据)时很有用。

使用示例

php artisan db summon command from laravel-commando package

贡献

如果您计划修改此Laravel包,应运行随它一起提供的测试。最简单的方法是使用Dockerdocker-composephpunit

首先,我们需要初始化Docker容器(详细信息请参阅 docker-compose.yaml)。

docker-compose up --exit-code-from app

之后,我们可以运行测试并查看输出。

docker-compose run --rm app phpunit