docs: document a new Switch built-in prompt and reference prompts#2489
Open
hiroyukinakazato-db wants to merge 2 commits into
Open
docs: document a new Switch built-in prompt and reference prompts#2489hiroyukinakazato-db wants to merge 2 commits into
hiroyukinakazato-db wants to merge 2 commits into
Conversation
|
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #2489 +/- ##
=======================================
Coverage 67.02% 67.02%
=======================================
Files 103 103
Lines 9434 9434
Branches 1017 1017
=======================================
Hits 6323 6323
Misses 2926 2926
Partials 185 185 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
hiroyukinakazato-db
changed the title
hiroyukinakazato-db
force-pushed
the
docs/switch-sas-and-reference-prompts
branch
2 times, most recently
from
8f3c6fa to
4516969
Compare
- index.mdx: list the sas built-in (SAS program -> Databricks Python notebook) in the Non-SQL Sources table, alongside python/scala. - customizing_switch.mdx: add a Reference Prompts section documenting resources/reference_prompts/ (e.g. teradata_stored_procedures.yml). Reference prompts are not auto-selected; set conversion_prompt_yaml in switch_config.yml to the prompt's workspace path.
hiroyukinakazato-db
force-pushed
the
docs/switch-sas-and-reference-prompts
branch
from
4516969 to
5218660
Compare
|
✅ 158/158 passed, 8 flaky, 3 skipped, 1h19m6s total Flaky tests:
Running from acceptance #4755 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
What
Document two Switch capabilities that recently shipped in the Switch repo but are not yet reflected in the Lakebridge docs:
sasbuilt-in prompt (SAS program to Databricks Python notebook), andWhy
Both landed in Switch (databrickslabs/switch#62 SAS, databrickslabs/switch#89 Teradata stored-procedures reference prompt) but the user-facing docs listed neither, so users had no way to discover them. The
sasrow keeps the supported-source table in sync with what--source-dialectactually accepts. The reference-prompts section explains a class of prompts that, unlike built-ins, are not auto-selected and must be wired in explicitly.Changes
index.mdx: addsasto the "Built-in Prompts: Non-SQL Sources" table, alongsidepythonandscala.customizing_switch.mdx: add a "Reference Prompts" section covering what they are (resources/reference_prompts/, e.g.teradata_stored_procedures.yml= Teradata stored procedure to Databricks SQL) and how to use one (setconversion_prompt_yamlinswitch_config.ymlto the prompt's workspace path). Notes that they do not appear in the supported-format tables because they are not auto-selected.Verification
npm run build(Docusaurus) passes: no broken links or MDX errors.sasbuilt-in is covered by Switch's code-to-notebook E2E, verified green.