com.haulmont.cuba.core.sys.dbupdate

Class DbUpdaterEngine

java.lang.Object

com.haulmont.cuba.core.sys.dbupdate.DbUpdaterEngine

All Implemented Interfaces:

DbUpdater

Direct Known Subclasses:

ServerDbUpdater

public class DbUpdaterEngine
extends java.lang.Object
implements DbUpdater

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DbUpdaterEngine.FileHandler
static class	DbUpdaterEngine.ScriptSplitter

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	changelogTableExists
protected javax.sql.DataSource	dataSource
protected java.lang.String	dbmsType
protected java.lang.String	dbmsVersion
protected java.lang.String	dbScriptsDirectory
protected static java.lang.String	ERROR
protected static java.util.List<java.util.regex.Pattern>	EXCLUDED_ADDONS
protected java.util.Map<java.lang.String,DbUpdaterEngine.FileHandler>	extensionHandlers
protected static org.slf4j.Logger	log
protected static java.util.regex.Pattern	RESTAPI_REGEX
protected boolean	scriptsExists
protected java.lang.String	storeName
protected static java.lang.String	UPGRADE_GROOVY_EXTENSION

Fields inherited from interface com.haulmont.cuba.core.sys.DbUpdater

NAME

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DbUpdaterEngine()

Method Summary

Modifier and Type	Method and Description
protected boolean	containsIgnoringPrefix(java.util.Collection<java.lang.String> strings, java.lang.String s)
protected void	createChangelogTable()
boolean	dbInitialized()
protected java.lang.String	dbScriptDirectoryPath()
protected java.lang.String	distinguishingSubstring(java.lang.String scriptName)
protected void	doInit()
protected void	doUpdate()
protected boolean	executeGroovyScript(ScriptResource file)
protected boolean	executeScript(ScriptResource file)
protected void	executeSql(java.lang.String sql)
protected boolean	executeSqlScript(ScriptResource file)
protected boolean	filterInitScript(ScriptResource scriptResource)
java.util.List<java.lang.String>	findUpdateDatabaseScripts()
protected java.lang.String	getConnectionUrl(java.sql.Connection connection)
protected javax.sql.DataSource	getDataSource()
protected java.util.Set<java.lang.String>	getExecutedScripts()
protected java.util.List<ScriptResource>	getInitScripts()
protected java.util.List<ScriptResource>	getInitScripts(java.lang.String oneModuleDir)
protected java.util.List<java.lang.String>	getModuleDirs()
protected java.lang.String	getScriptName(ScriptResource resource)
protected java.lang.String	getScriptName(java.lang.String path)
java.util.List<ScriptResource>	getScripts(ScriptType scriptType, java.lang.String moduleName)
protected java.util.List<ScriptResource>	getUpdateScripts()
protected java.util.List<ScriptResource>	getUpdateScripts(java.lang.String oneModuleDir)
protected boolean	initializedByOwnScript(java.util.Set<java.lang.String> executedScripts, java.lang.String dirName)
protected boolean	isEmpty(java.lang.String sql)
protected void	markScript(java.lang.String name, boolean init)
protected void	prepareScripts() Mark all SQL updates scripts as evaluated Try to execute Groovy scripts
protected void	runRequiredInitScripts()
protected ScriptScanner	scriptScanner()
void	updateDatabase()

Methods inherited from class java.lang.Object

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

Field Detail

UPGRADE_GROOVY_EXTENSION

protected static final java.lang.String UPGRADE_GROOVY_EXTENSION

See Also:

Constant Field Values

RESTAPI_REGEX

protected static final java.util.regex.Pattern RESTAPI_REGEX

EXCLUDED_ADDONS

protected static final java.util.List<java.util.regex.Pattern> EXCLUDED_ADDONS

ERROR

protected static final java.lang.String ERROR

See Also:

Constant Field Values

log

protected static final org.slf4j.Logger log

dataSource

protected javax.sql.DataSource dataSource

dbScriptsDirectory

protected java.lang.String dbScriptsDirectory

storeName

protected java.lang.String storeName

dbmsType

protected java.lang.String dbmsType

dbmsVersion

protected java.lang.String dbmsVersion

changelogTableExists

protected boolean changelogTableExists

scriptsExists

protected boolean scriptsExists

extensionHandlers

protected final java.util.Map<java.lang.String,DbUpdaterEngine.FileHandler> extensionHandlers

Constructor Detail

DbUpdaterEngine

protected DbUpdaterEngine()

Method Detail

getDataSource

protected javax.sql.DataSource getDataSource()

getScripts

public java.util.List<ScriptResource> getScripts(ScriptType scriptType,
                                                 @Nullable
                                                 java.lang.String moduleName)

updateDatabase

public void updateDatabase()
                    throws DbInitializationException

Specified by:

updateDatabase in interface DbUpdater

Throws:

DbInitializationException

findUpdateDatabaseScripts

public java.util.List<java.lang.String> findUpdateDatabaseScripts()
                                                           throws DbInitializationException

Specified by:

findUpdateDatabaseScripts in interface DbUpdater

Throws:

DbInitializationException

scriptScanner

protected ScriptScanner scriptScanner()

dbScriptDirectoryPath

protected java.lang.String dbScriptDirectoryPath()

createChangelogTable

protected void createChangelogTable()

getScriptName

protected java.lang.String getScriptName(ScriptResource resource)

getScriptName

protected java.lang.String getScriptName(java.lang.String path)

dbInitialized

public boolean dbInitialized()
                      throws DbInitializationException

Specified by:

dbInitialized in interface DbUpdater

Throws:

DbInitializationException

doInit

protected void doInit()

doUpdate

protected void doUpdate()

runRequiredInitScripts

protected void runRequiredInitScripts()

filterInitScript

protected boolean filterInitScript(ScriptResource scriptResource)

initializedByOwnScript

protected boolean initializedByOwnScript(java.util.Set<java.lang.String> executedScripts,
                                         java.lang.String dirName)

containsIgnoringPrefix

protected boolean containsIgnoringPrefix(java.util.Collection<java.lang.String> strings,
                                         java.lang.String s)

distinguishingSubstring

protected java.lang.String distinguishingSubstring(java.lang.String scriptName)

prepareScripts

protected void prepareScripts()

Mark all SQL updates scripts as evaluated Try to execute Groovy scripts

getExecutedScripts

protected java.util.Set<java.lang.String> getExecutedScripts()

markScript

protected void markScript(java.lang.String name,
                          boolean init)

isEmpty

protected boolean isEmpty(java.lang.String sql)

executeSqlScript

protected boolean executeSqlScript(ScriptResource file)

executeSql

protected void executeSql(java.lang.String sql)
                   throws java.sql.SQLException

Throws:

java.sql.SQLException

executeGroovyScript

protected boolean executeGroovyScript(ScriptResource file)

executeScript

protected boolean executeScript(ScriptResource file)

getModuleDirs

protected java.util.List<java.lang.String> getModuleDirs()

getInitScripts

protected java.util.List<ScriptResource> getInitScripts()

getInitScripts

protected java.util.List<ScriptResource> getInitScripts(@Nullable
                                                        java.lang.String oneModuleDir)

getUpdateScripts

protected java.util.List<ScriptResource> getUpdateScripts()

getUpdateScripts

protected java.util.List<ScriptResource> getUpdateScripts(@Nullable
                                                          java.lang.String oneModuleDir)

getConnectionUrl

protected java.lang.String getConnectionUrl(java.sql.Connection connection)