[MODM-43] Explicit schema migration Created: 10/Aug/10  Updated: 17/Aug/10  Resolved: 17/Aug/10

Status: Resolved
Project: Doctrine MongoDB ODM
Component/s: Hydration
Affects Version/s: None
Fix Version/s: 1.0.0BETA1

Type: New Feature Priority: Major
Reporter: Vladimir Razuvaev Assignee: Jonathan H. Wage
Resolution: Fixed Votes: 0
Labels: None


Currently supported ways of schema migration are sufficient in many cases. But I think it's worth considering to have more explicit way to migrate schema for better readability / code maintenance.

It might be useful to be able to transform original MongoDb data prior to hydration. Maybe as a new lifecycle callback (e.g. preLoad). This way one could have special property for schema version in the document and normalize data according to version differencies. e.g.:

function preLoad(array &$data)
    if(!isset($data['version'])) {
        $data['version'] = 1;
    switch($data['version']) {
        case 1:
             $data['fullName'] = $data['name'];
             // breaks are ommitted intentionally here and below
        case 2:
             $e = explode(' ', $data['fullName'])
             $data['firstname'] = $e[0];
             $data['lastname'] = $e[1];
        case 3:
             $data['address'] = array(
                 'street' => $data['street'],
                 'city' => $data['city']
         case 4:
              // current version

Just as example. It also simplifies writing tests for schema migrations as I think. Is it possible with current ODM internals? What do you think?
I could try to implement this feature if it is acceptable proposal.

Comment by Jonathan H. Wage [ 10/Aug/10 ]

I think this can be implemented already without having to change Doctrine. You just need to manage a version field and use the preLoad() like you are above. It is an acceptable idea, but I think it is already possible. What do you think?

Comment by Vladimir Razuvaev [ 11/Aug/10 ]

It's great if it is already possible. But I think there is no "preLoad", "preHydrate" or similar event right now. At least I didn't find one in code or docs.

Comment by Jonathan H. Wage [ 11/Aug/10 ]

Ok, I think maybe we can add a preLoad() event.

Comment by Jonathan H. Wage [ 17/Aug/10 ]

Fixed by http://github.com/doctrine/mongodb-odm/commit/78fefc3b70aa8ec0facd3cc4ffa27d6c88670407

Generated at Wed Oct 07 15:42:20 EDT 2015 using JIRA 6.4.10#64025-sha1:5b8b74079161cd76a20ab66dda52747ee6701bd6.