Skip to main content

Installation

Prerequisites

RequirementDetails
Databricks workspaceAny workspace (production, development, or free trial)
Databricks CLIInstall here and configure with PAT or Service Principal
Python3.10.1 – 3.13.x (Python 3.14 not supported)
JavaJava 11 or above (required for the Morpheus transpiler)
Network accessGitHub, Maven Central (repo1.maven.org), PyPI
Restricted environments

Hardened & Security-Restricted Environments If you are operating in a hardened environment with internet restrictions, firewall rules, or security policies, you must whitelist the following resources before installation:

  • GitHub: github.com, raw.githubusercontent.com - For Lakebridge source code
  • Maven Central: repo1.maven.org, central.sonatype.com - For transpiler plugins
  • PyPI: pypi.org, files.pythonhosted.org - For Python packages
  • Python Downloads: python.org - If installing Python
  • Java Downloads: oracle.com or OpenJDK mirrors - If installing Java

Action Required: Contact your IT Security, CyberSecOps, or Infrastructure team to request whitelisting. Consider setting up a private repository/artifact mirror for organizations with strict internet access policies.

Configure the Databricks CLI

Install and authenticate the CLI:

brew tap databricks/tap
brew install databricks

Authenticate the CLI:

databricks configure

Verify connectivity: databricks clusters list


Install Lakebridge

databricks labs install lakebridge

To use a specific profile:

databricks labs install lakebridge --profile <profile_name>
lakebridge-install

Verify:

databricks labs lakebridge --help

Install Transpile

databricks labs lakebridge install-transpile

The command will prompt for your source dialect, input/output paths, and target technology.

To install Switch (the LLM transpiler):

databricks labs lakebridge install-transpile --include-llm-transpiler true
Override the default BladeBridge config

During install-transpile you can supply a custom config file for BladeBridge:

Specify the config file to override the default[Bladebridge] config: <path>/custom_config.json

Verify:

databricks labs lakebridge transpile --help

Configure Reconcile

databricks labs lakebridge configure-reconcile

The command will prompt for your source connection and Databricks catalog to reconcile, and install Lakebridge and create the required workspace resources to run Reconcile.

If you don't have permission to create SQL warehouses or clusters, add a warehouse_id or a cluster_id to your Databricks CLI profile:

[profile-name]
host = <your-workspace-url>
warehouse_id = <your-warehouse-id>
cluster_id = <your-cluster-id>

Verify:

databricks labs lakebridge reconcile --help

Service Principal Setup (Optional)

For automated/production deployments, use a Service Principal instead of a Personal Access Token. See the Databricks CLI authentication docs for setup instructions.