Download the PHP package gatherdigital/pimcore-migrations without Composer
On this page you can find all versions of the php package gatherdigital/pimcore-migrations. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download gatherdigital/pimcore-migrations
More information about gatherdigital/pimcore-migrations
Files in gatherdigital/pimcore-migrations
Package pimcore-migrations
Short Description Pimcore database migrations plugin
License proprietary
Homepage https://www.gatherdigital.co.uk/agency
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package pimcore-migrations
Pimcore Migrations Plugin
Introduction
Pimcore already does a lot of migration work for developers, all class definition changes and database schema changes can be easily ported between development, staging and production environments. However, the following use-cases for database changes are not easily portable between Pimcore environments:
- Custom persistant model schemas.
- The addition of new class definitions does not happen automatically happen in deployment.
- Changes to website settings (stored in the database) do not happen in any deployment helpers.
- Alterations to document editables, i.e. changing a textarea to wysiwyg creates invalid references to editables.
- A rename of a ClassDefinition field removes the old column, then adds a new one, rather than actually renaming.
What this plugin provides
This plugin provides a simple mechanism for implementing version controllable database changes between pimcore environments, in a lightweight convention similar to packages such as Phinx or Doctrine Migrations.
Installation
Install using composer:
Configuration
Configuration is intended to be as simple as possible.
-
After install ensure that the extensionis listed as follows in your extensions.php file
-
Migrations should be placed in your /website/var/plugins/PimcoreMigrations/migrations folder.
- The plugin will automatically install a new table into the pimcore environment upon detecting a migrations folder when the console app is executed.
Usage
Extend the AbstractMigration Class
- Each migration should extend the class PimcoreMigrations\Model\AbstractMigration.
- It can be named however you wish, although the last part of the name should be a numeric value separated by an underscore (_).
For example:
- some_table_changes_1000.php
- new_custom_persistent_class_1001.php
- anotherdifferentlynamedclass_1002.php
- Each migration class should have a similarly named classname following the same pattern as Pimcore, example:
- SomeTableChanges1000
- NewCustomPersistentClass1001
- Anotherdifferentlynamedclass1002
- If we created the classes above we would have the following versions (represented by an integer)
- 1000
- 1001
- 1002
Implement the required class methods
Each Migration should contain both an up() and down() method. UP being the default operation, and DOWN being to roll back changes. Here is an example:
Run the console app
Migrations can be run through the console application made available in the Pimcore\Cli. Running as a plugin ensures that all migrations are runnning in the Pimcore environment. There are 3 commands available and can be run as follows:
-
Check Status
-
Migrate up
- Migrate down
Use Case Example
One of our biggest concerns is keeping development, staging and production environments intact whilst there are many changes happening within the database between the development team. Pimcore Migrations features a method that allows us to keep classdefinitions in sync whilst providing a little bit of integrity checking / feedback. A typical starting migration for our projects may be as follows:
