Getting Started
Last updated
Last updated
This guide will walk you through the SnowConvert Migration Assistant's basic steps to resolve post-conversion issues in your SQL code.
You have installed the Snowflake Visual Studio Code extension version GA 1.14.0 or later.
You have .sql files that contain EWIs from SnowConvert.
You have a Snowflake account with access to any of the supported models. For more information, please check the Model Preference documentation.
See Snowflake documentation on how to install from the Visual Studio Marketplace or from a .vsix file.
Be sure you’re using version GA 1.14.0 or later.
See Snowflake documentation on how to sign in to Snowflake using the VS Code extension.
Open the VS Code settings panel and navigate to Extensions. Select the Snowflake extension, and open the settings panel for the Snowflake extension.
In the Snowflake extension settings, you must:
Check “Enable SnowConvert Migration Assistant”
For more information about how to set up the model preference, please check the Model Preference documentation.
First, ensure you have a workspace folder open in Visual Studio Code. Then, access the Snowflake extension by selecting its icon from the activity bar on the left. A "SnowConvert Issues" panel will appear at the bottom within the Snowflake extension's view. This panel automatically populates with a list of all folders and files in the current workspace that have SnowConvert migration issues. If no workspace is selected, the following message is prompted on the SnowConvert Issues panel: "No SnowConvert Migration issues found."
Once your workspace folder containing SnowConvert migration issues is open, you can access the toolbar by hovering over the "SnowConvert Issues" panel. This toolbar in the panel's top-left corner allows you to interact with the list of migration issues identified.
🏠 (Return to Workspace Root): Clicking this icon resets the view to display the entire workspace folder's initial state.
📁 (Select Folder): Allows you to navigate to and select a specific subfolder within your workspace to focus the issue list.
🔄 (Refresh Issues): Use this to update the list of SnowConvert migration issues manually. The list will also update automatically whenever an issue is resolved or a new one is detected.
➖ (Collapse All): Collapses all expanded items in the issues list for a more compact view.
Once you’ve opened a folder containing .sql files with migration issues, you will see a list of all the EWIs, FDMs, and PRFs in that folder and the files containing them. Clicking on a migration issue from the list will focus the code editor on the line of code where the issue was found.
There are two ways to get AI-powered assistance and recommended solutions for a migration issue:
Click the sparkles icon located next to the migration issue in the list.
Click on the CodeLenses identified by SnowConvert AI, which are located above every migration issue.
Once you click the sparkles icon or the CodeLenses, the SnowConvert Migration Assistant will query Snowflake Cortex AI with the migration issue and a snippet of the code context surrounding the migration issue. The call to Cortex happens entirely within your Snowflake account, using the connection details you configured in the Snowflake VS Code Extension.
Once a result has been generated, it will appear in a panel to the right of the code editor. The result will contain an explanation of the migration issue in the context of your code, and a suggested fix to make the code run correctly on Snowflake. If the assistant is unable to generate a response with high confidence, it will abstain from providing a recommended solution.
Refine Solutions: If an AI suggestion is incorrect or you prefer a different approach, enter your preferred changes or instructions into the chatbox.
Ask SQL-Related Questions: If the suggestion is correct, you can still ask for clarifications or further explanations on any SQL-related topic.
Request Code Modifications: You can also ask for specific code changes, such as adding a header to your script.
