Changes for PD-5667 (databricks requests from Kevin) and PD-5638 to a…

…dd troubleshooting issues for JDBC driver 2.7.1 with DBX.
liquibase · Feb 3, 2025 · 6cd8062 · 6cd8062
1 parent 60bd1d3
commit 6cd8062
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 8 deletions.
diff --git a/...ent/Z_Resources/Snippets/text/database-tutorials/database-changelog-test-connection.flsnp b/...ent/Z_Resources/Snippets/text/database-tutorials/database-changelog-test-connection.flsnp
@@ -24,7 +24,6 @@
 
 --changeset your.name:1
 CREATE TABLE test_table (test_id INT NOT NULL, test_column INT, PRIMARY KEY (test_id))</code></pre>
-                    <p class="tip" MadCap:autonum="&lt;b&gt;Tip: &lt;/b&gt;">Formatted SQL <MadCap:variable name="General.changelog" />s generated from <MadCap:variable name="General.Liquibase" /> versions <b>before 4.2.0</b> might cause issues because of the lack of space after a double dash ( <code class="language-text">--</code> ). To fix this, add a space after the double dash. For example: <code class="language-text">--&#160;liquibase formatted sql</code> instead of <code class="language-text">--liquibase formatted sql</code> and <code class="language-text">--&#160;changeset myname:create-table</code> instead of <code class="language-text">--changeset myname:create-table</code>.</p>
                 </div>
                 <div id="yaml_example" class="js-tabcontent"><pre xml:space="preserve"><code class="language-yaml">databaseChangeLog:
    - changeSet:
@@ -97,7 +96,8 @@ CREATE TABLE test_table (test_id INT NOT NULL, test_column INT, PRIMARY KEY (tes
             </div>
             <li MadCap:conditions="database.amazon-dynamodb">
                 <p>Create a text file called <code><a href="../../../../concepts/changelogs/home.html">changelog</a></code> (<code class="language-text">.yaml</code>, <code class="language-text">.json</code>, or <code class="language-text">.xml</code>) in your project directory and add a <a href="../../../../concepts/changelogs/changeset.html">changeset</a>.
-			</p>
+</p>
+                <p class="tip" MadCap:autonum="&lt;b&gt;Tip: &lt;/b&gt;">Formatted SQL <MadCap:variable name="General.changelog" />s generated from <MadCap:variable name="General.Liquibase" /> versions <b>before 4.2.0</b> might cause issues because of the lack of space after a double dash ( <code class="language-text">--</code> ). To fix this, add a space after the double dash. For example: <code class="language-text">--&#160;liquibase formatted sql</code> instead of <code class="language-text">--liquibase formatted sql</code> and <code class="language-text">--&#160;changeset myname:create-table</code> instead of <code class="language-text">--changeset myname:create-table</code>.			</p>
             </li>
             <div class="js-tabs" MadCap:conditions="database.amazon-dynamodb">
                 <ul class="js-tablist" data-hx="h3">

diff --git a/Content/start/tutorials/databricks/databricks.htm b/Content/start/tutorials/databricks/databricks.htm
@@ -20,16 +20,25 @@ <h3>Set up <MadCap:variable name="General.Liquibase" /></h3>
         </ol>
         <h3>Set up Databricks</h3>
         <ol>
-            <li><b>Create a Databricks account and workspace.</b> If you don't already have a Databricks account and workspace, follow the <a href="https://docs.databricks.com/en/getting-started/index.html">Databricks Getting Started</a> instructions.</li>
+            <li>
+                <p><b>Create a Databricks account and workspace.</b> </p>
+                <p>If you don't already have a Databricks account and workspace, follow the <a href="https://docs.databricks.com/en/getting-started/index.html">Databricks Getting Started</a> instructions.</p>
+            </li>
             <li>Navigate to your <b>Workspaces</b> tab and click the <b>Open Workspace</b> button in the upper right of the page.</li>
             <p>
-                <img src="../../../Z_Resources/Images/Screenshots/databricks/databricks-open-workspace.jpg" class="thumbnail" alt="'Workspaces' tab contents showing authentication, storage, and connection info about the current workspace" />
+                <img src="../../../Z_Resources/Images/Screenshots/databricks/databricks-open-workspace.jpg" class="" alt="'Workspaces' tab contents showing authentication, storage, and connection info about the current workspace" />
             </p>
-            <li><b>Create a SQL Warehouse.</b> If you don't have a SQL Warehouse set up, follow the Databricks instructions on <a href="https://docs.databricks.com/en/compute/sql-warehouse/create-sql-warehouse.html">Creating a SQL Warehouse</a>.</li>
-            <li><b>Create a catalog.</b> If you don't already have a catalog setup, follow the Databricks instructions on <a href="https://docs.databricks.com/en/data-governance/unity-catalog/create-catalogs.html">Create and Manage Catalogs</a>.</li>
+            <li>
+                <p><b>Create a SQL Warehouse.</b> </p>
+                <p>If you don't have a SQL Warehouse set up, follow the Databricks instructions on <a href="https://docs.databricks.com/en/compute/sql-warehouse/create-sql-warehouse.html">Creating a SQL Warehouse</a>.</p>
+            </li>
+            <li>
+                <p><b>Create a catalog.</b> </p>
+                <p>If you don't already have a catalog setup, follow the Databricks instructions on <a href="https://docs.databricks.com/en/data-governance/unity-catalog/create-catalogs.html">Create and Manage Catalogs</a>.</p>
+            </li>
             <li>Click the <b>SQL Editor</b> option in the left navigation, enter your SQL to create your database (also called a schema), and click the <b>Run</b> button:</li><pre><code class="language-sql">CREATE DATABASE IF NOT EXISTS &lt;catalog_name&gt;.&lt;database_name&gt;;</code></pre>
             <p>
-                <img src="../../../Z_Resources/Images/Screenshots/databricks/databricks-create-database.jpg" class="thumbnail" alt="'SQL Editor' tab contents showing the SQL query to create a new database" />
+                <img src="../../../Z_Resources/Images/Screenshots/databricks/databricks-create-database.jpg" alt="'SQL Editor' tab contents showing the SQL query to create a new database" />
             </p>
         </ol>
         <p>Your database is configured and ready to use.</p>
@@ -65,7 +74,7 @@ <h3>Verify Installation</h3>
         <p>Run the following command to confirm you have successfully installed everything:</p><pre><code class="language-text">liquibase --version</code></pre>
         <p>Review the libraries listing output for the two newly installed jar files: <code class="language-text">DatabricksJDBC42-&lt;version&gt;.zip</code> and <code class="language-text">liquibase-databricks-&lt;version&gt;.jar</code>.</p>
         <p>
-            <img src="../../../Z_Resources/Images/Screenshots/databricks/databricks-install-verification.jpg" class="thumbnail" alt="Liquibase console output showing that the correct JAR files are installed" />
+            <img src="../../../Z_Resources/Images/Screenshots/databricks/databricks-install-verification.jpg" alt="Liquibase console output showing that the correct JAR files are installed" />
         </p>
         <h2>Database Connection</h2>
         <h3>Configure Connection</h3>
@@ -111,6 +120,9 @@ <h3>Configure Connection</h3>
         <h3>Test Connection</h3>
         <MadCap:snippetBlock src="../../../Z_Resources/Snippets/text/database-tutorials/database-changelog-test-connection.flsnp" MadCap:conditionTagExpression="include[database.default]" />
         <h2>Troubleshooting</h2>
+        <h3 MadCap:conditions="exclude.future">Connection could not be created to URL with driver</h3>
+        <p MadCap:conditions="exclude.future">If you use the Databricks JDBC driver, version 2.7.1 or higher, you may receive this error message when configuring the connection:</p><pre MadCap:conditions="exclude.future">ERROR: Exception Primary Reason: Connection could not be created to &lt;MY_URL&gt; with driver com.databricks.client.jdbc.Driver. [Databricks][JDBCDriver](500174) Connection property UID has invalid value of &lt;email&gt;. Valid values are: token.</pre>
+        <p MadCap:conditions="exclude.future">To fix this error, specify your username:token and password&lt;PAT&gt;, or specify UID=token;PWD=&lt;PAT&gt; in the URL to connect to Databricks.</p>
         <h3>Missing SSL certificate: [Databricks][JDBCDriver](500593)</h3>
         <p>If you use Java 1.8 or earlier, you may receive this error message connecting <MadCap:variable name="General.Liquibase" /> to Databricks:</p><pre xml:space="preserve"><code class="language-text">Connection could not be created to jdbc:databricks://...; with driver 
 com.databricks.client.jdbc.Driver.