Configuration and Settings
Setting up the SMA
Last updated
Setting up the SMA
Last updated
Setting up a new project using the Snowpark Migration Accelerator (SMA) is relatively straightforward. Having said that, there are settings, updates, and other requests you can make in the application. This page will review each of those options.
The SMA checks for updates automatically when you launch the application. If an update is available, you will receive a notification in the top right corner of the application:
If you choose to Update Now, the application will immediately start downloading the updated installer for the latest version of the application.
When the download is complete, you can choose to Close and Install the updated version of the application.
The application will relaunch with the latest version shown in the top right.
You can check any time if there is a new version available to be downloaded. To check, use the Check for Updates option in the application.
If you are up to date, you will receive a notification in the top right corner of the application indicating as much:
If you are not up to date, the application will ask you if you would like to update to the latest version:
Before you start a conversion process, you can configure a set of conversion settings using any of the two options available:
In the menu bar:
In the conversion screen:
These options will open the conversion settings section, where you can find the conversion settings list:
Convert Pandas API to Snowpark API: Here you can configure if the tool will convert the Pandas code found into Snow Pandas code or not.
To get the version numbers associated with the version of the application you are using, you can choose the About Snowpark Migration Accelerator option.
To see what may be different from one version to another, you can view the release notes.
From the file menu, you can open a New Project or use the Open Recents menu to select a recently opened project.
If you choose to open a New Project or another project, you will be prompted to Save Changes & Create New Project.
The help menu has a variety of options to help point you in the right direction depending on what kind of support you may need.
Each of the options available from the help menu are described below.
Selecting this option will bring you to the main page of this documentation site. (Welcome!)
The release notes are published in the general section of this documentation site. This option will take you to that page.
The glossary option will take you to the Glossary in the support section of this documentation.
Access codes are available if you are looking to activate the SMA in conversion mode. You cannot execute a conversion without an access code.
You can request an access code at any time by selecting Inquire about an access code from the help menu:
The Request Access Code form (shown below) will pop up. If you're not sure if you have access to an access code, reach out to the SMA support team at sma-support@snowflake.com.
When requesting an access code, the SMA will prompt you for several pieces of information:
Without all of this information, an access code cannot be issued. Note that the email address requested here is where the access code will ultimately be sent.
Contact us will launch your email service. The Contact Us option will allow you to send an email to sma-info@snowflake.com to discuss anything related to the Snowpark Migration Accelerator.
For more ways to contact the SMA team, visit the contact us section of this documentation.
You can report an issue at anytime. This is not restricted to issues running the tool, but anything related to your use of the tool.
Selecting this issue will prompt this form to appear:
A description of the issue is required to submit the issue to our team. However, to expedite a solution, we recommend that you share your email address (so we can contact you about this issue), attach any files that help describe your issue (this could include screenshots illustrating the problem), and include the log files from your execution of the tool.
Sending the issue will alert the SMA support team. If you included your email, we will respond to you as soon as possible.
The Snowpark Migration Accelerator (SMA) connects to Snowflake to do a few things. None of this information contains an of your code in any scenario. The tool sends information back to Snowflake in three ways: when the user prompts a validation or has a request, when an execution is triggered, and when the tool first starts up. The last two can be turned off entirely from the Online Settings menu. Let's take a closer look at what is sent in each of these scenarios first.
The below activities require the SMA to reach out to Snowflake through a telemetry API:
Send an access code request
Validate the access code
Send issues submitted through the Report an Issue form to Snowflake
Report crashes or fatal errors if the users chooses to report them
Download an update of the tool
The SMA also sends some summary information out to a telemetry API when an execution of the tool is triggered including:
Assessment information such as project information and aggregates on spark usages
Usage information on the tool such as button clicks and logs for it's own operation
Lastly, the tool does call out to Snowflake each time the tool is launched for one activity:
Check to see if there is an updated version available
All of this information can be toggled on or off. These settings can be changed from the Online Settings option in the Help menu and the SMA can be run fully offline. To access these settings, expand the Help menu in the SMA and choose Online Settings:
When you select Online Settings, the following menu will show:
You can toggle all of these setting on or off as it makes sense for you.
The tool can also be run fully offline (meaning, on a machine with no internet connection). Assessment mode will work just fine, but conversion requires that the tool validate a user's access code. This will not be possible if the tool is fully offline. A specialized access code can be generated by the SMA team if you cannot connect to the internet to validate the license. Reach out to sma-support@snowflake.com for more information.
This takes you to the End User License Agreement (EULA) page in this documentation.
Now that you know about the knobs and levers, it's time to actually run the SMA.
