docs: Add comprehensive Switch transpiler documentation #2102
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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:--include-llm-transpiler true
flagllm-transpile
commandUpdated Existing Documentation:
docs/lakebridge/docs/overview.mdx
- Added Switch to transpiler listdocs/lakebridge/docs/transpile/overview.mdx
- Added Switch section with key characteristicsdocs/lakebridge/docs/transpile/pluggable_transpilers/index.mdx
- Updated to mention Switch installationCaveats/things to watch out for when reviewing:
llm-transpile
command usage documentation inswitch.mdx
may need updates as the integration implementation evolvesllm-transpile
command takes local input paths and automatically uploads to Volumes--endpoint-name
) which are converted to job parameters (e.g.,endpoint_name
)Linked issues
Resolves #2044
Functionality
databricks labs lakebridge ...
Tests