diff --git a/Content/Z_Resources/Snippets/text/checks-prerequisites.flsnp b/Content/Z_Resources/Snippets/text/checks-prerequisites.flsnp new file mode 100644 index 000000000..62098755b --- /dev/null +++ b/Content/Z_Resources/Snippets/text/checks-prerequisites.flsnp @@ -0,0 +1,40 @@ + + + +

Prerequisites

+
    +
  1. Ensure that you have correctly specified your license key.
    2. +
  2. Ensure that the --checks-scope parameter includes the scope of this check.
    3. +
+

For example:

+
+ + 
--license-key=<string>
--checks-scope=<string>
+
+ 
globalArgs: { license-key: "<string>" }
+cmdArgs: { checks-scope: "<string>" }
+
+ 
liquibase.licenseKey: <string>
+liquibase.command.checksScope: <string>
liquibase.licenseKey: <string>
+liquibase.command.checks.run.checksScope: <string>
+
+ 
JAVA_OPTS=-Dliquibase.licenseKey=<string> -Dliquibase.command.checksScope=<string>
JAVA_OPTS=-Dliquibase.licenseKey=<string> -Dliquibase.command.checks.run.checksScope=<string>
+
+ 
LIQUIBASE_LICENSE_KEY=<string>
+LIQUIBASE_COMMAND_CHECKS_SCOPE=<string>
LIQUIBASE_LICENSE_KEY=<string>
+LIQUIBASE_COMMAND_CHECKS_RUN_CHECKS_SCOPE=<string>
+
+
+ + \ No newline at end of file diff --git a/Content/Z_Resources/Snippets/text/checks-use.flsnp b/Content/Z_Resources/Snippets/text/checks-use.flsnp new file mode 100644 index 000000000..ba93e6bde --- /dev/null +++ b/Content/Z_Resources/Snippets/text/checks-use.flsnp @@ -0,0 +1,38 @@ + + + + + +

Enable

+

This check is enabled by default. To verify that it is currently enabled, run the show command:

liquibase checks show --check-name=<string>
+

This check is disabled by default. To enable it, run the enable command:

liquibase checks enable --check-name=<string>
+

When you try to enable the check, displays the following message:

This check can not be enabled directly because one or more fields does not have a default value.  Create a copy of this check and initiate the customization workflow.
+

Customize

+

This check is static, meaning it does not have any customization settings.

+

This check is dynamic, meaning you can customize its settings.

+

However, you cannot directly customize this check. Instead, you must use the copy command to create a copy of the check which you can then customize:

liquibase checks copy --check-name=<string>
+

Follow the steps in the CLI to give your new check a useful name. By default, the name of the copy is <CheckName>1.

+

Run the customize command:

liquibase checks customize --check-name=<string>
+

Follow the steps in the CLI to set new values. When finished, you can run the show command again to verify that your configuration is correct:

liquibase checks show --check-name=<string>
+

Run

+

To run the check, use the run command:

+
+ + 
liquibase checks run --check-name=<string>
+
+ 
stages:
+  Default:
+    actions:
+      - type: liquibase
+        command: checks run
+        cmdArgs: {check-name: <string>}
+

And then run the flow command on your flow file:

liquibase flow
+
+
+ + \ No newline at end of file diff --git a/Content/commands/quality-checks/checks/changelog-checks/change-drop-column-warn.htm b/Content/commands/quality-checks/checks/changelog-checks/change-drop-column-warn.htm index 077007451..9ed7c9abc 100644 --- a/Content/commands/quality-checks/checks/changelog-checks/change-drop-column-warn.htm +++ b/Content/commands/quality-checks/checks/changelog-checks/change-drop-column-warn.htm @@ -7,56 +7,50 @@ -

ChangeDropColumnWarn

-

This check warns a user when a column is being dropped so that they can ensure that such a schema change won't lead to unintentional loss of data and unrecoverable data loss.

-

Uses

-

Use the check to warn when a column is being dropped. A column drop can lead to a significant schema change which can destroy your organization’s most essential resource: critical data. Such an unintended change can result in permanent data loss, production level service outages, and more. This quality check, like other checks, can be configured with a “severity” level which returns an exit code designed to stop automated jobs, giving your team time to inspect these significant changes.

-

Run the ChangeDropColumnWarn check

-

The ChangeDropColumnWarn check is enabled by default, so you will not need to turn it on if you have not changed your settings previously. To run the ChangeDropColumnWarn check, ensure you have a license and the checks-scope property includes . The checks-scope parameter is set in the default properties file, environment variable, or any standard method. Then, check the changelog to see if ChangeDropColumnWarn is enabled.

-

Enable the ChangeDropColumnWarn check by running the following command in the CLI:

liquibase checks enable --check-name=ChangeDropColumnWarn
+

ChangeDropColumnWarn +

+

ChangeDropColumnWarn is a quality check that warns a user when a column is being dropped so that they can ensure that such a schema change won't lead to unintentional loss of data and unrecoverable data loss.

- - - - - - - + + + - - - - - - + - - - - - - + + + + + - + + + - + + + + + + + +
Short NameScopeEnabledSeverityCustomizationDescriptionAbout ChangeDropColumnWarn
ChangeDropColumnWarn - - -

true

- 		-

Default value: 0

- + 		version required4.5.0+
Scope (--checks-scope)changelog -

<None>

+
Default statusenabled This check warns a user when a column is being dropped so that they can ensure that dropping the table won't lead to unintentional loss of data
Default severity (exit code)0 ("INFO")
Customizable settingsNo (static)
+

Uses

+

Use the check to warn when a column is being dropped. A column drop can lead to a significant schema change which can destroy your organization’s most essential resource: critical data. Such an unintended change can result in permanent data loss, production level service outages, and more. This quality check, like other checks, can be configured with a “severity” level which returns an exit code designed to stop automated jobs, giving your team time to inspect these significant changes.

+ +

Use ChangeDropColumnWarn

+ liquibase checks enable --check-name=ChangeDropColumnWarn example output - 

-Check 'ChangeDropColumnWarn' has been enabled.
+            
Check 'ChangeDropColumnWarn' has been enabled.
 +-----+--------------------------------+----------------------------+--------------------------------+---------+--------------------------------+----------+------------+
 | #   | Check Name                     | Short Name                 | Description                    | Enabled | Customization                  | Severity | Scope      |
 +-----+--------------------------------+----------------------------+--------------------------------+---------+--------------------------------+----------+------------+
diff --git a/Content/start/release-notes/liquibase-release-notes/liquibase-4.5.0.htm b/Content/start/release-notes/liquibase-release-notes/liquibase-4.5.0.htm
index fc940662f..da434ee9a 100644
--- a/Content/start/release-notes/liquibase-release-notes/liquibase-4.5.0.htm
+++ b/Content/start/release-notes/liquibase-release-notes/liquibase-4.5.0.htm
@@ -8,7 +8,7 @@
     
         
 4.5.0 Release Notes

         
Full Changelog: v4.4.3...v4.5.0 (September 27, 2021)

-        
This release includes community-contributed pull requests,  and  bug fixes, and support for .

+        
This release includes community-contributed pull requests,  and  bug fixes, and support for Quality Checks.

         
Quality checks allow you to run checks against SQL, XML, JSON, and YAML s for conditions and configurations important to your organization. More quality checks are forthcoming in future releases; provide feedback on what checks matter most to you.

         
Here is a closer look at what we improved in the latest release.

         
Notable Changes

diff --git a/Project/ConditionTagSets/checks-use.flcts b/Project/ConditionTagSets/checks-use.flcts
new file mode 100644
index 000000000..b09e2b0e3
--- /dev/null
+++ b/Project/ConditionTagSets/checks-use.flcts
@@ -0,0 +1,28 @@
+
+
+  
+  
+  
+  
+  
+
\ No newline at end of file