Main (liquibase-root 3.10.1 API)

java.lang.Object
- liquibase.integration.commandline.Main

```
public class Main
extends Object
```
Class for executing Liquibase via the command line.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

protected static class Main.CodePointCheck

Nested Classes
Modifier and Type	Class and Description
`protected static class`	`Main.CodePointCheck`

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`changeExecListenerClass`
`protected String`	`changeExecListenerPropertiesFile`
`protected String`	`changeLogFile`
`protected Map<String,Object>`	`changeLogParameters`
`protected String`	`changeSetAuthor`
`protected String`	`changeSetContext`
`protected ClassLoader`	`classLoader`
`protected String`	`classpath`
`protected String`	`command`
`protected Set<String>`	`commandParams`
`protected String`	`contexts`
`protected String`	`currentDateTimeFunction`
`protected String`	`databaseChangeLogLockTableName`
`protected String`	`databaseChangeLogTableName`
`protected String`	`databaseChangeLogTablespaceName`
`protected String`	`databaseClass`
`protected String`	`dataOutputDirectory`
`protected String`	`defaultCatalogName`
`protected String`	`defaultSchemaName`
`protected String`	`defaultsFile`
`protected String`	`delimiter`
`protected String`	`diffTypes`
`protected String`	`driver`
`protected String`	`driverPropertiesFile`
`protected String`	`excludeObjects`
`protected Boolean`	`includeCatalog`
`protected String`	`includeObjects`
`protected Boolean`	`includeSchema`
`protected Boolean`	`includeSystemClasspath`
`protected Boolean`	`includeTablespace`
`protected String`	`labels`
`protected String`	`liquibaseCatalogName`
`protected String`	`liquibaseProLicenseKey`
`protected String`	`liquibaseSchemaName`
`protected String`	`logFile`
`protected String`	`logLevel`
`protected String`	`outputDefaultCatalog`
`protected String`	`outputDefaultSchema`
`protected String`	`outputFile`
`protected String`	`outputSchemasAs`
`protected String`	`overwriteOutputFile`
`protected String`	`password`
`protected Boolean`	`promptForNonLocalDatabase`
`protected String`	`propertyProviderClass`
`protected String`	`referenceDefaultCatalogName`
`protected String`	`referenceDefaultSchemaName`
`protected String`	`referenceDriver`
`protected String`	`referencePassword`
`protected String`	`referenceSchemas`
`protected String`	`referenceUrl`
`protected String`	`referenceUsername`
`protected String`	`rollbackScript`
`protected String`	`schemas`
`protected String`	`snapshotFormat`
`protected String`	`sqlFile`
`protected Boolean`	`strict`
`protected String`	`url`
`protected String`	`username`

Constructor Summary

Constructors
Constructor and Description

Main()

Constructors
Constructor and Description
`Main()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`applyDefaults()`
`protected static Main.CodePointCheck`	`checkArg(String arg)` Check the string for known characters which cannot be handled
`protected List<String>`	`checkSetup()` After parsing, checks if the given combination of main command and can be executed.
`protected void`	`configureClassLoader()`
`protected void`	`doMigration()` Do the actual database migration, i.e.
`protected String[]`	`fixupArgs(String[] args)` On windows machines, it splits args on '=' signs.
`boolean`	`isWindows()` Determines if this program is executed on a Microsoft Windows-type of operating system.
`static void`	`main(String[] args)` Entry point.
`protected void`	`parseDefaultPropertyFiles()` Search for both liquibase.properties (or whatever the name of the current defaultsFile is) and the "local" variant liquibase.local.properties.
`protected void`	`parseOptions(String[] paramArgs)` Parses the command line options.
`protected void`	`parsePropertiesFile(InputStream propertiesInputStream)` Reads various execution parameters from an InputStream and sets our internal state according to the values found.
`protected void`	`printHelp(List<String> errorMessages, PrintStream stream)` If any errors have been found, print the list of errors first, then print the command line help text.
`protected void`	`printHelp(PrintStream stream)` Print instructions on how to use this program from the command line.
`protected void`	`reconfigureLogging()` Set up the logging to the STDOUT/STDERR console streams.
`static int`	`run(String[] args)` Process the command line arguments and perform the appropriate main action (update, rollback etc.)

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - classLoader
```
protected ClassLoader classLoader
```
  - driver
```
protected String driver
```
  - username
```
protected String username
```
  - password
```
protected String password
```
  - url
```
protected String url
```
  - databaseClass
```
protected String databaseClass
```
  - defaultSchemaName
```
protected String defaultSchemaName
```
  - outputDefaultSchema
```
protected String outputDefaultSchema
```
  - outputDefaultCatalog
```
protected String outputDefaultCatalog
```
  - liquibaseCatalogName
```
protected String liquibaseCatalogName
```
  - liquibaseSchemaName
```
protected String liquibaseSchemaName
```
  - databaseChangeLogTableName
```
protected String databaseChangeLogTableName
```
  - databaseChangeLogLockTableName
```
protected String databaseChangeLogLockTableName
```
  - databaseChangeLogTablespaceName
```
protected String databaseChangeLogTablespaceName
```
  - defaultCatalogName
```
protected String defaultCatalogName
```
  - changeLogFile
```
protected String changeLogFile
```
  - overwriteOutputFile
```
protected String overwriteOutputFile
```
  - classpath
```
protected String classpath
```
  - contexts
```
protected String contexts
```
  - labels
```
protected String labels
```
  - driverPropertiesFile
```
protected String driverPropertiesFile
```
  - propertyProviderClass
```
protected String propertyProviderClass
```
  - changeExecListenerClass
```
protected String changeExecListenerClass
```
  - changeExecListenerPropertiesFile
```
protected String changeExecListenerPropertiesFile
```
  - promptForNonLocalDatabase
```
protected Boolean promptForNonLocalDatabase
```
  - includeSystemClasspath
```
protected Boolean includeSystemClasspath
```
  - strict
```
protected Boolean strict
```
  - defaultsFile
```
protected String defaultsFile
```
  - diffTypes
```
protected String diffTypes
```
  - changeSetAuthor
```
protected String changeSetAuthor
```
  - changeSetContext
```
protected String changeSetContext
```
  - dataOutputDirectory
```
protected String dataOutputDirectory
```
  - referenceDriver
```
protected String referenceDriver
```
  - referenceUrl
```
protected String referenceUrl
```
  - referenceUsername
```
protected String referenceUsername
```
  - referencePassword
```
protected String referencePassword
```
  - referenceDefaultCatalogName
```
protected String referenceDefaultCatalogName
```
  - referenceDefaultSchemaName
```
protected String referenceDefaultSchemaName
```
  - currentDateTimeFunction
```
protected String currentDateTimeFunction
```
  - command
```
protected String command
```
  - commandParams
```
protected Set<String> commandParams
```
  - logLevel
```
protected String logLevel
```
  - logFile
```
protected String logFile
```
  - changeLogParameters
```
protected Map<String,Object> changeLogParameters
```
  - outputFile
```
protected String outputFile
```
  - excludeObjects
```
protected String excludeObjects
```
  - includeCatalog
```
protected Boolean includeCatalog
```
  - includeObjects
```
protected String includeObjects
```
  - includeSchema
```
protected Boolean includeSchema
```
  - includeTablespace
```
protected Boolean includeTablespace
```
  - outputSchemasAs
```
protected String outputSchemasAs
```
  - referenceSchemas
```
protected String referenceSchemas
```
  - schemas
```
protected String schemas
```
  - snapshotFormat
```
protected String snapshotFormat
```
  - liquibaseProLicenseKey
```
protected String liquibaseProLicenseKey
```
  - sqlFile
```
protected String sqlFile
```
  - delimiter
```
protected String delimiter
```
  - rollbackScript
```
protected String rollbackScript
```
- Constructor Detail
  - Main
```
public Main()
```
- Method Detail
  - main
```
public static void main(String[] args)
```
    Entry point. This is what gets executes when starting this program from the command line. This is actually a simple wrapper so that an errorlevel of != 0 is guaranteed in case of an uncaught exception.
    
    Parameters:
    
    args - the command line arguments
  - run
```
public static int run(String[] args)
               throws LiquibaseException
```
    Process the command line arguments and perform the appropriate main action (update, rollback etc.)
    
    Parameters:
    
    args - the command line arguments
    
    Returns:
    
    the errorlevel to be returned to the operating system, e.g. for further processing by scripts
    
    Throws:
    
    LiquibaseException - a runtime exception
  - reconfigureLogging
```
protected void reconfigureLogging()
```
    Set up the logging to the STDOUT/STDERR console streams.
  - parseDefaultPropertyFiles
```
protected void parseDefaultPropertyFiles()
                                  throws CommandLineParsingException
```
    Search for both liquibase.properties (or whatever the name of the current defaultsFile is) and the "local" variant liquibase.local.properties. The contents of the local variant overwrite parameters with the same name in the regular properties file.
    
    Throws:
    
    CommandLineParsingException - if an error occurs during parsing
  - fixupArgs
```
protected String[] fixupArgs(String[] args)
```
    On windows machines, it splits args on '=' signs. Put it back like it was.
  - checkSetup
```
protected List<String> checkSetup()
```
    After parsing, checks if the given combination of main command and can be executed.
    
    Returns:
    
    an empty List if successful, or a list of error messages
  - parsePropertiesFile
```
protected void parsePropertiesFile(InputStream propertiesInputStream)
                            throws IOException,
                                   CommandLineParsingException
```
    Reads various execution parameters from an InputStream and sets our internal state according to the values found.
    
    Parameters:
    
    propertiesInputStream - an InputStream from a Java properties file
    
    Throws:
    
    IOException - if there is a problem reading the InputStream
    
    CommandLineParsingException - if an invalid property is encountered
  - printHelp
```
protected void printHelp(List<String> errorMessages,
                         PrintStream stream)
```
    If any errors have been found, print the list of errors first, then print the command line help text.
    
    Parameters:
    
    errorMessages - List of error messages
    
    stream - the output stream to write the text to
  - printHelp
```
protected void printHelp(PrintStream stream)
```
    Print instructions on how to use this program from the command line.
    
    Parameters:
    
    stream - the output stream to write the help text to
  - checkArg
```
protected static Main.CodePointCheck checkArg(String arg)
```
    Check the string for known characters which cannot be handled
    
    Parameters:
    
    arg - Input parameter to check
    
    Returns:
    
    int A CodePointCheck object, or null to indicate all good
  - parseOptions
```
protected void parseOptions(String[] paramArgs)
                     throws CommandLineParsingException
```
    Parses the command line options. If an invalid argument is given, a CommandLineParsingException is thrown.
    
    Parameters:
    
    paramArgs - the arguments to parse
    
    Throws:
    
    CommandLineParsingException - thrown if an invalid argument is passed
  - applyDefaults
```
protected void applyDefaults()
```
  - configureClassLoader
```
protected void configureClassLoader()
                             throws CommandLineParsingException
```
    Throws:
    
    CommandLineParsingException
  - doMigration
```
protected void doMigration()
                    throws Exception
```
    Do the actual database migration, i.e. apply the ChangeSets.
    
    Throws:
    
    Exception
  - isWindows
```
public boolean isWindows()
```
    Determines if this program is executed on a Microsoft Windows-type of operating system.
    
    Returns:
    
    true if running under some variant of MS Windows, false otherwise.

Class Main

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

classLoader

driver

username

password

url

databaseClass

defaultSchemaName

outputDefaultSchema

outputDefaultCatalog

liquibaseCatalogName

liquibaseSchemaName

databaseChangeLogTableName

databaseChangeLogLockTableName

databaseChangeLogTablespaceName

defaultCatalogName

changeLogFile

overwriteOutputFile

classpath

contexts

labels

driverPropertiesFile

propertyProviderClass

changeExecListenerClass

changeExecListenerPropertiesFile

promptForNonLocalDatabase

includeSystemClasspath

strict

defaultsFile

diffTypes

changeSetAuthor

changeSetContext

dataOutputDirectory

referenceDriver

referenceUrl

referenceUsername

referencePassword

referenceDefaultCatalogName

referenceDefaultSchemaName

currentDateTimeFunction

command

commandParams

logLevel

logFile

changeLogParameters

outputFile

excludeObjects

includeCatalog

includeObjects

includeSchema

includeTablespace

outputSchemasAs

referenceSchemas

schemas

snapshotFormat

liquibaseProLicenseKey

sqlFile

delimiter

rollbackScript

Constructor Detail

Main

Method Detail

main

run

reconfigureLogging

parseDefaultPropertyFiles

fixupArgs

checkSetup

parsePropertiesFile

printHelp

printHelp

checkArg

parseOptions

applyDefaults