baleen / cli

此包已被废弃,不再维护。没有建议的替代包。

Baleen 迁移的控制台包装器

0.5.1 2015-10-09 14:25 UTC

README

Build Status Code Coverage Scrutinizer Code Quality Packagist

Author License

通用的、可定制的 Baleen 迁移命令行包装器。

安装

使用 Composer

composer install baleen/cli

Baleen CLI 的默认设置非常具有意见性,因此不需要额外配置即可运行。因此,如果您只想尝试一下项目,您现在可以直接跳到“使用”部分。

但您可以通过配置文件自定义几乎所有内容。要创建配置文件,请运行以下命令

./vendor/bin/baleen init

这将为您的工作目录生成两个文件

  • .baleen.yml:配置文件。
  • .baleen_versions:一个简单的文件,用于跟踪已迁移的版本。这可以后来用数据库表替换。您可能想在 VCS 系统中忽略此文件(例如,使用 Git 的 .gitignore 文件)。

如果使用默认配置值,将自动为您创建 .baleen_versions 文件。您不需要运行 baleen init 命令来创建该文件。

如果您不想输入 ./vendor/bin/baleen 来运行 baleen 命令,则可以使用 Composer 作为快捷方式。只需编辑项目的 composer.json 文件,添加以下内容

{
   "scripts": {
       "baleen": "vendor/bin/baleen --ansi"
   }
}

现在您可以通过简单地输入 composer baleen 来轻松运行 Baleen CLI!

使用

要查看一些帮助和可用命令的列表,请执行以下操作

./vendor/bin/baleen

要获取特定命令的更多帮助,请运行 ./vendor/bin/baleen help {command},其中 {command} 是可用命令的名称。

创建迁移

迁移默认存储在 ./migrations 目录下,如果不存在,每次运行命令时都会自动创建。

您可以通过编辑 .baleen.yml 配置文件来自定义用于迁移的目录以及迁移类的命名空间。

要轻松创建新的迁移文件,请运行以下命令

./vendor/bin/baleen migrations:create

运行迁移

运行迁移就像执行以下操作一样简单

./vendor/bin/baleen migrate

默认情况下,它会迁移到最新的可用版本。

如果您想查看日志而不是进度条,请将 --no-progress 选项添加到上面的迁移命令中。

文档

文档可以在 ./docs 文件夹中找到,也可以在 Read The Docs 上编译和在线查看:http://baleen-cli.readthedocs.org/en/latest/

许可证

许可协议:MIT - 更多详细信息请参阅根目录中的 LICENSE 文件。