io.stallion.dataAccess.db

Class SqlCheckNeedsMigrationAction

java.lang.Object

io.stallion.dataAccess.db.SqlCheckNeedsMigrationAction

All Implemented Interfaces:

StallionRunAction<SqlMigrateCommandOptions>

public class SqlCheckNeedsMigrationAction
extends Object
implements StallionRunAction<SqlMigrateCommandOptions>

A command-line action that checks to see if a database migration needs to be run, that is if there is a SQL migration file in the sql folder that has not yet been marked as run in the database. This is used by the publish/deployment action, if a migration has not been run, deployment should be aborted.

Constructor Summary

Constructors

Constructor and Description
SqlCheckNeedsMigrationAction()

Method Summary

Modifier and Type	Method and Description
void	execute(SqlMigrateCommandOptions options) Actually do the action.
String	getActionName() The name of the action, will be used on the command line to run the action.
String	getHelp() A friendly description of what the action does, will be printed on the command-line when help is asked for.
void	loadApp(SqlMigrateCommandOptions options) Load the application context.
SqlMigrateCommandOptions	newCommandOptions() Each action might have its own command-line arguments.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.stallion.boot.StallionRunAction

getSubActionName

Constructor Detail

SqlCheckNeedsMigrationAction

public SqlCheckNeedsMigrationAction()

Method Detail

getActionName

public String getActionName()

Description copied from interface: StallionRunAction

The name of the action, will be used on the command line to run the action.

Specified by:

getActionName in interface StallionRunAction<SqlMigrateCommandOptions>

Returns:

getHelp

public String getHelp()

Description copied from interface: StallionRunAction

A friendly description of what the action does, will be printed on the command-line when help is asked for.

Specified by:

getHelp in interface StallionRunAction<SqlMigrateCommandOptions>

Returns:

newCommandOptions

public SqlMigrateCommandOptions newCommandOptions()

Description copied from interface: StallionRunAction

Each action might have its own command-line arguments. Define your command-line arguments by creating a subclass of BaseCommandOptions. Then override this method to construct an instance of the subclass you created and return it.

Specified by:

newCommandOptions in interface StallionRunAction<SqlMigrateCommandOptions>

Returns:

loadApp

public void loadApp(SqlMigrateCommandOptions options)

Description copied from interface: StallionRunAction

Load the application context. Some actions just need the settings loaded. Other actions need the settings plus all the services and data access layers. Other actions need all the former plus need to start jobs and the async task coordinator. Call exactly what you need to load in this method.

Specified by:

loadApp in interface StallionRunAction<SqlMigrateCommandOptions>

execute

public void execute(SqlMigrateCommandOptions options)
             throws Exception

Description copied from interface: StallionRunAction

Actually do the action.

Specified by:

execute in interface StallionRunAction<SqlMigrateCommandOptions>

Throws:

Exception