@Role
public interface DataMigration
"R"+vernum+issuenumber+"DataMigration"
format to prevent collisions. The format for vernum
is
MMmmbbN
where M
is the 0-leftpadded major (e.g. "6" is written as "06"), m
is the
0-leftpadded minor, b
is the 0-leftpadded bugfix number and N
a digit to be incremented in case we
have several migrations in a given release. For example, the first migration for 10.8 would have the number
1008000
.Modifier and Type | Method and Description |
---|---|
String |
getDescription() |
String |
getName() |
XWikiDBVersion |
getVersion() |
void |
migrate()
Run migration.
|
boolean |
shouldExecute(XWikiDBVersion startupVersion) |
String getName()
String getDescription()
XWikiDBVersion getVersion()
void migrate() throws DataMigrationException
DataMigrationException
- if any errorboolean shouldExecute(XWikiDBVersion startupVersion)
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.Copyright © 2004–2021 XWiki. All rights reserved.