collective.diversion 1.0

collective.diversion wraps the existing behaviour for broken objects in the ZODB to allow developers to declare old locations of their classes and have them be automatically migrated

collective.diversion

collective.diversion wraps the existing behaviour for broken objects in the ZODB and provides a lookup table that will be processed in advance of passing down requests. This allows developers to declare old locations of their classes and have them be automatically and seamlessly migrated to the new code on load.

Usage

Simply include the following ZCML declaration in your code:

<configure
    xmlns="http://namespaces.zope.org/zope"
    xmlns:diversion="http://namespaces.plone.org/diversion">

    <diversion:class
        old="Products.example.oldlocation"
        new="collective.example.shiny"
        />

</configure>

Caveats

Diverted classes will persist their new class when they are written. However, when ZODB stores references to persistent objects it stores both the oid and the name of the class. Those class name references will only be updated when the persistent object they are attached to is re-serialised (modified). Unfortunately this package cannot do this for you as there is no way to find the set of objects which reference a particular object (quickly). You’ll have to leave the diversion directives in your package until you can confirm that all instances and all references have been updated.

Changelog

1.0 (Unreleased)

• Overrides the cPickle.Unpickler class in ZODB ExportImport to allow for copy/paste as well as export. (MatthewWilkes)

• Rebind the class factory to existing DB connections on initialization (MatthewWilkes)

• ZCML declaration to register diversions

• Implementation of classFactory that uses diversions

Contributors

Tom Blockley Alan Hoey Matthew Wilkes

Sponsored by

Team Rubber, Bristol