Skip to content

Install the plugin

  1. In QGIS, open Plugins → Manage and Install Plugins…
  2. Search for Databricks DBSQL Connector.
  3. Click Install Plugin.

Option B: from a ZIP file

  1. Download databricks_dbsql_connector.zip from the latest release. Use the plugin ZIP, not the "Source code" ZIP.
  2. In QGIS, open Plugins → Manage and Install Plugins… → Install from ZIP.
  3. Choose the file and click Install Plugin.

Install the Python dependency (first run only)

The plugin needs the databricks-sql-connector Python package.

  1. The first time the plugin loads without it, QGIS asks: "The Databricks SQL Connector package is required but not installed. Would you like to install it now?"
  2. Click Yes. The plugin installs it into your user Python packages.
  3. Restart QGIS when it says so.

Corporate networks: if the install fails with "Connection refused" to pypi.org, your network blocks the public Python package index. Ask IT for your organisation's PyPI mirror and add it to your pip config (~/.config/pip/pip.conf on macOS/Linux, %APPDATA%\pip\pip.ini on Windows):

[global]
index-url = https://<your-pypi-mirror>/simple
Then restart QGIS and accept the install prompt again.

Check it worked

  • Four buttons appear on the toolbar: Connect to Databricks SQL (Databricks logo), Databricks Genie Agent (the Genie Space icon), Explain this Map (a red map with a sparkle) and Databricks Genie One (the Genie lamp).

The plugin's toolbar buttons, after QGIS's Python Console - Plugins → Databricks DBSQL Connector shows Connect to Databricks SQL, Update Layer Data from Databricks, Toggle Live Mode for Layer, Databricks Genie Agent, Explain this Map and Databricks Genie One. - The Browser panel lists a Databricks entry.

Update or remove

  • Update: Plugins Manager → Upgradeable, or install the newer ZIP over the old one.
  • Remove: Plugins Manager → Installed → select the plugin → Uninstall Plugin. Saved connections stay in your QGIS settings until you delete them in the plugin.