通过 
搜索
搜索softmg / mongodb-migrations
为 MongoDB 管理数据库迁移
1.0.4
2017-05-23 14:57 UTC
Requires
- php: >=5.3.2
- doctrine/mongodb: 1.*
- symfony/console: ~3.0
- symfony/yaml: ~3.0
Requires (Dev)
- antimattr/test-case: ~1.0@stable
- friendsofphp/php-cs-fixer: ~1
- mikey179/vfsstream: 1.*
- phpunit/phpunit: ~4.0
README
AntiMattr MongoDB 迁移库为 MongoDB 提供了管理的迁移支持。
你是否熟悉 Doctrine Migrations？
此库故意与提供的结构和功能并行。
安装
使用 composer 进行安装
composer install
功能
功能 - 配置
类似于 Doctrine Migrations，配置被分成两个文件
- 连接配置（php）
- 迁移配置（xml 或 yaml）
示例连接配置 "test_antimattr_mongodb.php"
/** * @link https://php.ac.cn/manual/en/mongoclient.construct.php */ return array( 'host' => 'localhost', // default is localhost 'port' => '27017', // default is 27017 'dbname' => null, // optional, if authentication DB is required 'user' => null, // optional, if authentication is required 'password' => null, // optional, if authentication is required 'options' => array( 'connect' => true // recommended ) );
支持 XML 或 YAML 迁移配置
示例 XML "test_antimattr_mongodb.xml"
<?xml version="1.0" encoding="UTF-8"?> <antimattr-migrations xmlns="http://doctrine-project.org/schemas/migrations/configuration" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://doctrine-project.org/schemas/migrations/configuration http://doctrine-project.org/schemas/migrations/configuration.xsd"> <name>AntiMattr Sandbox Migrations</name> <migrations-namespace>AntiMattrMigrationsTest</migrations-namespace> <database name="test_antimattr_migrations" /> <collection name="antimattr_migration_versions_test" /> <migrations-directory>/path/to/migrations/classes/AntiMattrMigrations</migrations-directory> <!-- Script Directory Optional --> <migrations-script-directory>/path/to/migrations/script_directory</migrations-script-directory> </antimattr-migrations>
示例 YAML "test_antimattr_mongodb.yml"
--- name: AntiMattr Sandbox Migrations migrations_namespace: AntiMattrMigrationsTest database: test_antimattr_migrations collection_name: antimattr_migration_versions_test migrations_directory: /path/to/migrations/classes/AntiMattrMigrations migrations_script_directory: /path/to/migrations/script_directory # optional
功能 - 控制台命令支持
在演示目录中有一个示例控制台应用程序
这是如何在您的应用程序中注册命令的方式
require '../../vendor/autoload.php'; error_reporting(E_ALL & ~E_NOTICE); use AntiMattr\MongoDB\Migrations\Tools\Console\Command as AntiMattr; use Symfony\Component\Console\Application; $application = new Application(); $application->addCommands(array( new AntiMattr\ExecuteCommand(), new AntiMattr\GenerateCommand(), new AntiMattr\MigrateCommand(), new AntiMattr\StatusCommand(), new AntiMattr\VersionCommand() )); $application->run();
注意控制台是可执行的
> cd demo/ConsoleApplication/ > ./console Console Tool Usage: [options] command [arguments] Options: --help -h Display this help message. --quiet -q Do not output any message. --verbose -v|vv|vvv Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug --version -V Display this application version. --ansi Force ANSI output. --no-ansi Disable ANSI output. --no-interaction -n Do not ask any interactive question. Available commands: help Displays help for a command list Lists commands mongodb mongodb:migrations:execute Execute a single migration version up or down manually. mongodb:migrations:generate Generate a blank migration class. mongodb:migrations:migrate Execute a migration to a specified version or the latest available version. mongodb:migrations:status View the status of a set of migrations. mongodb:migrations:version Manually add and delete migration versions from the version table.
功能 - 生成新的迁移
> ./console mongodb:migrations:generate --db-configuration=config/test_antimattr_mongodb.php --configuration=config/test_antimattr_mongodb.yml Generated new migration class to "Example/Migrations/TestAntiMattr/MongoDB/Version20140822185742.php"
功能 - 迁移状态
> ./console mongodb:migrations:status --db-configuration=config/test_antimattr_mongodb.php --configuration=config/test_antimattr_mongodb.yml == Configuration >> Name: AntiMattr Example Migrations >> Database Driver: MongoDB >> Database Name: test_antimattr_migrations >> Configuration Source: demo/ConsoleApplication/config/test_antimattr_mongodb.yml >> Version Collection Name: migration_versions >> Migrations Namespace: Example\Migrations\TestAntiMattr\MongoDB >> Migrations Directory: Example/Migrations/TestAntiMattr/MongoDB >> Current Version: 0 >> Latest Version: 2014-08-22 18:57:44 (20140822185744) >> Executed Migrations: 0 >> Executed Unavailable Migrations: 0 >> Available Migrations: 3 >> New Migrations: 3
功能 - 迁移所有迁移
这是在您的部署过程中将执行的操作。
./console mongodb:migrations:migrate --db-configuration=config/test_antimattr_mongodb.php --configuration=config/test_antimattr_mongodb.yml
AntiMattr Example Migrations
WARNING! You are about to execute a database migration that could result in data lost. Are you sure you wish to continue? (y/n)y
Migrating up to 20140822185744 from 0
++ migrating 20140822185742
Collection test_a
metric before after difference
================================================================================
count 100 100 0
size 20452 20452 0
avgObjSize 204.52 204.52 0
storageSize 61440 61440 0
numExtents 2 2 0
nindexes 1 2 1
lastExtentSize 49152 49152 0
paddingFactor 1 1 0
totalIndexSize 8176 16352 8176
++ migrated (0.03s)
++ migrating 20140822185743
++ migrated (0s)
++ migrating 20140822185744
++ migrated (0s)
------------------------
++ finished in 0.03
++ 3 migrations executed
功能 - 执行单个迁移
./console mongodb:migrations:execute --db-configuration=config/test_antimattr_mongodb.php --configuration=config/test_antimattr_mongodb.yml 20140822185742 WARNING! You are about to execute a database migration that could result in data lost. Are you sure you wish to continue? (y/n)y ++ migrating 20140822185742 Collection test_a metric before after difference ================================================================================ count 100 100 0 size 20620 20620 0 avgObjSize 206.2 206.2 0 storageSize 61440 61440 0 numExtents 2 2 0 nindexes 1 2 1 lastExtentSize 49152 49152 0 paddingFactor 1 1 0 totalIndexSize 8176 16352 8176 ++ migrated (0.02s)
功能 - 版本升级或降级
由于某种原因，您的迁移历史记录不同步吗？您可以在不运行底层迁移的情况下手动添加或删除历史记录中的记录。
您可以删除
./console mongodb:migrations:version --db-configuration=config/test_antimattr_mongodb.php --configuration=config/test_antimattr_mongodb.yml --delete 20140822185744
您可以添加
./console mongodb:migrations:version --db-configuration=config/test_antimattr_mongodb.php --configuration=config/test_antimattr_mongodb.yml --add 20140822185744
功能 - 分析迁移
确定您想要分析的集合。在运行迁移前后将捕获统计信息。
class Version20140822185742 extends AbstractMigration { public function up(Database $db) { $testA = $db->selectCollection('test_a'); $this->analyze($testA); // Do the migration }
功能 - 执行 JS 脚本
首先在迁移配置中确定脚本目录
--- name: AntiMattr Sandbox Migrations migrations_namespace: AntiMattrMigrationsTest database: test_antimattr_migrations collection_name: antimattr_migration_versions_test migrations_directory: /path/to/migrations/classes/AntiMattrMigrations migrations_script_directory: /path/to/migrations/script_directory # optional
然后通过 AbstractMigration::executeScripts 执行脚本
class Version20140822185743 extends AbstractMigration { public function up(Database $db) { $result = $this->executeScript($db, 'test_script.js'); }
拉取请求
拉取请求 - PSR 标准
请使用预提交钩子运行所有代码以符合 PSR 标准
一次性安装
./bin/install.sh
Copying /antimattr-mongodb-migrations/bin/pre-commit.sh -> /antimattr-mongodb-migrations/bin/../.git/hooks/pre-commit
拉取请求 - 测试
请确保测试通过
$ vendor/bin/phpunit tests
拉取请求 - 代码 Sniffer 和 Fixer
如果没有运行预提交钩子，请确保手动运行修复器/嗅探器
$ vendor/bin/php-cs-fixer fix src/ $ vendor/bin/php-cs-fixer fix tests/