Liquibase 4.26.0 · liquibase.integration.commandline.Main

Modifier and Type	Class and Description
protected static class	Main.CodePointCheck
private static enum	Main.COMMANDS
private static enum	Main.FILE_SUFFIXES
private static enum	Main.OPTIONS

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
private static final ResourceBundle	coreBundle
protected String	currentDateTimeFunction
protected String	databaseChangeLogLockTableName
protected String	databaseChangeLogTableName
protected String	databaseChangeLogTablespaceName
protected String	databaseClass
protected String	dataOutputDirectory
protected Boolean	deactivate
protected String	defaultCatalogName
protected String	defaultSchemaName
protected String	defaultsFile
protected String	delimiter
protected String	diffTypes
protected String	driver
protected String	driverPropertiesFile
private static final String	ERRORMSG_UNEXPECTED_PARAMETERS
protected String	excludeObjects
protected String	format
protected Boolean	includeCatalog
protected String	includeObjects
protected Boolean	includeSchema
protected Boolean	includeSystemClasspath
protected Boolean	includeTablespace
protected String	labelFilter
protected String	labels
protected String	liquibaseCatalogName
protected String	liquibaseProLicenseKey
protected String	liquibaseSchemaName
private static final Logger	LOG
protected String	logFile
protected String	logLevel
private static final Boolean	managingLogConfig
public static Map<String, String>	newCliChangelogParameters
protected String	outputDefaultCatalog
protected String	outputDefaultSchema
protected String	outputFile
protected String	outputSchemasAs
private static final boolean	outputsLogMessages
private static PrintStream	outputStream
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 Boolean	rollbackOnError
protected String	rollbackScript
public static boolean	runningFromNewCli
protected List<CatalogAndSchema>	schemaList
protected String	schemas
protected String	showSummary
protected String	snapshotFormat
protected String	sqlFile
private static final int[]	suspiciousCodePoints
protected String	url
protected String	username

Access	Constructor and Description
public	Main()

Method Summary

Modifier and Type	Method and Description
private static void	addWarFileClasspathEntries(File classPathFile, List<URL> urls)
protected void	applyDefaults()
protected static Main.CodePointCheck	Returns: int A CodePointCheck object, or null to indicate all good checkArg(String Input parameter to check arg) Check the string for known characters which cannot be handled
private void	checkForMalformedCommandParameters(final List<String> an array of Strings to which messages for issues found will be added messages) Checks for incorrectly written command line parameters and, if any problems are found, returns the list of issues in String form.
private void	checkForMissingCommandParameters(final List<String> an array of Strings to which messages for issues found will be added messages) Checks for missing command line parameters and, if any problems are found, returns the list of issues in String form.
private void	checkForUnexpectedCommandParameter(List<String> an array of Strings to which messages for issues found will be added messages) Checks for unexpected (unknown) command line parameters and, if any problems are found, returns the list of issues in String form.
protected List<String>	Returns: an empty List if successful, or a list of error messages checkSetup() After parsing, checks if the given combination of main command and can be executed.
protected ClassLoader	configureClassLoader()
private CommandScope	createLiquibaseCommand(Database database, Liquibase liquibase, String commandName, Map<String, Object> argsMap)
protected void	doMigration() Do the actual database migration, i.e. apply the ChangeSets.
private static File	Returns: a File object with the temporary file containing the extracted object extract(JarFile the JAR file from which we will extract jar, JarEntry the object inside the JAR file that to be extracted entry) Extract a single object from a JAR file into a temporary file.
protected String[]	fixupArgs(String[] args) On windows machines, it splits args on '=' signs.
private String	Returns: the command argument, if one is given. Otherwise null. getCommandArgument() Return the first "parameter" from the command line that does NOT have the form of parameter=value.
private String	Returns: the user-specified value for paramName, or defaultValue getCommandParam(String name of the parameter paramName, String return value if parameter is not given defaultValue) Returns the value for a command line parameter of the form parameterName=value, or defaultValue if that parameter has not been specified by the user.
private Field	getDeclaredField(String attributeName)
private ResourceAccessor	getFileOpenerResourceAccessor() Encapsulate code used to load the correct resource accessor providing legacy Cli compatibility
private String	getLabelFilter()
private OutputStream	getOutputStream()
private Writer	getOutputWriter()
private String	getSchemaParams(Database database)
private void	handleUpdateException(Database database, LiquibaseException exception, DefaultChangeExecListener defaultChangeExecListener, boolean rollbackOnError)
private static boolean	Returns: true if a ChangeLog is required, false if not. isChangeLogRequired(String the command to test command) Returns true if the parameter --changeLogFile is requited for a given command
private static boolean	Returns: true if it is a valid main command, false if not isCommand(String the String to test arg) Returns true if the given arg is a valid main command of Liquibase.
private boolean	isFormattedDiff()
private static boolean	Returns: true if arg is a valid main command and needs no special parameters, false in all other cases isNoArgCommand(String the main command to test arg) Returns true if the given main command arg needs no special parameters.
private static boolean	Returns: true if stdout needs for a command, false if not isStandardOutputRequired(String the command to check command) Returns true if the given command requires stdout
public boolean	Returns: true if running under some variant of MS Windows, false otherwise. isWindows() Determines if this program is executed on a Microsoft Windows-type of operating system.
private void	loadChangeSetInfoToMap(Map<String, Object> argsMap)
public static void	main(String[] the command line arguments args) Entry point.
private void	parseDefaultPropertyFileFromFile(final File path and file name to the the property file potentialPropertyFile) Open a regular property file (not embedded in a resource - use `parseDefaultPropertyFileFromResource` for that) and parse it.
private void	parseDefaultPropertyFileFromResource(File location and file name of the property file potentialPropertyFile) Open a property file that is embedded as a Java resource and parse it.
protected void	parseDefaultPropertyFiles() Search for both liquibase.properties (or whatever the name of the current defaultsFile is) and the "local" variant liquibase.local.properties.
private static Level	parseLogLevel(String logLevelName, UIService ui)
private void	parseOptionArgument(String the option to parse (including the "--") arg, boolean okIfNotAField) Parses an option ("--someOption") from the command line
protected void	parseOptions(String[] the arguments to parse paramArgs) Parses the command line options.
protected void	parsePropertiesFile(InputStream an InputStream from a Java properties file propertiesInputStream) Reads various execution parameters from an InputStream and sets our internal state according to the values found.
private void	parsePropertiesFileForNewCli(Properties props) Most of the properties file is handled by the new CLI.
protected void	printHelp(List<String> List of error messages errorMessages, PrintStream the output stream to write the text to stream) If any errors have been found, print the list of errors first, then print the command line help text.
protected void	printHelp(PrintStream the output stream to write the help text to stream) Print instructions on how to use this program from the command line.
public static int	Returns: the errorlevel to be returned to the operating system, e.g. for further processing by scripts run(String[] the command line arguments args) Process the command line arguments and perform the appropriate main action (update, rollback etc.)
private void	runDiffChangelogCommandStep()
private void	runDiffCommandStep()
private void	runExecuteSqlCommand()
private void	runGenerateChangelogCommandStep()
private void	runReleaseLocksCommand()
private void	runRollbackCommand(Writer outputWriter)
private void	runRollbackOneChangeSetCommandStep()
private void	runRollbackOneChangeSetSqlCommandStep()
private void	runRollbackOneUpdateCommandStep()
private void	runRollbackOneUpdateSqlCommandStep()
private void	runRollbackSqlCommand()
private void	runUpdateCommandStep()
private void	runUsingCommandFramework() Run commands using the CommandFramework instead of directly setting up and calling other classes
private void	setDatabaseArgumentsToCommand(CommandScope command) Set database arguments values received by Main class to the provided command scope.
protected static void	setLogLevel(LogService logService, Logger rootLogger, Logger liquibaseLogger, Level level)
public static PrintStream	setOutputStream(PrintStream outputStream) Sets the default outputstream to use.
private void	setPreCompareArgumentsToCommand(CommandScope command) Set database compare arguments values received by Main class to the provided command scope.
private void	setReferenceDatabaseArgumentsToCommand(CommandScope command) Set reference database arguments values received by Main class to the provided command scope.
private static boolean	setupNeeded(Main main) References Deprecated `Main` is deprecated or references (maybe indirectly) at least one deprecated element.
private static String[]	Returns: An array of exactly 2 entries splitArg(String The String expression to split arg) Splits a String of the form "key=value" into the respective parts.
private void	validateCommandParameters(final List<String> an array of Strings to which messages for issues found will be added messages) Checks the command line for correctness and reports on unexpected, missing and/or malformed parameters.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

public Class Main

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary