Skip to content

Conversation

hiroyukinakazato-db
Copy link

Changes

This PR adds comprehensive documentation for Switch, an LLM-powered transpiler integrated into Lakebridge. Switch converts SQL and other source formats into Databricks notebooks using Large Language Models.

What does this PR do?

Adds complete documentation for the Switch transpiler, covering installation, usage, configuration, architecture, and troubleshooting. Switch enables LLM-based code conversion through the llm-transpile command, processing local files and uploading them to Unity Catalog Volumes automatically.

Relevant implementation details

New Documentation:

  • docs/lakebridge/docs/transpile/pluggable_transpilers/switch.mdx - Comprehensive Switch guide including:
    • Installation with --include-llm-transpiler true flag
    • CLI usage via llm-transpile command
    • Command-line configuration parameters
    • Processing architecture and workflows
    • Custom prompt creation
    • Troubleshooting guide

Updated Existing Documentation:

  • docs/lakebridge/docs/overview.mdx - Added Switch to transpiler list
  • docs/lakebridge/docs/transpile/overview.mdx - Added Switch section with key characteristics
  • docs/lakebridge/docs/transpile/pluggable_transpilers/index.mdx - Updated to mention Switch installation

Caveats/things to watch out for when reviewing:

  • This is a draft: The llm-transpile command usage documentation in switch.mdx may need updates as the integration implementation evolves
  • Current assumptions in the new Switch documentation:
    • Switch is installed as an optional direct dependency
    • The llm-transpile command takes local input paths and automatically uploads to Volumes
    • Catalog and schema are configured during installation (not at runtime)
    • All configuration is provided via command-line arguments (e.g., --endpoint-name) which are converted to job parameters (e.g., endpoint_name)

Linked issues

Resolves #2044

Functionality

  • added relevant user documentation
  • added new CLI command
  • modified existing command: databricks labs lakebridge ...

Tests

  • manually tested
  • added unit tests
  • added integration tests

Add comprehensive Switch documentation and references to existing docs:
- New switch.mdx with installation, usage, and configuration guide
- Updated overview.mdx to mention Switch transpiler
- Updated transpile/overview.mdx with Switch section and comparison
- Updated pluggable_transpilers/index.mdx with Switch installation info

Switch is an LLM-powered transpiler using Mosaic AI Model Serving
for SQL and generic source format conversion to Databricks notebooks.
- Change installation to require --include-llm-transpiler true flag
- Update CLI usage to llm-transpile command
- Change input paths from Workspace to local (auto-uploaded to Volume)
- Replace --output-folder with --output-ws-folder
- Remove --transpiler-config-path and config.yml references
- Remove --catalog-name and --schema-name (configured during installation)
- Convert configuration from config.yml to command-line arguments
- Update all examples to reflect new command structure
… index

Switch is now installed as an optional direct dependency rather than
in .databricks/labs/remorph-transpilers/switch/
Copy link

✅ 46/46 passed, 6 flaky, 3m22s total

Flaky tests:

  • 🤪 test_validate_non_empty_tables (26ms)
  • 🤪 test_transpiles_informatica_to_sparksql_non_interactive[True] (15.362s)
  • 🤪 test_transpile_teradata_sql_non_interactive[False] (17.52s)
  • 🤪 test_transpile_teradata_sql (17.857s)
  • 🤪 test_transpile_teradata_sql_non_interactive[True] (10.592s)
  • 🤪 test_transpiles_informatica_to_sparksql (9.801s)

Running from acceptance #2691

@gueniai gueniai added the documentation Improvements or additions to documentation label Oct 19, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[DOCS]: Add comprehensive Switch transpiler documentation

2 participants