-
Notifications
You must be signed in to change notification settings - Fork 1
/
global_options.proto
114 lines (110 loc) · 15.6 KB
/
global_options.proto
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
syntax = "proto3";
option go_package="./;proto";
option java_package = "org.liquibase.grpc.proto";
option java_multiple_files = true;
option java_outer_classname = "globalOptionsProto";
package liquibase;
/* Liquibase Global Options */
message GlobalOptions {
optional bool add_empty_mdc_values = 1; // If true, a subset of the MdcKeys, as defined by product, will be set to empty strings upon system startup.
optional bool allow_duplicated_changeset_identifiers = 2; // Allows duplicated changeset identifiers without failing Liquibase execution.
optional bool always_drop_instead_of_replace = 3; // If true, drop and recreate a view instead of replacing it.
optional bool always_override_stored_logic_schema = 4; // When generating SQL for createProcedure, should the procedure schema be forced to the default schema if no schemaName attribute is set?
optional int32 analytics_config_endpoint_timeout_millis = 5;
optional string analytics_config_endpoint_url = 6;
optional bool analytics_dev_override = 7; // By default, Liquibase will not send analytics in dev (non release) builds. To override this behavior, set this value to true and provide a value for liquibase.analytics.configEndpointUrl
optional bool analytics_enabled = 8; // Enable or disable sending product usage data and analytics to Liquibase. Learn more at https://docs.liquibase.com/analytics. DEFAULT: true for OSS users | false for PRO users
optional int32 analytics_license_key_chars = 9; // Number of characters of the license key that should be appended to the userId. This is used in the event that the same customer has multiple license keys associated with them.
optional string analytics_log_level = 10;
optional int32 analytics_timeout_millis = 11; // By default, the timeout for sending data to the remote endpoint is configured in the config endpoint. Any value set here will override that value.
optional bool auto_reorg = 12; // Should Liquibase automatically include REORG TABLE commands when needed?
optional string changelog_lock_poll_rate = 13; // Number of seconds wait between checks to the changelog lock when it is locked
optional string changelog_lock_wait_time_in_minutes = 14; // Number of minutes to wait for the changelog lock to be available before giving up
optional string changelog_parse_mode = 15; // Configures how to handle unknown fields in changelog files. Possible values: STRICT which causes parsing to fail, and LAX which continues with the parsing.
optional string classpath = 16; // Additional classpath entries to use
optional bool convert_data_types = 17; // Should Liquibase convert to/from STANDARD data types. Applies to both snapshot and update commands.
optional string custom_log_data_file = 18; // [PRO]Relative or fully qualified path to a yaml file containing key:value data to inject or exclude data from JSON structured logs. Learn more at https://docs.liquibase.com/structured-logging
optional string custom_log_data_frequency = 19; // [PRO]The frequency that the custom log data will be entered into the logs. Available options are: ONCE,REPEATED
optional string database_changelog_lock_table_name = 20; // Name of table to use for tracking concurrent Liquibase usage
optional string database_changelog_table_name = 21; // Name of table to use for tracking change history
optional string database_class = 22; // Class to use for Database implementation
optional bool dbclhistory_capture_extensions = 23; // If true, extensions are captured in the history table
optional bool dbclhistory_capture_sql = 24; // If true, executed SQL is captured in the history table
optional bool dbclhistory_enabled = 25; // [PRO]This property enables Liquibase Pro users to store a record of all database changing liquibase operations in a new table DATABASECHANGELOGHISTORY. This table includes records of rollback, dropalls, and repeated runOnChange type activity, which is not available in the standard DATABASECHANGELOG table.
optional int32 dbclhistory_severity = 26; // The exit code to use if an exception is encountered while recording history events
optional string dbclhistory_table_name = 27;
optional int32 ddl_lock_timeout = 28; // The DDL_LOCK_TIMEOUT parameter indicates the number of seconds a DDL command should wait for the locks to become available before throwing the resource busy error message. This applies only to Oracle databases.
optional string defaults_file = 29; // File with default Liquibase properties
optional bool diff_column_order = 30; // Should Liquibase compare column order in diff operation?
optional string driver = 31; // Database driver class
optional string driver_properties_file = 32; // Driver-specific properties
optional string duplicate_file_mode = 33; // How to handle multiple files being found in the search path that have duplicate paths. Options are SILENT (do not log and choose one at random), DEBUG, INFO, WARN (log at the given level and choose one at random), or ERROR (fail current operation).
optional bool error_on_circular_include_all = 34; // Throw an error if Liquibase detects that an includeAll will cause a circular reference (and thus a changelog parse error).
optional string file_encoding = 35; // Encoding to use when reading files. Valid values include: UTF-8, UTF-16, UTF-16BE, UTF-16LE, US-ASCII, or OS to use the system configured encoding.
optional bool filter_log_messages = 36; // DEPRECATED: No longer used
optional bool flow_verbose_to_string = 37; // If true, display a more verbose output for the FlowFile toString representation
optional bool generate_changeset_created_values = 38; // Should Liquibase include a 'created' attribute in diff/generateChangelog changesets with the current datetime
optional bool generated_changeset_ids_contains_description = 39; // Should Liquibase include the change description in the id when generating changesets?
optional bool headless = 40; // Force Liquibase to think it has no access to a keyboard
optional bool include_catalog_in_specification = 41; // Should Liquibase include the catalog name when determining equality?
optional bool include_matching_tag_in_rollback_oldest = 42; // 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.
optional bool include_relations_for_computed_columns = 43; // If true, the parent relationship for computed columns is preserved in snapshot-dependent commands: snapshot and diff
optional bool include_system_classpath = 44; // Include the system classpath when resolving classes at runtime
optional string integration_name = 45; // 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.
optional string license_key = 46; // Liquibase Pro or Liquibase Labs license key used to unlock paid capabilities. Get a free trial at https://liquibase.com/trial and use in CLI or add liquibase.licenseKey=<yourKey> into your defaults file.
optional string liquibase_catalog_name = 47; // Catalog to use for Liquibase objects
optional string liquibase_schema_name = 48; // Schema to use for Liquibase objects
optional string liquibase_tablespace_name = 49; // Tablespace to use for Liquibase objects
optional string log_channels = 50; // 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
optional string log_file = 51;
optional string log_format = 52; // Sets the format of log output to console or log files. Open Source users default to unstructured "TEXT" logs to the console or output log files. Pro users have the option to set value as "JSON" or "JSON_PRETTY" to enable json-structured log files to the console or output log files.
optional string log_level = 53; // 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
optional bool mirror_console_messages_to_log = 54; // 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.
optional bool mirror_output_to_console = 55; // [PRO]When set to true, console output will be mirrored to both the specified output-file and the console. If output-file is not set, the 'mirror-output-to-console' argument has no effect.
optional string missing_property_mode = 56; // How to handle changelog property expressions where a value is not set. For example, a string '${address}' when no 'address' property was defined. Values can be: 'preserve' which leaves the string as-is, 'empty' which replaces it with an empty string, or 'error' which stops processing with an error.
optional string monitor_performance = 57; // 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.
optional string native_executor = 58; // Custom executor that can specified
optional string on_missing_include_changelog = 59; // If set to WARN, then liquibase will not throw exception on missing changelog file, instead will show a warning message.
optional string on_missing_sql_file = 60; // If set to WARN, then Liquibase will not throw exception on missing sqlFile inside a sqlFile change type, instead will show a warning message
optional string output_file = 61;
optional string output_file_encoding = 62; // Encoding to use when writing files
optional string output_line_separator = 63; // Line separator for output
optional bool preserve_classpath_prefix_in_normalized_paths = 64; // If true 'classpath:' prefix will be preserved in normalized paths, allowing to resolve hierarchical resources under a classpath-based root.
optional bool preserve_schema_case = 65; // If true, Liquibase treats schema and catalog names as case sensitive
optional bool pro_force_on_partial_changes = 66; // If true, rollback execution will be forced when having partial changes that needs to be rolled back. Defaults to false.
optional string pro_global_end_delimiter = 67; // [PRO]The default end delimiter to use for all change sets
optional bool pro_global_end_delimiter_prioritized = 68; // [PRO]If true, the global end delimiter overrides all other settings
optional bool pro_global_strip_comments = 69; // [PRO]The default strip comments to use for all change sets
optional bool pro_global_strip_comments_prioritized = 70; // [PRO]If true, the global strip comments overrides all other settings
optional string pro_license_key = 71; // DEPRECATED: Liquibase Pro license key used to unlock paid capabilities. Get a free trial at https://www.liquibase.com/protrial and use in CLI or add liquibase.pro.licenseKey=<yourKey> into your defaults file.
optional bool pro_mark_unused_not_drop = 72; // If a column would be dropped in a diffChangeLog, call markUnused instead if set to true
optional bool pro_sql_inline = 73; // If true, generate changeSets with SQL-based changes inlined instead of saving them to an external file
optional bool pro_synonyms_drop_public = 74; // If false, do not drop public synonyms in diffChangeLog/dropAll
optional bool pro_strict = 75; // [PRO]If true, the Liquibase operations will fail when specified paths to Pro resource files (flow files, checks settings files, native executor conf files, etc) or rollback scripts are missing or empty.
optional bool prompt_for_non_local_database = 76; // Should Liquibase prompt if a non-local database is being accessed
optional string property_provider_class = 77; // Implementation of Properties class to provide additional driver properties
optional bool reports_enabled = 78; // [PRO]Enable or disable reporting.
optional string reports_format = 79; // [PRO]The format of the report. Currently, can only be set to "html".
optional string reports_name = 80; // [PRO]The name of the reports.
optional bool reports_open = 81; // [PRO]Open the newly generated report in your default browser.
optional string reports_path = 82; // [PRO]The path to the directory to generate the reports.
optional bool reports_quiet = 83; // [PRO]Minimize the amount of logging when generating reports.
optional string search_path = 84; // Complete list of Location(s) to search for files such as changelog files in. Multiple paths can be specified by separating them with commas.
optional bool secure_parsing = 85; // If true, remove functionality from file parsers which could be used insecurely. Examples include (but not limited to) disabling remote XML entity support.
optional bool should_run = 86; // Should Liquibase commands execute
optional bool should_snapshot_data = 87; // Should Liquibase snapshot data by default?
optional bool show_banner = 88; // If true, show a Liquibase banner on startup.
optional bool show_hidden_args = 89; // 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.
optional bool sql_always_set_fetch_size = 90; // If true, all queries will have their fetch size set to the fetch size defined in their database implementation. This has the effect of informing the driver how many rows should be fetched when processing the result set. This is not guaranteed to be respected by the driver, but if respected, should improve query performance significantly.
optional string sql_log_level = 91; // Level to log SQL statements to
optional bool sql_show_sql_warnings = 92; // Show SQLWarning messages
optional bool strict = 93; // If true, Liquibase enforces certain best practices and proactively looks for common errors
optional bool support_property_escaping = 94; // Support escaping changelog parameters using a colon. Example: ${:user.name}
optional string supports_method_validation_level = 95; // Controls the level of validation performed on the supports method of Change classes. Options are OFF, WARN, FAIL.
optional bool suppress_liquibase_sql = 96; // 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.
optional bool trim_load_data_file_header = 97; // If true column headers will be trimmed in case they were specified with spaces in the file.
optional string ui_service = 98; // Changes the default UI Service Logger used by Liquibase. Options are CONSOLE or LOGGER.
optional bool use_procedure_schema = 99; // If set to true (default value), createProcedure tags with a set schemaName will modify the procedure body with the given schema name.
optional bool validate_xml_changelog_files = 100; // Will perform XSD validation of XML changelog files. When many XML changelog files are included, this validation may impact Liquibase performance. Defaults to true.
optional bool workaround_oracle_clob_character_limit = 101; // 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.')
}