liquibase.integration.commandline.LiquibaseCommandLineConfiguration Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of liquibase-core Show documentation
Show all versions of liquibase-core Show documentation
Liquibase is a tool for managing and executing database changes.
The newest version!
package liquibase.integration.commandline;
import liquibase.configuration.AutoloadedConfigurations;
import liquibase.configuration.ConfigurationDefinition;
import liquibase.configuration.ConfigurationValueConverter;
import liquibase.logging.LogFormat;
import liquibase.util.StringUtil;
import java.util.Arrays;
import java.util.logging.Level;
/**
* Common configuration settings for integrations
*/
public class LiquibaseCommandLineConfiguration implements AutoloadedConfigurations {
public static final ConfigurationDefinition DRIVER;
public static final ConfigurationDefinition DATABASE_CLASS;
public static final ConfigurationDefinition CLASSPATH;
public static final ConfigurationDefinition DRIVER_PROPERTIES_FILE;
public static final ConfigurationDefinition PROPERTY_PROVIDER_CLASS;
public static final ConfigurationDefinition PROMPT_FOR_NON_LOCAL_DATABASE;
public static final ConfigurationDefinition INCLUDE_SYSTEM_CLASSPATH;
public static final ConfigurationDefinition DEFAULTS_FILE;
public static final ConfigurationDefinition LOG_LEVEL;
public static final ConfigurationDefinition LOG_CHANNELS;
public static final ConfigurationDefinition LOG_FILE;
public static final ConfigurationDefinition MIRROR_CONSOLE_MESSAGES_TO_LOG;
public static final ConfigurationDefinition LOG_FORMAT;
public static final ConfigurationDefinition OUTPUT_FILE;
public static final ConfigurationDefinition SHOULD_RUN;
public static final ConfigurationDefinition ARGUMENT_CONVERTER;
public static final ConfigurationDefinition MONITOR_PERFORMANCE;
public static final ConfigurationDefinition ADD_EMPTY_MDC_VALUES;
public static final ConfigurationDefinition SHOW_HIDDEN_ARGS;
public static final ConfigurationDefinition INCLUDE_MATCHING_TAG_IN_ROLLBACK_OLDEST;
public static final ConfigurationDefinition WORKAROUND_ORACLE_CLOB_CHARACTER_LIMIT;
public static final ConfigurationDefinition SUPPRESS_LIQUIBASE_SQL;
public static final ConfigurationDefinition INTEGRATION_NAME;
static {
ConfigurationDefinition.Builder builder = new ConfigurationDefinition.Builder("liquibase");
DRIVER = builder.define("driver", String.class).setDescription("Database driver class").build();
DATABASE_CLASS = builder.define("databaseClass", Class.class).setDescription("Class to use for Database implementation").build();
CLASSPATH = builder.define("classpath", String.class).setDescription("Additional classpath entries to use").build();
DRIVER_PROPERTIES_FILE = builder.define("driverPropertiesFile", String.class)
.setDescription("Driver-specific properties")
.build();
PROPERTY_PROVIDER_CLASS = builder.define("propertyProviderClass", Class.class)
.setDescription("Implementation of Properties class to provide additional driver properties")
.build();
PROMPT_FOR_NON_LOCAL_DATABASE = builder.define("promptForNonLocalDatabase", Boolean.class)
.setDescription("Should Liquibase prompt if a non-local database is being accessed")
.build();
INCLUDE_SYSTEM_CLASSPATH = builder.define("includeSystemClasspath", Boolean.class)
.setDescription("Include the system classpath when resolving classes at runtime")
.setDefaultValue(true).build();
DEFAULTS_FILE = builder.define("defaultsFile", String.class)
.setDescription("File with default Liquibase properties")
.setDefaultValue("liquibase.properties")
.build();
SHOULD_RUN = builder.define("shouldRun", Boolean.class)
.setDescription("Should Liquibase commands execute")
.setDefaultValue(true)
.addAliasKey("should.run")
.build();
LOG_LEVEL = builder.define("logLevel", Level.class)
.setDefaultValue(Level.OFF,"Controls which logs get set to stderr AND to any log file. The CLI defaults, if log file set, to SEVERE. Others vary by integration. The official log levels are: OFF, SEVERE, WARNING, INFO, FINE")
.setValueHandler(ConfigurationValueConverter.LOG_LEVEL)
.build();
LOG_CHANNELS = builder.define("logChannels", String.class)
.setDefaultValue("liquibase", "Controls which log channels have their level set by the liquibase.logLevel setting. Comma separate multiple values. To set the level of all channels, use 'all'. Example: liquibase,org.mariadb.jdbc")
.build();
LOG_FILE = builder.define("logFile", String.class).build();
MIRROR_CONSOLE_MESSAGES_TO_LOG = builder.define("mirrorConsoleMessagesToLog", Boolean.class)
.setDefaultValue(Boolean.TRUE)
.setDescription("When set to true, the console messages are mirrored to the logs as [liquibase.ui] to provide a more complete picture of liquibase operations to log analysis tools. Set to false to change this behavior.")
.build();
OUTPUT_FILE = builder.define("outputFile", String.class).build();
MONITOR_PERFORMANCE = builder.define("monitorPerformance", String.class)
.setDescription("Enable performance tracking. Set to 'false' to disable. If set to 'true', data is stored to a `liquibase-TIMESTAMP.jfr` file in your working directory. Any other value will enable tracking and be used as the name of the file to write the data to.")
.setDefaultValue("false")
.build();
ARGUMENT_CONVERTER = builder.define("argumentConverter", ArgumentConverter.class)
.setInternal(true)
.setDescription("Configured by the integration to convert arguments in user messages to something that matches the formats they expect")
.setDefaultValue(argument -> argument)
.build();
LOG_FORMAT = builder.define("logFormat", LogFormat.class)
.setDescription("Sets the format of log output to console or log files. " +
"Open Source users default to unstructured \"" + LogFormat.TEXT + "\" logs to the console or output log files. " +
"Pro users have the option to set value as \"" + LogFormat.JSON + "\" or \"" + LogFormat.JSON_PRETTY + "\" to enable json-structured log files to the console or output log files.")
.setDefaultValue(LogFormat.TEXT)
.setValueHandler(logFormat -> {
if (logFormat == null) {
return null;
}
if (logFormat instanceof String) {
String logFormatString = (String) logFormat;
if (Arrays.stream(LogFormat.values()).noneMatch(lf -> lf.toString().equalsIgnoreCase(logFormatString))) {
throw new IllegalArgumentException("WARNING: The log format value '"+logFormatString+"' is not valid. Valid values include: '" + StringUtil.join(LogFormat.values(), "', '", Object::toString) + "'");
}
return Enum.valueOf(LogFormat.class, logFormatString.toUpperCase());
} else if (logFormat instanceof LogFormat) {
return (LogFormat) logFormat;
} else {
return null;
}
})
.build();
ADD_EMPTY_MDC_VALUES = builder.define("addEmptyMdcValues", Boolean.class)
.setDescription("If true, a subset of the MdcKeys, as defined by product, will be set to empty strings upon system startup.")
.setDefaultValue(true)
.setHidden(true)
.build();
SHOW_HIDDEN_ARGS = builder.define("showHiddenArgs", Boolean.class)
.setDescription("If true, all command arguments marked as hidden will be shown in the help output, ignoring the hidden flag. NOTE, due to the order of value provider loading at such an early point in Liquibase startup, you MUST set this as a environment variable. Command line parameters will not be recognized.")
.setDefaultValue(false)
.setHidden(true)
.build();
INCLUDE_MATCHING_TAG_IN_ROLLBACK_OLDEST = builder.define("includeMatchingTagInRollbackOldest", Boolean.class)
.setDescription("If set to true, and there are multiple identical tags in the database changelog table, all of the newer matching tags will be rolled back while rolling back to the oldest tag. The default value for this option was false for all Liquibase versions equal to or older than 4.25.1.")
.setDefaultValue(true)
.setHidden(true)
.build();
WORKAROUND_ORACLE_CLOB_CHARACTER_LIMIT = builder.define("workaroundOracleClobCharacterLimit", Boolean.class)
.setDescription("If true, long strings in Oracle will be chunked at 4000 characters when an insert statement is run, to avoid running afoul of Oracle's 4000 character limit for insert statements to clob type columns (which appears as 'ORA-01704: string literal too long.')")
.setDefaultValue(true)
.setHidden(true)
.build();
SUPPRESS_LIQUIBASE_SQL = builder.define("suppressLiquibaseSql", Boolean.class)
.setDescription("When set to true, this global property prevents DBCL and DBCLH sql from being present in console and logs during *-sql commands, such as update-sql, rollback-sql, etc.")
.setDefaultValue(false)
.build();
INTEGRATION_NAME = builder.define("integrationName", String.class)
.setDefaultValue("cli")
.setDescription("The name of the integration used to invoke Liquibase, for example, cli, or JavaAPI. It is not required to specify this value. This is primarily used by wrappers around Liquibase (like Gradle), so that analytics can be differentiated for those integrations.")
.setHidden(true)
.build();
}
public interface ArgumentConverter {
String convert(String argument);
}
}