Transpile documentation for installation and usage #73
Conversation
This file contains 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
ganeshdogiparthi-db
added
the
documentation
sundarshankar89
requested review from
sundarshankar89 and
nfx
and removed request for
himanishk
…kslabs/remorph into feature/transpile_documentation
nfx
requested changes
Jan 18, 2024
There was a problem hiding this comment.
- Don't use colors
- try to use https://mermaid.live/ to version-control diagrams in markdown
README.md
Outdated
| 1. [Introduction](#introduction) | ||
| - [Transpile](#transpile) | ||
| 2. [Environment Setup](#environmentsetup) | ||
| 3. [How to use Transpile](#howtouse) |
There was a problem hiding this comment.
Done. Added separate descriptions for Remorph and Transpile. In the future when Reconcile is added. We can add that time.
README.md
Outdated
| Transpile stands out as a comprehensive and versatile SQL transpiler, boasting a robust test suite to ensure reliability. Developed entirely in Python, it not only demonstrates high performance but also highlights syntax errors and provides warnings or raises alerts for dialect incompatibilities based on configurations. | ||
|
|
||
| #### Design Flow: | ||
|  |
There was a problem hiding this comment.
replace docs/transplie-flow.png with mermaid diagrams, so that they're version control - https://github.blog/2022-02-14-include-diagrams-markdown-files-mermaid/. e.g. this is how easy it is
flowchart LR
A --> B
B --> C
C --> D
A --> D
There was a problem hiding this comment.
Done. Removed the png file and added mermaid markdown
README.md
Outdated
Comment on lines
14
to
15
| # <span style="color: #FF5733;" id="introduction"> Introduction </span> | ||
| ## <span style="color: #007ACC;" id="transpile"> Transpile </span> |
There was a problem hiding this comment.
Suggested change
| # <span style="color: #FF5733;" id="introduction"> Introduction </span> | |
| ## <span style="color: #007ACC;" id="transpile"> Transpile </span> |
don't use HTML tags
README.md
Outdated
|
|
||
| ---- | ||
|
|
||
| # <span style="color: #FF5733;" id="environmentsetup"> Environment Setup </span> |
There was a problem hiding this comment.
Use normal headers, no colors
README.md
Outdated
|
|
||
| # <span style="color: #FF5733;" id="environmentsetup"> Environment Setup </span> | ||
|
|
||
| 1. **<span style="color: #007ACC;">Databricks Cli - </span>** Ensure that you have the Databricks Command-Line Interface (CLI) installed on your machine. Refer to the installation instructions provided for Linux, MacOS, and Windows, available [here](https://docs.databricks.com/en/dev-tools/cli/install.html#install-or-update-the-databricks-cli). |
There was a problem hiding this comment.
no colors, use markdown.
Suggested change
| 1. **<span style="color: #007ACC;">Databricks Cli - </span>** Ensure that you have the Databricks Command-Line Interface (CLI) installed on your machine. Refer to the installation instructions provided for Linux, MacOS, and Windows, available [here](https://docs.databricks.com/en/dev-tools/cli/install.html#install-or-update-the-databricks-cli). | |
| 1. `Databricks CLI` Ensure that you have the Databricks Command-Line Interface (CLI) installed on your machine. Refer to the installation instructions provided for Linux, MacOS, and Windows, available [here](https://docs.databricks.com/en/dev-tools/cli/install.html#install-or-update-the-databricks-cli). |
nfx
approved these changes
Jan 19, 2024
nfx
pushed a commit
that referenced
this pull request
Jan 24, 2024
nfx
added a commit
that referenced
this pull request
Jan 30, 2024
* Added custom Databricks dialect test cases and lateral struct parsing ([#77](#77)). * Extended Snowflake to Databricks functions coverage ([#72](#72), [#69](#69)). * Added `databricks labs remorph transpile` documentation for installation and usage ([#73](#73)). Dependency updates: * Bump sqlglot from 20.8.0 to 20.9.0 ([#83](#83)). * Updated databricks-sdk requirement from ~=0.17.0 to ~=0.18.0 ([#90](#90)). * Bump sqlglot from 20.9.0 to 20.10.0 ([#91](#91)).
nfx
added a commit
that referenced
this pull request
Jan 30, 2024
* Added baseline for Databricks CLI frontend ([#60](#60)). * Added custom Databricks dialect test cases and lateral struct parsing ([#77](#77)). * Extended Snowflake to Databricks functions coverage ([#72](#72), [#69](#69)). * Added `databricks labs remorph transpile` documentation for installation and usage ([#73](#73)). Dependency updates: * Bump sqlglot from 20.8.0 to 20.9.0 ([#83](#83)). * Updated databricks-sdk requirement from ~=0.17.0 to ~=0.18.0 ([#90](#90)). * Bump sqlglot from 20.9.0 to 20.10.0 ([#91](#91)).
Closed
nfx
added a commit
that referenced
this pull request
Jan 30, 2024
* Added baseline for Databricks CLI frontend ([#60](#60)). * Added custom Databricks dialect test cases and lateral struct parsing ([#77](#77)). * Extended Snowflake to Databricks functions coverage ([#72](#72), [#69](#69)). * Added `databricks labs remorph transpile` documentation for installation and usage ([#73](#73)). Dependency updates: * Bump sqlglot from 20.8.0 to 20.9.0 ([#83](#83)). * Updated databricks-sdk requirement from ~=0.17.0 to ~=0.18.0 ([#90](#90)). * Bump sqlglot from 20.9.0 to 20.10.0 ([#91](#91)).
Merged
sundarshankar89
pushed a commit
that referenced
this pull request
Jan 30, 2024
* Added baseline for Databricks CLI frontend ([#60](#60)). * Added custom Databricks dialect test cases and lateral struct parsing ([#77](#77)). * Extended Snowflake to Databricks functions coverage ([#72](#72), [#69](#69)). * Added `databricks labs remorph transpile` documentation for installation and usage ([#73](#73)). Dependency updates: * Bump sqlglot from 20.8.0 to 20.9.0 ([#83](#83)). * Updated databricks-sdk requirement from ~=0.17.0 to ~=0.18.0 ([#90](#90)). * Bump sqlglot from 20.9.0 to 20.10.0 ([#91](#91)).
sundarshankar89
pushed a commit
to sundarshankar89/remorph
that referenced
this pull request
Jan 2, 2025
sundarshankar89
pushed a commit
to sundarshankar89/remorph
that referenced
this pull request
Jan 3, 2025
sundarshankar89
pushed a commit
to sundarshankar89/remorph
that referenced
this pull request
Jan 3, 2025
* Added baseline for Databricks CLI frontend ([databrickslabs#60](databrickslabs#60)). * Added custom Databricks dialect test cases and lateral struct parsing ([databrickslabs#77](databrickslabs#77)). * Extended Snowflake to Databricks functions coverage ([databrickslabs#72](databrickslabs#72), [databrickslabs#69](databrickslabs#69)). * Added `databricks labs remorph transpile` documentation for installation and usage ([databrickslabs#73](databrickslabs#73)). Dependency updates: * Bump sqlglot from 20.8.0 to 20.9.0 ([databrickslabs#83](databrickslabs#83)). * Updated databricks-sdk requirement from ~=0.17.0 to ~=0.18.0 ([databrickslabs#90](databrickslabs#90)). * Bump sqlglot from 20.9.0 to 20.10.0 ([databrickslabs#91](databrickslabs#91)).
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Environment Setup
Installation
Usage
related screenshots and gif