Migration (Cyclos 4.15.15 Scripting API Documentation)

All Known Implementing Classes:

AccessClientChannelMigration, AccountNumberMigration, AddOrderProductIndexMigration, AddUpperCreditLimitFromProductMigration, BackgroundTaskIdMigration, BaseMigration, BasicProfileFieldsMigration, BuiltInChannelsMigration, BuiltinLanguagesMigration, ChannelConfigurationWhitelistMigration, CreateEmailTemplateMigration, CreateFrontendContentMigration, DeleteLanguagesMigration, DictionaryMigration, ExportFormatsMigration, FixDuplicatedAccountsMigration, FixDuplicatedAccountsV1Migration, FixDuplicatedAccountsV2Migration, FixSecurityAnswerMigration, FixWrongOrderNumbersMigration, GrantCustomWebServicesMigration, LanguagesMigration, MaskedCustomValuesMigration, MaskedValueMigration, MobileThemesMigration, NFCTokenLabelMigration, NFCTokenMigration, NFCTokenPrincipalTypeMigration, OidcChannelMigration, PasswordTypesMigration, PendingMailMigration, POSChannelMigration, PrincipalTypesMigration, PurgeUnusedAccounts, ReindexMigration, ReindexTsvectorsMigration, RemoveRelatedDataFromNeverVisibleAccountsMigration, RestoreAccountBalanceLimitFromProductMigration, SecurityAnswerEncryptionMigration, SetActiveValueInAccountsMigration, SetCustomTranslationSourceValueMigration, TransactionAccountsMigration, UseTimestampWithTZMigration
```
public interface Migration
```
Handles migrations at class-level, where statements are not enough

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`default String`	`getAffectedMessage()`	Custom message to inform the affected data.
`void`	`initialize(JdbcTemplate template, CyclosProperties CyclosProperties)`	Initializes the migration instance with the given `JdbcTemplate` and properties
`int`	`run()`	Apply the migration, returning the total number of affected records

- Method Detail
  - getAffectedMessage
```
default String getAffectedMessage()
```
    Custom message to inform the affected data.
    If not null then message must contains 2 place holders: one for the migration class an another for the affected count Eg: "{} rows affected while executing migration class: {}"
  - initialize
```
void initialize(JdbcTemplate template,
                CyclosProperties CyclosProperties)
```
    Initializes the migration instance with the given JdbcTemplate and properties
  - run
```
int run()
 throws Exception
```
    Apply the migration, returning the total number of affected records
    
    Throws:
    
    Exception