collective.metadataversion 0.2.1

Features

• provides a simple metadata_version metadata attribute, and

• a simple utility to reindex objects only if their metadata_version is outdated

Examples

This is how the .utils.make_metadata_updater utility function is used.

In your policy package’s setuphandler module, you may have:

from collective.metadataversion.decorator import step
from collective.metadataversion.utils import make_metadata_updater

...
@step
def update_metadata_of_prominent_objects(context, logger):
    reindex = make_metadata_updater(context, logger, 42)
    catalog = getToolByName(context, 'portal_catalog')
    updated, skipped = 0, 0
    for brain in catalog(<my fancy query>):
        if reindex(brain):
            updated += 1
        else:
            skipped += 1
    (... logging ad libitum ...)

@step
def update_metadata_of_remaining_objects(context, logger):
    reindex = make_metadata_updater(context, logger, 42)
    catalog = getToolByName(context, 'portal_catalog')
    updated, skipped = 0, 0
    for brain in catalog({}):
        if reindex(brain):
            updated += 1
        else:
            skipped += 1
    (... logging ad libitum ...)

The reindex function returned by make_metadata_updater() will reindex every object (given by brain) which has not been recently reindexed (with metadata_version=42), and by default refresh a “cheap” selection of indexes.

Starting with the 2nd call to the first upgrade step, nothing will be actually reindexed anymore (unless your <fancy query> spans some more objects now), since everything is up-to-date; the 2nd upgrade step will update all remaining objects (which might not need to be updated so urgently), and skip all objects caught by the <fancy query>.

Translations

This product has been translated into

• English

• German

Installation

Install collective.metadataversion by adding it to your buildout:

[buildout]
...
eggs =
    collective.metadataversion

and then running bin/buildout.

After your Zope instance was restarted, you’ll have the collective.metadataversion package in your extensions view (/prefs_install_products_form), or in the “Quick installer”; select and activate it.

After activation, you’ll have a (prefixed) metadata_version key in your configuration registry which you can adjust according to your needs.

Contribute

• Issue Tracker: https://github.com/collective/metadataversion/issues

• Source Code: https://github.com/collective/metadataversion

Support

If you are having issues, please let us know; please use the issue tracker mentioned above.

License

The project is licensed under the GPLv2.

Contributors

• Tobias Herp, tobias.herp@visaplan.com

Changelog