Package org.sgrewritten.stargate.migration

Class SQLDatabaseMigrator

java.lang.Object

org.sgrewritten.stargate.migration.SQLDatabaseMigrator

public class SQLDatabaseMigrator
extends Object

Helps with running sql database migrations by reading sql files. - Can read multiple queries in the same file - Can parse already defined stargate SQL statements and run them (in the same file)

Constructor Summary

Constructors

Constructor	Description
SQLDatabaseMigrator(@NotNull SQLDatabaseAPI database, @NotNull TableNameConfiguration nameConfiguration, @NotNull String sqlFilesPath, boolean interServerEnabled)

Method Summary

Modifier and Type	Method	Description
void	run()	Run multiple SQL scripts in specified directory (constructor)

Methods inherited from class java.lang.Object

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

Constructor Details

SQLDatabaseMigrator

public SQLDatabaseMigrator(@NotNull
 @NotNull SQLDatabaseAPI database,
 @NotNull
 @NotNull TableNameConfiguration nameConfiguration,
 @NotNull
 @NotNull String sqlFilesPath,
 boolean interServerEnabled)

Parameters:

database -

A database api able to provide sql statements

nameConfiguration -

SQL table name config

sqlFilesPath -

The internal resource path to the SQL files to run

interServerEnabled -

Whether inter server portals are enabled

Method Details

run

public void run()
         throws SQLException,
IOException

Run multiple SQL scripts in specified directory (constructor)

Throws:

SQLException -

Any sql exception

IOException -

if unable to read the internal file