com.xpn.xwiki.store.migration
Interface DataMigration

All Known Subinterfaces:
HibernateDataMigration
All Known Implementing Classes:
AbstractHibernateDataMigration, LegacyDataMigration, R15428XWIKI2977DataMigration, R35100XWIKI7564DataMigration, R35101XWIKI7645DataMigration, R35102XWIKI7771DataMigration, R40000XWIKI6990DataMigration, R42000XWIKI7726DataMigration, R43000XWIKI6691DataMigration, R4340XWIKI883DataMigration, R4359XWIKI1459DataMigration, R6079XWIKI1878DataMigration, R6405XWIKI1933DataMigration, R7350XWIKI2079DataMigration

@Role
public interface DataMigration

Interface for data migration. New data migration should be named like "R"+vernum+issuenumber+"DataMigration" to prevent collisions.

Since:
3.4M1
Version:
$Id: 403d06d33aa096a82950bd173f7e1211d5efebb3 $

Method Summary
 String getDescription()
           
 String getName()
           
 XWikiDBVersion getVersion()
           
 void migrate()
          Run migration.
 boolean shouldExecute(XWikiDBVersion startupVersion)
           
 

Method Detail

getName

String getName()
Returns:
the data migration hint. For example "R4340XWIKI883".

getDescription

String getDescription()
Returns:
a description of what the data migration does

getVersion

XWikiDBVersion getVersion()
Returns:
data version which need migration. before you commit stuff which needs migration, you need write data migration with version = current release number (i.e 32000 for release 3.2).

migrate

void migrate()
             throws DataMigrationException
Run migration.

Throws:
DataMigrationException - if any error

shouldExecute

boolean shouldExecute(XWikiDBVersion startupVersion)
Parameters:
startupVersion - the database version when the migration process starts (before any dataMigration is applied). This is useful for data migration which need to run only when the database is in a certain version.
Returns:
true if the migration should be executed or false otherwise


Copyright © 2004–2014 XWiki. All rights reserved.