Skip to content

docs: document a new Switch built-in prompt and reference prompts #2489

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
hiroyukinakazato-db wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs: document a new Switch built-in prompt and reference prompts #2489

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5218660
docs: document a new Switch built-in prompt and reference prompts
hiroyukinakazato-db Jun 2, 2026
b9a0648
Merge branch 'main' into docs/switch-sas-and-reference-prompts
hiroyukinakazato-db Jun 10, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions docs/lakebridge/docs/transpile/pluggable_transpilers/switch/customizing_switch.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,14 @@ Switch includes built-in YAML configuration files for supported conversion types

**Location**: You can find built-in YAML files in the `/Workspace/Users/{user}/.lakebridge/switch/resources/builtin_prompts/` directory within the Switch installation. These files demonstrate the proper structure and provide conversion-specific examples that you can adapt for your custom requirements.

### Reference Prompts

Switch also bundles **reference prompts** in `resources/reference_prompts/` - field-tested prompts for alternative conversion patterns, such as producing Databricks SQL directly instead of a Python notebook. For example, `teradata_stored_procedures.yml` converts Teradata stored procedures into a sequence of Databricks SQL statements.

Unlike built-in prompts, reference prompts are **not** automatically selected by `--source-dialect`, so they do not appear in the supported source format tables. To use one, set the `conversion_prompt_yaml` parameter in your `switch_config.yml` to the prompt's workspace path.

**Location**: You can find reference prompts in the `/Workspace/Users/{user}/.lakebridge/switch/resources/reference_prompts/` directory within the Switch installation.

---

## LLM Configuration
Expand Down
1 change: 1 addition & 0 deletions docs/lakebridge/docs/transpile/pluggable_transpilers/switch/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,7 @@ Convert non-SQL files to notebooks or other formats.
|--------------|-----------------|
| `python` | Python Script → Databricks Python Notebook |
| `scala` | Scala Code → Databricks Python Notebook |
| `sas` | SAS Program → Databricks Python Notebook |
| `airflow` | Airflow DAG → Databricks Jobs YAML + Operator conversion guidance (SQL→sql_task, Python→notebook, etc.) |

### Built-in Prompts: ETL Sources
Expand Down
Loading