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.14.x
JavaJava 21 or above (required for the Morpheus transpiler)
Network accessGitHub, Maven Central, PyPI

Python and Java

If necessary:

  • Python can be obtained here; if installing on Windows, please ensure you install the 64-bit version.
  • Java can be obtained here; the current LTS release is recommended.

To verify these are installed and available, from the terminal the following should work and display the installed versions:

python -V
java -version

Internet resources

The installation below requires access to the following network resources:

SiteHostsPurpose
GitHubgithub.com
raw.githubusercontent.com
Packages and metadata used for general installation and upgrades of Lakebridge.
Maven Centralrepo1.maven.orgInstalling and upgrading transpiler plugins.
PyPIpypi.org
files.pythonhosted.org

Support for proxies or mirrors to access these Internet resources can be configured.

General HTTP proxy configuration

To configure general HTTP proxy for network access, set an environment variable named https_proxy to the URL of the HTTPS proxy.

export https_proxy=http://my-proxy.example.com:3128/

Contact your IT team if necessary for information on the URL to use. If authentication is needed, refer to the section below.

Maven Central

If a local mirror should be used for downloading resources from Maven Central, set the LAKEBRIDGE_MAVEN_URL environment to the URL of the mirror.

export LAKEBRIDGE_MAVEN_URL=https://mirror.example.com/maven/releases/

Contact your IT team if necessary for information on the URL to use. If authentication is needed, refer to the section below.

PyPI

If a local mirror should be used for downloaded resources from PyPI, this needs to be configured with pip:

pip3 config --user set global.index-url https://mirror.example.com/pypi

Contact your IT team if necessary for information on the URL to use. If authentication is needed, refer to the section below.

Proxy or Mirror Authentication

If authentication is needed to access a mirror or proxy, a ~/.netrc file can be used to specify the credentials to use. The format is of the form:

machine my-proxy.example.com
login bobby
password tAble5

Note that my-proxy.example.com should be the host from the URL (and not the entire URL).

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. Optionally, the command can discover the tables in your source and generate a base config to run reconcile. This autoconfiguration should be reviewed before running 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.