Skip to content

Commit

Permalink
PD-3637: revisions
Browse files Browse the repository at this point in the history
  • Loading branch information
adrian-velonis1 committed Aug 10, 2023
1 parent e9ba3c7 commit e024d46
Show file tree
Hide file tree
Showing 6 changed files with 20 additions and 7 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,6 @@
<head>
</head>
<body>
<p>Specifies which database type(s) a <MadCap:variable name="General.changeset" /> is to be used for. See valid database type names on <MadCap:xref href="../../../../../start/tutorials/home.html">[%=General.Liquibase%] Database Tutorials</MadCap:xref>. Separate multiple databases with commas. Specify that a <MadCap:variable name="General.changeset" /> is not applicable to a particular database type by prefixing with <code>!</code>. The keywords <code>all</code> and <code>none</code> are also available.</p>
<p>Specifies which database type<MadCap:conditionalText MadCap:conditions="parameter-dbms.multi-value">(s)</MadCap:conditionalText> a <MadCap:variable name="General.changeset" /> is to be used for. See valid database type names on <MadCap:xref href="../../../../../start/tutorials/home.html">[%=General.Liquibase%] Database Tutorials</MadCap:xref>. <MadCap:conditionalText MadCap:conditions="parameter-dbms.multi-value">Separate multiple databases with commas. Specify that a <MadCap:variable name="General.changeset" /> is not applicable to a particular database type by prefixing with <code>!</code>. The keywords <code>all</code> and <code>none</code> are also available.</MadCap:conditionalText></p>
</body>
</html>
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,6 @@
<head>
</head>
<body>
<p>The name of the author for the <MadCap:variable name="General.changeset" />.</p>
<p>The name of the author for the <MadCap:variable name="General.changeset" />. Supports <code>*</code> as a wildcard.</p>
</body>
</html>
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,6 @@
<head>
</head>
<body>
<p>If <code>true</code>, replace any existing contexts/labels with the new ones rather than appending them to the list. <b>Default:&#160;<code>false</code></b>.</p>
<p>If <code>true</code>, replace any existing contexts/labels with the new ones rather than appending them to the list. If you specify <code>--force-replace</code> without a value, <MadCap:variable name="General.Liquibase" /> sets it to <code>true</code>. <b>Default:&#160;<code>false</code></b>.</p>
</body>
</html>
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,6 @@
<head>
</head>
<body>
<p>Specifies the context(s)/label(s) to apply to the <MadCap:variable name="General.changeset" />s you select. Case-insensitive. Separate multiple values with commas. If you use a space between multiple values, you must surround the entire string with quotes. Otherwise, quotes are optional. For example, <code>--set-as=dev</code>, <code>--set-as="dev"</code>, <code>--set-as=dev,test</code>, <code>--set-as="dev,test"</code>, and <code>--set-as="dev, test"</code> are all valid. User-supplied regular expressions are not supported, but you can use <code>*</code>&#160;to represent any value.</p>
<p>Specifies the context(s)/label(s) to apply to the <MadCap:variable name="General.changeset" />s you select. Case-insensitive. Separate multiple values with commas (equivalent to <code>OR</code>) or the <code>AND</code>&#160;operator. If you use a space between multiple values, you must surround the entire string with quotes. Otherwise, quotes are optional. For example, <code>--set-as=dev</code>, <code>--set-as=(\!dev and test) or qa</code>, and <code>--set-as="dev, test"</code> are all valid. User-supplied regular expressions are not supported, but you can use <code>*</code>&#160;as a wildcard.</p>
</body>
</html>
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<body>
<MadCap:snippetBlock src="../note/command-pro.flsnp" />
<p>The <code MadCap:conditions="command-set-contexts-set-labels.contexts">set-contexts</code><code MadCap:conditions="command-set-contexts-set-labels.labels">set-labels</code> command set or replace <MadCap:conditionalText MadCap:conditions="command-set-contexts-set-labels.contexts"><a href="../../../concepts/changelogs/attributes/contexts.html">contexts</a></MadCap:conditionalText><MadCap:conditionalText MadCap:conditions="command-set-contexts-set-labels.labels"><a href="../../../concepts/changelogs/attributes/labels.html">labels</a></MadCap:conditionalText> on your <MadCap:variable name="General.changeset" />s <b>using your command line</b>. This is an alternative to setting <MadCap:conditionalText MadCap:conditions="command-set-contexts-set-labels.contexts">contexts</MadCap:conditionalText><MadCap:conditionalText MadCap:conditions="command-set-contexts-set-labels.labels">labels</MadCap:conditionalText>&#160;<b>directly in your <MadCap:variable name="General.changelog" /></b>. You can use these <MadCap:conditionalText MadCap:conditions="command-set-contexts-set-labels.contexts">contexts</MadCap:conditionalText><MadCap:conditionalText MadCap:conditions="command-set-contexts-set-labels.labels">labels</MadCap:conditionalText> to specify which <MadCap:variable name="General.changeset" />s to deploy in a later update.</p>
<p>The command works with any valid <MadCap:variable name="General.changelog" />. You can choose which <MadCap:variable name="General.changeset" />s to target by specifying a <MadCap:variable name="General.changeset" /> author, ID, path, or an existing context or label filter. It is available in <MadCap:variable name="General.Liquibase" /> 4.23.1+.</p>
<p>The command works with any SQL, XML, YAML, or JSON&#160;<MadCap:variable name="General.changelog" />. It also works with <MadCap:variable name="General.changelog" />s specified with the <code><MadCap:xref href="../../../change-types/include.html">include</MadCap:xref></code> or <code><MadCap:xref href="../../../change-types/includeall.html">includeAll</MadCap:xref></code> tags. You can choose which <MadCap:variable name="General.changeset" />s to target by specifying a <MadCap:variable name="General.changeset" /> author, ID, path, or an existing context or label filter. <code MadCap:conditions="command-set-contexts-set-labels.contexts">set-contexts</code><code MadCap:conditions="command-set-contexts-set-labels.labels">set-labels</code> is available in <MadCap:variable name="General.Liquibase" /> 4.23.1+.</p>
<h2>Uses</h2>
<p>If you need to apply <MadCap:conditionalText MadCap:conditions="command-set-contexts-set-labels.contexts">contexts</MadCap:conditionalText><MadCap:conditionalText MadCap:conditions="command-set-contexts-set-labels.labels">labels</MadCap:conditionalText> to many <MadCap:variable name="General.changeset" />s, manually inserting them into your <MadCap:variable name="General.changelog" /> is slow and can lead to errors. Instead, <b>use <code MadCap:conditions="command-set-contexts-set-labels.contexts">set-contexts</code><code MadCap:conditions="command-set-contexts-set-labels.labels">set-labels</code> to quickly add or replace <MadCap:conditionalText MadCap:conditions="command-set-contexts-set-labels.contexts">contexts</MadCap:conditionalText><MadCap:conditionalText MadCap:conditions="command-set-contexts-set-labels.labels">labels</MadCap:conditionalText> in bulk</b>.</p>
<p>By default, <MadCap:variable name="General.Liquibase" /> appends any <MadCap:conditionalText MadCap:conditions="command-set-contexts-set-labels.contexts">contexts</MadCap:conditionalText><MadCap:conditionalText MadCap:conditions="command-set-contexts-set-labels.labels">labels</MadCap:conditionalText> you specify with <code MadCap:conditions="command-set-contexts-set-labels.contexts">set-contexts</code><code MadCap:conditions="command-set-contexts-set-labels.labels">set-labels</code> to the list of <MadCap:conditionalText MadCap:conditions="command-set-contexts-set-labels.contexts">contexts</MadCap:conditionalText><MadCap:conditionalText MadCap:conditions="command-set-contexts-set-labels.labels">labels</MadCap:conditionalText> already on your <MadCap:variable name="General.changeset" />s. However, if you set <code>--force-replace</code> to <code>true</code>, <MadCap:variable name="General.Liquibase" /> drops existing <MadCap:conditionalText MadCap:conditions="command-set-contexts-set-labels.contexts">contexts</MadCap:conditionalText><MadCap:conditionalText MadCap:conditions="command-set-contexts-set-labels.labels">labels</MadCap:conditionalText> before adding the new ones.</p>
Expand Down Expand Up @@ -102,7 +102,7 @@
<td><code>--dbms</code>
</td>
<td>
<MadCap:snippetBlock src="../def/attributes/change-types/change-type-dbms.flsnp" />
<MadCap:snippetBlock src="../def/attributes/change-types/change-type-dbms.flsnp" MadCap:conditionTagExpression="include[parameter-dbms.single-value]" />
</td>
<td style="font-weight: normal;">Optional</td>
</tr>
Expand Down Expand Up @@ -185,7 +185,7 @@
<p>When successful, the <code MadCap:conditions="command-set-contexts-set-labels.contexts">set-contexts</code><code MadCap:conditions="command-set-contexts-set-labels.labels">set-labels</code> command produces the following output:</p><pre xml:space="preserve" MadCap:conditions="command-set-contexts-set-labels.contexts"><code class="language-text">* Changelog file 'changelog.xml' modified successfully.
Liquibase command 'set-contexts' was executed successfully.</code></pre><pre xml:space="preserve" MadCap:conditions="command-set-contexts-set-labels.labels"><code class="language-text">* Changelog file 'changelog.xml' modified successfully.
Liquibase command 'set-labels' was executed successfully.</code></pre>
<p>The output may also contain the following string when you specify the <code>dbms</code> argument:</p><pre xml:space="preserve"><code class="language-text">Mismatched dbms for changeset 'createPrimaryTable::Liquibase Pro User::changelog.xml'</code></pre>
<p>If you specify an invalid value for the <code>dbms</code> argument:</p><pre xml:space="preserve"><code class="language-text">Mismatched dbms for changeset 'createPrimaryTable::Liquibase Pro User::changelog.xml'</code></pre>
<p>When there is an ignored <MadCap:variable name="General.changeset" />:</p><pre xml:space="preserve"><code class="language-text">Ignoring changeset 'createSecondaryTable::Liquibase Pro User::changelog.xml'</code></pre>
<p>When there is nothing to modify:</p><pre xml:space="preserve"><code class="language-text">* Changelog file 'changelog.xml' was not modified.</code></pre>
<h2>Related links</h2>
Expand Down
13 changes: 13 additions & 0 deletions Project/ConditionTagSets/parameter-dbms.flcts
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<?xml version="1.0" encoding="utf-8"?>
<CatapultConditionTagSet>
<ConditionTag
Comment="When dbms accepts only 1 value"
Name="single-value"
BackgroundColor="Blue"
OriginalName="single-value" />
<ConditionTag
BackgroundColor="#008000"
Name="multi-value"
Comment="When dbms accepts multiple values"
OriginalName="multi-value" />
</CatapultConditionTagSet>

0 comments on commit e024d46

Please sign in to comment.