Migrations for MongoDB based on PHPMongo ODM
Schema not required in MongoDb, so we dont need to create databases, collections or altering them. However there are some cases when migrations required in schemaless databases:
- Creating collections with special parameters, like capped collection;
- Renaming or deleting collections;
- Creating, renaming or deleting fields;
- Creating, changing or deleting indexes;
- PHP 5
- PHP 5.3 not supported starting from 2018-10-19
- PHP 5.4 - PHP 5.6
- PHP Mongo Extension 0.9 or above (Some features require >= 1.5)
- PHP 7
- PHP MongoDB Extension 1.0 or above
- Compatibility layer. Please, note some restrictions
- HHVM
- HHVM Driver not supported.
composer require sokil/php-mongo-migrator
After installation you will be able to run commands in console by running ./vendor/bin/mongo-migrator command.
Run in shell:
wget http://phpmongokit.github.io/dists/mongo-migrator.phar && chmod +x mongo-migrator.phar && sudo mv mongo-migrator.phar /usr/local/bin
PHPMongo currently based on old ext-mongo entension. To use this ODM with PHP 7, you need to add compatibility layer, which implement API of old extension over new ext-mongodb. To start using PHPMongo with PHP7, add requirement alcaeus/mongo-php-adapter to composer. Restrictions for using ODM with compatibility layer you can read in known issues of original adapter.
You need to require adapter:
composer require alcaeus/mongo-php-adapter
$ ./mongo-migrator
Console Tool
Usage:
command [options] [arguments]
Options:
-h, --help Display this help message
-q, --quiet Do not output any message
-V, --version Display this application version
--ansi Force ANSI output
--no-ansi Disable ANSI output
-n, --no-interaction Do not ask any interactive question
-v|vv|vvv, --verbose Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
Available commands:
create Create new migration
help Displays help for a command
init Initialize migrations project
list Lists commands
migrate Migrate to specific revision of database
rollback Rollback to specific version of database
status Show status of migrations
Every command run in project root where composer.json and vendor dir placed. First we need to create new migration project. To do that go to project root and run:
vendor/bin/mongo-migrator init
This creates config file mongo-migrator.yaml and directory "./migrations", where migrations placed. Also you can use php config instead of yaml. Just initialise your project with php config format:
vendor/bin/mongo-migrator init --configFormat=php
YAML configuration file placed in file "./mongo-migrator.yaml". PHP has same structure.
default_environment: development
path:
migrations: migrations
environments:
development:
dsn: mongodb://localhost
default_database: test
log_database: test
log_collection: migrations
staging:
dsn: mongodb://localhost
default_database: test
log_database: test
log_collection: migrations
production:
dsn: mongodb://localhost
default_database: test
log_database: test
log_collection: migrations
Environment is set of configuration parameters, defined for concrete place, like development machine, test or production server.
-
default_environment - some commands required to know environment, where they executed. This parameters defines which environment to use if environment not specified.
-
path.migrations - path to migrations directory, where migration scripts placed.
-
environments - section of environment configs.
Every environment has this parameters:
-
environments.*.dsn - DSN which used to connect to mongo server
-
environments.*.connectOptions - options of MongoClient, described in \MongoClient PHP manual
-
environments.*.default_database - databse, used if no database specified id migration script
-
environments.*.log_database - database, used to store migration log
-
environments..log_collection - collection of database environments..log_database used to store migration log
Any value may be initialised from environment variable:
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)%"
Now you can create your migration script. Creating new revison:
vendor/bin/mongo-migrator create revision_name
Name of revision must be in camel case format. For example run vendor/bin/mongo-migrator create RevisionName
.
This creates migration script like 20151127093706_RevisionName.php, where "20151127093706"
is revision id and "RevisionName" is revision name.
pc:~/php-mongo-migrator$ ./bin/mongo-migrator create RevisionName
New migration created at ~/php-mongo-migrator/migrations/20151127093706_RevisionName.php
Class source is:
<?php
class RevisionName extends \Sokil\Mongo\Migrator\AbstractMigration
{
public function up()
{
}
public function down()
{
}
}
Method up() filled with commands executed on migrating process, and down() - on rollback.
Now you can write code for migration and rollback.
If you want to see list of existed revisions with status of migration, run:
vendor/bin/mongo-migrator status [-e environment]
If revision status is "up", revision is applied, otherwise status will be "down".
Revision Status Name
-----------------------------------
20140607165612 down Test2
20140607141237 up Test1
20140607132630 up RevisionName
You can migrate and rollback to any of available revisions. Commands to migrate:
vendor/bin/mongo-migrator migrate [-r revision] [-e environment]
If revision not specified, migration goes to latest revision.
Command to rollback:
vendor/bin/mongo-migrator rollback [-r revision] [-e environment]
If revision not specified, rollback goes to previous revision.
Databases and collections accessable from migration script through methods
AbstractMigration::getDatabase and AbstractMigration::getCollection. Method
AbstractMigration::getCollection get's collection of default database, defined in
"environments.*.default_database" parameter of config.
Documentation on database and collection classes may be found in 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')
});
}
}
- Install box using manual at https://github.com/box-project/box2
- Build phar
make
To start development environment in docker run:
PHPMONGO_DEBUG=1 docker-compose up
Local tests:
composer.phar test
Docker tests:
docker-compose up