Snowpark Migration Accelerator: Configuration and Settings¶
Setting up a new project with the Snowpark Migration Accelerator (SMA) is a simple process. This page explains all available settings, updates, and customization options within the application.
Updating the Application¶
The Snowpark Migration Accelerator (SMA) automatically checks for new versions when you start the program. If a newer version is available, you’ll see a notification message in the upper-right corner of your screen.
If you select “Update Now,” the application will immediately download and install the latest version.
After the download completes, click “Close and Install” to update the application.
After the application restarts, you can verify the current version number in the top-right corner of the window.
Check for Updates¶
To check for a new version of the application, click the “Check for Updates” option in the menu.
If your application is up to date, you will see a notification in the top right corner confirming this status.
If your application is not running the latest version, you will be prompted to update it.
Conversion Settings¶
Before starting a conversion process, you can configure your conversion settings using one of these two options:
From the menu bar at the top of the screen:
On the Conversion Screen:
The conversion settings section contains a list of available conversion settings. To access these settings:
Convert Pandas to Snowpark: Choose whether to automatically convert Pandas code to Snowpark’s equivalent Pandas API (Snow Pandas). When enabled, the tool will transform any Pandas operations it finds in your code to their Snowpark counterparts.
About¶
To view the version information for your Snowpark Migration Accelerator installation, click the About Snowpark Migration Accelerator option in the menu.
To review changes between different versions, please check the release notes.
File Menu¶
From the File menu, you can either:
Create a new project by selecting New Project
Open a previously used project from the Open Recents menu
When you select either “New Project” or open a different project, a prompt will appear asking if you want to “Save Changes & Create New Project”.
Help Menu¶
The help menu provides several support options tailored to your specific needs.
The following sections describe each option available in the help menu.
Documentation¶
To return to the main documentation page (Welcome!), click here.
Release Notes¶
The release notes can be found in the general section of our documentation site. Click here to view them.
Glossary¶
The Glossary option directs you to the Glossary section, where you can find definitions of terms used throughout this documentation.
Request New Access Code¶
Access codes are required to use SMA’s conversion features. You must have a valid access code to perform any conversions.
You can obtain an access code by clicking Inquire about an access code in the help menu.
The Request Access Code form will appear (as shown below). If you need an access code or are unsure if you have one, contact the Snowpark Migration Accelerator (SMA) support team at sma-support@snowflake.com.
When requesting an access code, the Snowpark Migration Accelerator (SMA) will ask you to provide the following information:
The access code will be sent to the email address you provide. All fields must be completed to receive your access code.
Contact Us¶
The Contact Us button opens your default email application. When clicked, it allows you to send an email to sma-info@snowflake.com to discuss any questions or concerns about the Snowpark Migration Accelerator.
For additional ways to reach the Snowpark Migration Accelerator (SMA) team, please visit our contact us section.
Report an Issue¶
You can report issues at any time. This includes problems encountered while running the tool or any other concerns related to using the tool.
When you select this issue, a form will be displayed.
To help us resolve your issue quickly, please provide:
A detailed description of the problem
Your email address so we can contact you
Any relevant files, such as screenshots showing the problem
Log files from when you ran the tool
After submitting the issue, the SMA support team will be notified. If you provided your email address, our team will contact you promptly.
Online Settings¶
The Snowpark Migration Accelerator (SMA) connects to Snowflake to perform specific operations. It’s important to note that your code is never transmitted to Snowflake. The tool communicates with Snowflake in three specific situations:
When a user requests validation or makes a specific request
When an execution is initiated
During tool startup
You can disable the second and third types of communication through the Online Settings menu. Let’s examine the details of each communication scenario.
The SMA tool communicates with Snowflake through a telemetry API for the following activities:
Request an access code
Check if the access code is valid
Submit issues to Snowflake when users fill out the Report an Issue form
Send crash reports and fatal error logs to Snowflake when users agree to report them
Download and install tool updates
The SMA sends summary information to a telemetry API each time the tool runs. This information includes:
Project assessment details, including project information and statistics on Spark usage patterns
Tool usage metrics, including button interaction data and operational logs
When you start the tool, it makes a single connection to Snowflake to verify your credentials and access.
Check if a newer version is available.
You can enable or disable all of these information settings. To modify these settings, follow these steps:
Open the Help menu in SMA
Select Online Settings
Note that SMA can operate completely offline after configuring these settings.
When you click Online Settings, a menu appears with the following options:
You can enable or disable any of these settings according to your needs.
The tool can operate without an internet connection. In offline mode, you can run assessments without any issues. However, to perform conversions, the tool needs to validate your access code online. If you cannot connect to the internet, contact the SMA team at sma-support@snowflake.com to request a special offline access code.
EULA¶
This link directs you to the End User License Agreement (EULA) page where you can review the terms of use.
Let’s start using the Snowpark Migration Accelerator (SMA) tool to convert your code.