liquibase.change.custom

Interface CustomChange

All Known Subinterfaces:

CustomSqlChange, CustomTaskChange

public interface CustomChange

Interface to implement when creating a custom change. Actual custom changes implementations need to implement CustomSqlChange or CustomTaskChange.

See https://docs.liquibase.com/change-types/custom-change.html for more information.

Method Summary

Modifier and Type	Method and Description
String	getConfirmationMessage() Confirmation message to be displayed after the change is executed
void	setFileOpener(ResourceAccessor resourceAccessor) Sets the fileOpener that should be used for any file loading and resource finding for files that are provided by the user.
void	setUp() This method will be called after the no arg constructor and all of the properties have been set to allow the task to do any heavy tasks or more importantly generate any exceptions to report to the user about the settings provided.
ValidationErrors	validate(Database database) Tests that the change is configured correctly before attempting to execute it.

Method Detail

getConfirmationMessage

String getConfirmationMessage()

Confirmation message to be displayed after the change is executed

Returns:

a String containing the message after the change is executed

setUp

void setUp()
    throws SetupException

This method will be called after the no arg constructor and all of the properties have been set to allow the task to do any heavy tasks or more importantly generate any exceptions to report to the user about the settings provided.

Throws:

SetupException

setFileOpener

void setFileOpener(ResourceAccessor resourceAccessor)

Sets the fileOpener that should be used for any file loading and resource finding for files that are provided by the user.

validate

ValidationErrors validate(Database database)

Tests that the change is configured correctly before attempting to execute it.

Parameters:

database - The database the change will be ran against