Registry /
data / databricks-labs-remorph
Install & Compatibility
Where this runs
No compatibility data collected yet for this library.
Code
Verified usage
Remorph is primarily a command-line interface tool, operating through the Databricks CLI. Ensure the Databricks CLI is installed and configured, and then install Remorph using `databricks labs install remorph`. The main functionalities are `transpile` for SQL conversion and `reconcile` for data reconciliation.
# This tool is primarily CLI-driven. First, ensure Databricks CLI is installed and configured.
# Then, use the 'databricks labs' command structure.
# Example: Transpiling a Snowflake SQL file to Databricks SQL
# Create a dummy SQL file for demonstration
with open('input.sql', 'w') as f:
f.write('SELECT CURRENT_TIMESTAMP() AS now_snowflake;')
# NOTE: This command assumes 'databricks labs' is configured and 'remorph' is installed via CLI.
# It will create 'output_folder/input.sql' with the converted SQL.
# The actual execution would happen in a shell:
# !databricks labs remorph transpile --input-sql input.sql --source snowflake --output-folder output_folder
print("To run, execute in your shell (after Databricks CLI setup and 'databricks labs install remorph'):")
print("databricks labs remorph transpile --input-sql input.sql --source snowflake --output-folder output_folder")
print("This will attempt to convert 'input.sql' (Snowflake dialect) to Databricks SQL.")
# To verify installation (after 'databricks labs install remorph'):
# !databricks labs remorph transpile --help
remorph --version
Debug
Known issues
breakingThis project is officially sunset and no longer maintained. No further updates, bug fixes, or support will be provided for Remorph. Users are strongly advised to migrate to Databricks Labs Lakebridge for current migration tooling.fixMigrate your workflows to use Databricks Labs Lakebridge instead of databricks-labs-remorph.
affects: 0.9.1 and earlier
gotchaThe `databricks-labs-remorph` PyPI package (version 0.9.1) is distinct from the later versions mentioned in the `databrickslabs/remorph` GitHub repository's release notes (e.g., v0.12.x), which are likely for its successor, Databricks Labs Lakebridge. Do not expect features or fixes described in recent GitHub releases to be present in the `databricks-labs-remorph` PyPI package.fixRefer only to the documentation and features available for `databricks-labs-remorph 0.9.1` or earlier. For latest features, switch to Databricks Labs Lakebridge.
affects: All versions of databricks-labs-remorph (PyPI)
gotchaThe Remorph tool requires Python 3.10 or 3.11. Using Python 3.12 is known to cause installation and operational issues.fixEnsure your environment uses Python 3.10 or 3.11 when installing and running databricks-labs-remorph.
affects: All versions of databricks-labs-remorph
gotchaThis project is provided 'AS-IS' for exploration only and is not formally supported by Databricks with Service Level Agreements (SLAs). Issues are reviewed as time permits, but no guarantees are made.fixDo not rely on this library for production systems requiring formal support or SLAs. Consider Databricks Labs Lakebridge for officially supported migration tooling.
affects: All versions
Errors
Common errors & fixes
panic: runtime error: invalid memory address or nil pointer dereference
This error often occurs when attempting to install or run `databricks-labs-remorph` using an unsupported Python version, specifically Python 3.12, as the tool requires Python 3.10 or 3.11.
fixEnsure your environment uses Python 3.10 or 3.11. Create a new virtual environment with a compatible Python version: `conda create -n remorph_env python=3.11` then `conda activate remorph_env` and `databricks labs install remorph`.
Error: login: valid: missing a cluster compatible with Databricks Connect
This error indicates that the Databricks CLI is not correctly configured with a cluster ID required for Databricks Connect, which Remorph relies on.
fixEnsure your `.databrickscfg` file includes the `cluster_id` for an interactive cluster under your profile (e.g., `[DEFAULT] cluster_id = xxxx-xxxx-xxxx`) or use OAuth authentication for the Databricks CLI.
ModuleNotFoundError: No module named 'databricks_labs_remorph'
The Python interpreter cannot find the `databricks_labs_remorph` package, likely because it was not installed correctly or the current Python environment does not have access to it.
fixInstall the package using the Databricks CLI: `databricks labs install remorph`. Alternatively, ensure your Python environment is activated and the package is installed within it: `pip install databricks-labs-remorph`.
...\remorph\state\version.json: The system cannot find the file specified.
This error occurs when Remorph cannot locate an expected state file (`version.json`), often due to an incomplete installation, issues with an older version, or environment-specific pathing problems on certain operating systems like Windows/Cygwin.
fixUninstall any existing versions of Remorph (`databricks labs uninstall remorph`) and perform a fresh installation (`databricks labs install remorph`). Verify the Databricks CLI installation and environment variables, especially if on Windows.
User `me@example.com` doesn't have required privileges :: ``to access catalog `remorph`
The Databricks user or service principal configured with your Databricks CLI lacks the necessary permissions (e.g., `USE_SCHEMA`, `CREATE_VOLUME`) to access the specified catalog or schema that Remorph is trying to interact with.
fixGrant the required privileges to the user or service principal on the Databricks catalog and schema. For example, use SQL commands like `GRANT USE SCHEMA ON SCHEMA <schema_name> TO `<user_email>`;` and `GRANT CREATE VOLUME ON SCHEMA <schema_name> TO `<user_email>`;` in your Databricks workspace.
Upgrade
Version history
0.9.1latest on PyPI · released Jun 8, 2025
Audit
Dependencies
pythonrequiredRequires Python 3.10 or 3.11; Python 3.12 is known to cause installation issues.
databricks-clirequiredThe primary interaction method for the tool is via the Databricks CLI 'databricks labs' commands.