PD-5415, PD-5587: --reports-suppress-exception, --reports-suppress-sq…

…l, --report-suppress-exception, --report-suppress-sql
liquibase · Jan 15, 2025 · 1ee4e7c · 1ee4e7c
1 parent e68563b
commit 1ee4e7c
Show file tree

Hide file tree

Showing 21 changed files with 440 additions and 14 deletions.
diff --git a/Content/Z_Resources/Snippets/def/attributes/cli/reports/cli-cmd-report-enabled.flsnp b/Content/Z_Resources/Snippets/def/attributes/cli/reports/cli-cmd-report-enabled.flsnp
@@ -1,8 +1,8 @@
-<?xml version="1.0" encoding="utf-8"?>
+<?xml version="1.0" encoding="utf-8"?>
 <html xmlns:MadCap="http://www.madcapsoftware.com/Schemas/MadCap.xsd" MadCap:searchable="False">
     <head>
     </head>
     <body>
-        <p>Enables a  report at the command level. Overrides the global argument <code>--reports-enabled</code>. <b>Default:&#160;<code>false</code></b>.</p>
+        <p>Enables a  report at the command level. Overrides the global parameter <code>--reports-enabled</code>. <b>Default:&#160;<code>false</code></b>.</p>
     </body>
 </html>
diff --git a/Content/Z_Resources/Snippets/def/attributes/cli/reports/cli-cmd-report-format.flsnp b/Content/Z_Resources/Snippets/def/attributes/cli/reports/cli-cmd-report-format.flsnp
@@ -1,8 +1,8 @@
-<?xml version="1.0" encoding="utf-8"?>
+<?xml version="1.0" encoding="utf-8"?>
 <html xmlns:MadCap="http://www.madcapsoftware.com/Schemas/MadCap.xsd" MadCap:searchable="False">
     <head>
     </head>
     <body>
-        <p>Specifies the format of the report output file at the command level. Overrides the global argument <code>--reports-format</code>. Valid values are: <code>HTML</code>. <b>Default:&#160;<code>HTML</code></b>.</p>
+        <p>Specifies the format of the report output file at the command level. Overrides the global parameter <code>--reports-format</code>. Valid values are: <code>HTML</code>. <b>Default:&#160;<code>HTML</code></b>.</p>
     </body>
 </html>
diff --git a/Content/Z_Resources/Snippets/def/attributes/cli/reports/cli-cmd-report-name.flsnp b/Content/Z_Resources/Snippets/def/attributes/cli/reports/cli-cmd-report-name.flsnp
@@ -3,6 +3,6 @@
     <head>
     </head>
     <body>
-        <p>Specifies the name of the  report file at the command level. Overrides the global argument <code>--reports-name</code>. By default, <MadCap:variable name="General.Liquibase" /> generates a new report file labeled with a timestamp (user's local time). If you set a custom name, <MadCap:variable name="General.Liquibase" /> overwrites the existing file every time you generate a new report. <b>Default: <code>report-&lt;DD-Mon-YYYY-HHmmss&gt;.html</code></b>.</p>
+        <p>Specifies the name of the  report file at the command level. Overrides the global parameter <code>--reports-name</code>. By default, <MadCap:variable name="General.Liquibase" /> generates a new report file labeled with a timestamp (user's local time). If you set a custom name, <MadCap:variable name="General.Liquibase" /> overwrites the existing file every time you generate a new report. <b>Default: <code>report-&lt;DD-Mon-YYYY-HHmmss&gt;.html</code></b>.</p>
     </body>
 </html>
diff --git a/Content/Z_Resources/Snippets/def/attributes/cli/reports/cli-cmd-report-path.flsnp b/Content/Z_Resources/Snippets/def/attributes/cli/reports/cli-cmd-report-path.flsnp
@@ -1,8 +1,8 @@
-<?xml version="1.0" encoding="utf-8"?>
+<?xml version="1.0" encoding="utf-8"?>
 <html xmlns:MadCap="http://www.madcapsoftware.com/Schemas/MadCap.xsd" MadCap:searchable="False">
     <head>
     </head>
     <body>
-        <p>Specifies the file path to the  report file at the command level. Overrides the global argument <code>--reports-path</code>. <b>Default: <code>./</code></b>.</p>
+        <p>Specifies the file path to the  report file at the command level. Overrides the global parameter <code>--reports-path</code>. <b>Default: <code>./</code></b>.</p>
     </body>
 </html>
diff --git a/...t/Z_Resources/Snippets/def/attributes/cli/reports/cli-cmd-report-suppress-exception.flsnp b/...t/Z_Resources/Snippets/def/attributes/cli/reports/cli-cmd-report-suppress-exception.flsnp
@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="utf-8"?>
+<html xmlns:MadCap="http://www.madcapsoftware.com/Schemas/MadCap.xsd">
+    <head>
+    </head>
+    <body>
+        <p><b><MadCap:variable name="General.Liquibase" /> 4.31.0+.</b> Specifies whether to hide exceptions (which may contain SQL) from the operation report at the command level. Overrides the global parameter <code class="language-text">--reports-suppress-exception</code>. <b>Default: <code class="language-text">false</code></b>. However:</p>
+        <ul>
+            <li>If <code class="language-text">--report-suppress-exception</code> is not set and <code class="language-text">--report-suppress-sql=true</code>, <MadCap:variable name="General.Liquibase" /> suppresses all SQL, including exception SQL.</li>
+            <li>If <code class="language-text">--report-suppress-exception=false</code> and <code class="language-text">--report-suppress-sql=true</code>, <MadCap:variable name="General.Liquibase" /> suppresses most SQL&#160;but shows exception SQL.</li>
+        </ul>
+    </body>
+</html>
diff --git a/Content/Z_Resources/Snippets/def/attributes/cli/reports/cli-cmd-report-suppress-sql.flsnp b/Content/Z_Resources/Snippets/def/attributes/cli/reports/cli-cmd-report-suppress-sql.flsnp
@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="utf-8"?>
+<html xmlns:MadCap="http://www.madcapsoftware.com/Schemas/MadCap.xsd">
+    <head>
+    </head>
+    <body>
+        <p><b><MadCap:variable name="General.Liquibase" /> 4.31.0+.</b> Specifies whether to hide <MadCap:variable name="General.changeset" /> SQL in operation reports at the command level. Overridden by the global parameter <code class="language-text">--reports-suppress-sql</code>. <b>Default: <code class="language-text">false</code></b>.</p>
+    </body>
+</html>
diff --git a/...esources/Snippets/text/command-parameters-global-cmd/param-lists/command-checks-run.flsnp b/...esources/Snippets/text/command-parameters-global-cmd/param-lists/command-checks-run.flsnp
@@ -386,6 +386,32 @@
                     </td>
                     <td>Optional</td>
                 </tr>
+                <tr>
+                    <td>
+                        <MadCap:snippetBlock src="../syntax/command-param-syntax-cli.flsnp" MadCap:conditions="command-parameters-format.cli" MadCap:snippetVariables="parameters-global-command.case-kebab:report-suppress-exception,;parameters-global-command.value-type:&lt;true|false&gt;," />
+                        <MadCap:snippetBlock src="../syntax/command-param-syntax-flow-cmd.flsnp" MadCap:conditions="command-parameters-format.flow" MadCap:snippetVariables="parameters-global-command.case-kebab:report-suppress-exception,;parameters-global-command.value-type:&lt;true|false&gt;," />
+                        <MadCap:snippetBlock src="../syntax/command-param-syntax-properties-file-cmd.flsnp" MadCap:conditions="command-parameters-format.properties-file" MadCap:snippetVariables="parameters-global-command.case-camel:reportSuppressException,;parameters-global-command.value-type:&lt;true|false&gt;," />
+                        <MadCap:snippetBlock src="../syntax/command-param-syntax-java-opts-cmd.flsnp" MadCap:conditions="command-parameters-format.java-opts" MadCap:snippetVariables="parameters-global-command.case-camel:reportSuppressException,;parameters-global-command.value-type:&lt;true|false&gt;," />
+                        <MadCap:snippetBlock src="../syntax/command-param-syntax-envar-cmd.flsnp" MadCap:conditions="command-parameters-format.envar" MadCap:snippetVariables="parameters-global-command.case-envar:REPORT_SUPPRESS_EXCEPTION,;parameters-global-command.value-type:&lt;true|false&gt;," />
+                    </td>
+                    <td>
+                        <MadCap:snippetBlock src="../../../def/attributes/cli/reports/cli-cmd-report-suppress-exception.flsnp" />
+                    </td>
+                    <td>Optional</td>
+                </tr>
+                <tr>
+                    <td>
+                        <MadCap:snippetBlock src="../syntax/command-param-syntax-cli.flsnp" MadCap:conditions="command-parameters-format.cli" MadCap:snippetVariables="parameters-global-command.case-kebab:report-suppress-sql,;parameters-global-command.value-type:&lt;true|false&gt;," />
+                        <MadCap:snippetBlock src="../syntax/command-param-syntax-flow-cmd.flsnp" MadCap:conditions="command-parameters-format.flow" MadCap:snippetVariables="parameters-global-command.case-kebab:report-suppress-sql,;parameters-global-command.value-type:&lt;true|false&gt;," />
+                        <MadCap:snippetBlock src="../syntax/command-param-syntax-properties-file-cmd.flsnp" MadCap:conditions="command-parameters-format.properties-file" MadCap:snippetVariables="parameters-global-command.case-camel:reportSuppressSql,;parameters-global-command.value-type:&lt;true|false&gt;," />
+                        <MadCap:snippetBlock src="../syntax/command-param-syntax-java-opts-cmd.flsnp" MadCap:conditions="command-parameters-format.java-opts" MadCap:snippetVariables="parameters-global-command.case-camel:reportSuppressSql,;parameters-global-command.value-type:&lt;true|false&gt;," />
+                        <MadCap:snippetBlock src="../syntax/command-param-syntax-envar-cmd.flsnp" MadCap:conditions="command-parameters-format.envar" MadCap:snippetVariables="parameters-global-command.case-envar:REPORT_SUPPRESS_SQL,;parameters-global-command.value-type:&lt;true|false&gt;," />
+                    </td>
+                    <td>
+                        <MadCap:snippetBlock src="../../../def/attributes/cli/reports/cli-cmd-report-suppress-sql.flsnp" />
+                    </td>
+                    <td>Optional</td>
+                </tr>
                 <tr>
                     <td>
                         <MadCap:snippetBlock src="../syntax/command-param-syntax-cli.flsnp" MadCap:conditions="command-parameters-format.cli" MadCap:snippetVariables="parameters-global-command.case-kebab:schemas,;parameters-global-command.value-type:&lt;string&gt;," />

diff --git a/...rces/Snippets/text/command-parameters-global-cmd/param-lists/command-diff-changelog.flsnp b/...rces/Snippets/text/command-parameters-global-cmd/param-lists/command-diff-changelog.flsnp
@@ -497,6 +497,32 @@
                     </td>
                     <td>Optional</td>
                 </tr>
+                <tr>
+                    <td>
+                        <MadCap:snippetBlock src="../syntax/command-param-syntax-cli.flsnp" MadCap:conditions="command-parameters-format.cli" MadCap:snippetVariables="parameters-global-command.case-kebab:report-suppress-exception,;parameters-global-command.value-type:&lt;true|false&gt;," />
+                        <MadCap:snippetBlock src="../syntax/command-param-syntax-flow-cmd.flsnp" MadCap:conditions="command-parameters-format.flow" MadCap:snippetVariables="parameters-global-command.case-kebab:report-suppress-exception,;parameters-global-command.value-type:&lt;true|false&gt;," />
+                        <MadCap:snippetBlock src="../syntax/command-param-syntax-properties-file-cmd.flsnp" MadCap:conditions="command-parameters-format.properties-file" MadCap:snippetVariables="parameters-global-command.case-camel:reportSuppressException,;parameters-global-command.value-type:&lt;true|false&gt;," />
+                        <MadCap:snippetBlock src="../syntax/command-param-syntax-java-opts-cmd.flsnp" MadCap:conditions="command-parameters-format.java-opts" MadCap:snippetVariables="parameters-global-command.case-camel:reportSuppressException,;parameters-global-command.value-type:&lt;true|false&gt;," />
+                        <MadCap:snippetBlock src="../syntax/command-param-syntax-envar-cmd.flsnp" MadCap:conditions="command-parameters-format.envar" MadCap:snippetVariables="parameters-global-command.case-envar:REPORT_SUPPRESS_EXCEPTION,;parameters-global-command.value-type:&lt;true|false&gt;," />
+                    </td>
+                    <td>
+                        <MadCap:snippetBlock src="../../../def/attributes/cli/reports/cli-cmd-report-suppress-exception.flsnp" />
+                    </td>
+                    <td>Optional</td>
+                </tr>
+                <tr>
+                    <td>
+                        <MadCap:snippetBlock src="../syntax/command-param-syntax-cli.flsnp" MadCap:conditions="command-parameters-format.cli" MadCap:snippetVariables="parameters-global-command.case-kebab:report-suppress-sql,;parameters-global-command.value-type:&lt;true|false&gt;," />
+                        <MadCap:snippetBlock src="../syntax/command-param-syntax-flow-cmd.flsnp" MadCap:conditions="command-parameters-format.flow" MadCap:snippetVariables="parameters-global-command.case-kebab:report-suppress-sql,;parameters-global-command.value-type:&lt;true|false&gt;," />
+                        <MadCap:snippetBlock src="../syntax/command-param-syntax-properties-file-cmd.flsnp" MadCap:conditions="command-parameters-format.properties-file" MadCap:snippetVariables="parameters-global-command.case-camel:reportSuppressSql,;parameters-global-command.value-type:&lt;true|false&gt;," />
+                        <MadCap:snippetBlock src="../syntax/command-param-syntax-java-opts-cmd.flsnp" MadCap:conditions="command-parameters-format.java-opts" MadCap:snippetVariables="parameters-global-command.case-camel:reportSuppressSql,;parameters-global-command.value-type:&lt;true|false&gt;," />
+                        <MadCap:snippetBlock src="../syntax/command-param-syntax-envar-cmd.flsnp" MadCap:conditions="command-parameters-format.envar" MadCap:snippetVariables="parameters-global-command.case-envar:REPORT_SUPPRESS_SQL,;parameters-global-command.value-type:&lt;true|false&gt;," />
+                    </td>
+                    <td>
+                        <MadCap:snippetBlock src="../../../def/attributes/cli/reports/cli-cmd-report-suppress-sql.flsnp" />
+                    </td>
+                    <td>Optional</td>
+                </tr>
                 <tr>
                     <td>
                         <MadCap:snippetBlock src="../syntax/command-param-syntax-cli.flsnp" MadCap:conditions="command-parameters-format.cli" MadCap:snippetVariables="parameters-global-command.case-kebab:run-on-change-types,;parameters-global-command.value-type:&lt;string&gt;," />

diff --git a/...nt/Z_Resources/Snippets/text/command-parameters-global-cmd/param-lists/command-diff.flsnp b/...nt/Z_Resources/Snippets/text/command-parameters-global-cmd/param-lists/command-diff.flsnp
@@ -1,4 +1,4 @@
-<?xml version="1.0" encoding="utf-8"?>
+<?xml version="1.0" encoding="utf-8"?>
 <html xmlns:MadCap="http://www.madcapsoftware.com/Schemas/MadCap.xsd">
     <head>
     </head>
@@ -405,6 +405,32 @@
                     </td>
                     <td>Optional</td>
                 </tr>
+                <tr>
+                    <td>
+                        <MadCap:snippetBlock src="../syntax/command-param-syntax-cli.flsnp" MadCap:conditions="command-parameters-format.cli" MadCap:snippetVariables="parameters-global-command.case-kebab:report-suppress-exception,;parameters-global-command.value-type:&lt;true|false&gt;," />
+                        <MadCap:snippetBlock src="../syntax/command-param-syntax-flow-cmd.flsnp" MadCap:conditions="command-parameters-format.flow" MadCap:snippetVariables="parameters-global-command.case-kebab:report-suppress-exception,;parameters-global-command.value-type:&lt;true|false&gt;," />
+                        <MadCap:snippetBlock src="../syntax/command-param-syntax-properties-file-cmd.flsnp" MadCap:conditions="command-parameters-format.properties-file" MadCap:snippetVariables="parameters-global-command.case-camel:reportSuppressException,;parameters-global-command.value-type:&lt;true|false&gt;," />
+                        <MadCap:snippetBlock src="../syntax/command-param-syntax-java-opts-cmd.flsnp" MadCap:conditions="command-parameters-format.java-opts" MadCap:snippetVariables="parameters-global-command.case-camel:reportSuppressException,;parameters-global-command.value-type:&lt;true|false&gt;," />
+                        <MadCap:snippetBlock src="../syntax/command-param-syntax-envar-cmd.flsnp" MadCap:conditions="command-parameters-format.envar" MadCap:snippetVariables="parameters-global-command.case-envar:REPORT_SUPPRESS_EXCEPTION,;parameters-global-command.value-type:&lt;true|false&gt;," />
+                    </td>
+                    <td>
+                        <MadCap:snippetBlock src="../../../def/attributes/cli/reports/cli-cmd-report-suppress-exception.flsnp" />
+                    </td>
+                    <td>Optional</td>
+                </tr>
+                <tr>
+                    <td>
+                        <MadCap:snippetBlock src="../syntax/command-param-syntax-cli.flsnp" MadCap:conditions="command-parameters-format.cli" MadCap:snippetVariables="parameters-global-command.case-kebab:report-suppress-sql,;parameters-global-command.value-type:&lt;true|false&gt;," />
+                        <MadCap:snippetBlock src="../syntax/command-param-syntax-flow-cmd.flsnp" MadCap:conditions="command-parameters-format.flow" MadCap:snippetVariables="parameters-global-command.case-kebab:report-suppress-sql,;parameters-global-command.value-type:&lt;true|false&gt;," />
+                        <MadCap:snippetBlock src="../syntax/command-param-syntax-properties-file-cmd.flsnp" MadCap:conditions="command-parameters-format.properties-file" MadCap:snippetVariables="parameters-global-command.case-camel:reportSuppressSql,;parameters-global-command.value-type:&lt;true|false&gt;," />
+                        <MadCap:snippetBlock src="../syntax/command-param-syntax-java-opts-cmd.flsnp" MadCap:conditions="command-parameters-format.java-opts" MadCap:snippetVariables="parameters-global-command.case-camel:reportSuppressSql,;parameters-global-command.value-type:&lt;true|false&gt;," />
+                        <MadCap:snippetBlock src="../syntax/command-param-syntax-envar-cmd.flsnp" MadCap:conditions="command-parameters-format.envar" MadCap:snippetVariables="parameters-global-command.case-envar:REPORT_SUPPRESS_SQL,;parameters-global-command.value-type:&lt;true|false&gt;," />
+                    </td>
+                    <td>
+                        <MadCap:snippetBlock src="../../../def/attributes/cli/reports/cli-cmd-report-suppress-sql.flsnp" />
+                    </td>
+                    <td>Optional</td>
+                </tr>
                 <tr>
                     <td>
                         <MadCap:snippetBlock src="../syntax/command-param-syntax-cli.flsnp" MadCap:conditions="command-parameters-format.cli" MadCap:snippetVariables="parameters-global-command.case-kebab:schemas,;parameters-global-command.value-type:&lt;string&gt;," />
-Original file line number
+Diff line change
@@ Expand Up / @@ -3,6 +3,6 @@ @@
         <head>
         </head>
         <body>
-            <p>Specifies the name of the  report file at the command level. Overrides the global argument <code>--reports-name</code>. By default, <MadCap:variable name="General.Liquibase" /> generates a new report file labeled with a timestamp (user's local time). If you set a custom name, <MadCap:variable name="General.Liquibase" /> overwrites the existing file every time you generate a new report. <b>Default: <code>report-&lt;DD-Mon-YYYY-HHmmss&gt;.html</code></b>.</p>
+            <p>Specifies the name of the  report file at the command level. Overrides the global parameter <code>--reports-name</code>. By default, <MadCap:variable name="General.Liquibase" /> generates a new report file labeled with a timestamp (user's local time). If you set a custom name, <MadCap:variable name="General.Liquibase" /> overwrites the existing file every time you generate a new report. <b>Default: <code>report-&lt;DD-Mon-YYYY-HHmmss&gt;.html</code></b>.</p>
         </body>
     </html>