配置中的环境变量

任何值都可以从环境变量初始化

default_environment: common

path:
    migrations:  "%env(MONGO_MIGRATIONS_PATH)%"

environments:
    common:
        dsn: "%env(MONGO_DSN)%"
        default_database: "%env(MONGO_DEFAULT_DB)%"
        log_database: "%env(MONGO_LOG_DB)%"
        log_collection: "%env(MONGO_LOG_COLLECTION)%"

创建新修订版

现在您可以创建您的迁移脚本。创建新修订版

vendor/bin/mongo-migrator create revision_name

修订版名称必须采用驼峰式格式。例如运行 vendor/bin/mongo-migrator create RevisionName。这会创建迁移脚本 20151127093706_RevisionName.php，其中 "20151127093706" 是修订版 ID，"RevisionName" 是修订版名称。

pc:~/php-mongo-migrator$ ./bin/mongo-migrator create RevisionName
New migration created at ~/php-mongo-migrator/migrations/20151127093706_RevisionName.php

类来源是

<?php

class RevisionName extends \Sokil\Mongo\Migrator\AbstractMigration
{
    public function up()
    {
        
    }
    
    public function down()
    {
        
    }
}

方法 up() 填充了在迁移过程中执行的命令，而 down() - 在回滚时。

现在您可以编写迁移和回滚的代码。

迁移状态

如果您想查看现有修订版的列表及其迁移状态，请运行

vendor/bin/mongo-migrator status [-e|--environment environment=ENVIRONMENT] [-c|--configuration=CONFIGURATION] [-l|--length=LENGTH]

如果修订版状态是 "up"，则修订版已应用，否则状态将是 "down"。

 Revision        Status  Name            
-----------------------------------       
 20140607165612  down    Test2           
 20140607141237  up      Test1           
 20140607132630  up      RevisionName

选项 configuration 允许指定项目配置的路径，如果它不同于默认路径。选项 length 允许限制列表中的元素数量。

迁移和回滚

您可以将迁移和回滚到任何可用的修订版。迁移命令

vendor/bin/mongo-migrator migrate  [-r|--revision revision] [-e|--environment environment] [-c|--configuration configuration]

如果没有指定修订版，迁移将进行到最新修订版。

选项 configuration 允许指定项目配置的路径，如果它不同于默认路径。

回滚命令

vendor/bin/mongo-migrator rollback [-r|--revision revision] [-e|--environment environment] [-c|--configuration configuration]

如果没有指定修订版，回滚将进行到上一个修订版。

选项 configuration 允许指定项目配置的路径，如果它不同于默认路径。

编写迁移脚本

迁移脚本可以通过方法 AbstractMigration::getDatabase 和 AbstractMigration::getCollection 访问数据库和集合。方法 AbstractMigration::getCollection 获取默认数据库的集合，默认数据库在
"environments.*.default_database" 配置参数中定义。

有关数据库和集合类的文档可以在 https://github.com/sokil/php-mongo 中找到。

<?php

class RevisionName extends \Sokil\Mongo\Migrator\AbstractMigration
{
    protected function init() 
    {
        // some common code
    }
    
    public function up()
    {
        $collection = $this
            ->getDatabase('some_database')
            ->getCollection('come_collection');

        // create new field in all documents of collection
        $collection->updateAll(function($operator) {
            $operator->set('newField', 'defaultValue')
        });
    }
    
    public function down()
    {
        $collection = $this
            ->getDatabase('some_database')
            ->getCollection('come_collection');

        // create new field in all documents of collection
        $collection->updateAll(function($operator) {
            $operator->unsetField('newField')
        });
    }
}

构建 Phar

1. 使用手册安装 box，网址为 https://github.com/box-project/box2。它必须作为 box 可访问。

2. 检查是否已安装并可通过 PATH 访问 composer

3. 您可以通过三种模式构建 Phar：未签名版本、由 OPENSSH 签名（用于运行时的自我测试）和由 GPG 签名（用于通过 phive 安装）

3.1) 要构建未签名版本，只需运行 make

make

3.2) 要构建由 OPENSSH 签名的 Phar，您需要拥有自己的私钥。将其复制到 ./keys/private.pem 或生成一个新的私钥

# Generate new one:
openssl genrsa -des3 -out private.pem 4096
# If you want to remove passphrase
openssl rsa -in private.pem -out private.pem
# generate public
openssl rsa -in private.pem -outform PEM -pubout -out public.pem

然后构建 Phar

make openssh-signed

3.3) 要构建用于 phive 的 GPG 签名 Phar，您需要将私钥放置在 ./keys/private.ask

gpg --gen-key
gpg --export-secret-keys your@mail.com > keys/private.asc

然后构建 GPG 签名的 Phar

make gpg-signed

您可以使用公钥验证 Phar

$ gpg --verify mongo-migrator.phar.asc mongo-migrator.phar
gpg: Signature made чт, 22-лис-2018 23:27:46 +0200 EET
gpg:                using RSA key F530929F7ED528F0
gpg:                issuer "dmytro.sokil@gmail.com"
gpg: Good signature from "Dmytro Sokil <dmytro.sokil@gmail.com>" [ultimate]

您可以通过定义 MONGO_DRIVER 环境变量为 legacy 和新驱动程序构建 Phar

make gpg-signed MONGO_DRIVER=new
make gpg-signed MONGO_DRIVER=legacy

如果未传递 MONGO_DRIVER 环境变量，则 make 将自动尝试检测您的驱动程序。

开发

要使用 docker 运行开发环境，请运行

./run-docker-cli.sh

要使用 xdebug，请将您的 IDE 配置为使用端口 9001。

有一个沙箱用于测试命令

cd /phpmongo/tests/
export PHPMONGO_DSN="mongodb://mongodb32"; ../bin/mongo-migrator -vvv status -l 4 -e docker

单元测试

本地测试

composer.phar test

Docker 测试

./run-docker-tests.sh