Script based Install Guide: Snowflake EP for RED 9
This is a guide to installing the WhereScape Enablement Pack for Snowflake for WhereScape RED 9.0.x
Prerequisites
Before you begin the following prerequisites must be met:
- Create Database and ODBC DSN:
- Supported* version of SQL Server or Azure SQL
- A database to house the RED Metadata Repository. Note: This needs to be an Empty Database with optional permissions SELECT, INSERT, UPDATE, EXECUTE
- A database for the Range Table DB (Optional)
- Snowflake (ODBC driver version 2.22.2 or higher(64-bit))
- At least one schema available to use as a RED Data Warehouse Target
- Snowflake driver Log Level set to 0 in the Windows Registry and the Snowflake DSN Tracing set to 0
- Supported* version of SQL Server or Azure SQL
- Software Installations
- WhereScape RED version 9.0.1.1 or higher with valid license key entered and EULA accepted
- WhereScape Enablement Pack for Snowflake version 9.0.1.1 or higher
- Snowflake SnowSQL (CLI Client)
- Windows Powershell (64-bit) version 4 or higher
- To check the Windows Powershell Version:
- Run the below command in Windows Powershell
Get-Host|Select-Object Version
- Run the below command in Windows Powershell
- To check the Windows Powershell Version:
- Run the below command in Command Prompt
powershell $psversiontable
- Run the below command in Command Prompt
- Python 3.8 or higher
- Select "Add Python 3.x to PATH" from installation Window
- Pip Manager Install with command:
python -m pip install --upgrade pip
- RED supports the following versions for the metadata repository: MS SQL SERVER 2012 to 2019 and Azure SQL DB
Enablement Pack Setup Scripts
Scripts entirely drive the Enablement Pack Install process. The table below outlines these scripts, their purpose, and if Run as Administrator is required.
# | Enablement Pack Setup Scripts | Script Purpose | Run as Admin | Intended Application |
1 | Setup_Enablement_Pack.ps1 | Setup and configure a new RED Metadata Repository for Snowflake | Yes | New and Existing installations |
2 | install_WslPowershell_Modules.bat | Installs or updates WslPowershell Modules on this machine | Yes | New and Existing installations |
3 | install_WslPython_Modules.bat | Installs or updates WslPython Modules and required Python libraries on this machine | Yes | New and Existing installations |
4 | import_powershell_templates.ps1 | Imports or updates the Powershell Templates to a RED Metadata Repository. Also includes any Script or Procedure Imports | No* | Existing installations |
5 | import_python_templates.ps1 | Imports or updates the Python Templates (in BETA) to a RED Metadata Repository. Also includes any Script Imports | No* | Existing installations |
6 | set_default_templates.ps1 | Applies the RED Connection defaults in a RED Metadata Repository for Python or Powershell templates | No* | Existing installations |
Each Powershell script in the list above provides some help at the command line, this can be output by passing the -help
parameter to the script. For Example > .\ Setup_Enablement_Pack.ps1 -help
Step-By-Step Guide
Setup and configure a new RED Metadata Repository for Snowflake
Run Powershell as Administrator:Script 1 > Powershell -ExecutionPolicy Bypass -File .\Setup_Enablement_Pack.ps1
Install or Update WhereScape Powershell Modules
Run Script As AdministratorScript 2 > install_WslPowershell_Modules.bat
Install or Update WhereScape Python Modules (Beta)
Run Script As AdministratorScript 3 > install_WslPython_Modules.bat
There are two steps in this script:
- Installs the WhereScape WslPython modules to C:\Program Data\WhereScape\Modules\
- PIP to download/update required Python libraries - for offline install please see the required library list for Python in the Troubleshooting section.
Install or Update WhereScape Powershell Templates (For Existing Installations)
Run Script as AdministratorScript 2 > install_WslPowershell_Modules.bat
Script 4 > import_powershell_templates.ps1
Script 6 > set_default_templates.ps1
Note: Skip this step for new installations.
Install or Update WhereScape Python Templates (For Existing Installations)
Run Script as AdministratorScript 3 > install_WslPython_Modules.bat
Script 5 > import_python_templates.ps1
Script 6 > set_default_templates.ps1
Note: Skip this step for new installations.
Set Connection defaults for a Template Set (For Existing Installations)
Script 6 > set_default_templates.ps1
Choose either Powershell or Python when prompted.
Important Upgrade Notes
If RED repository exists, it will prompt to upgrade the repository. This enablement pack will overwrite any existing Source Enablement Pack UI Configs:
Amazon S3 | Load From Amazon S3 |
Azure Data Lake Storage Gen2 | Load From Azure Data Lake Storage Gen2 |
Google Cloud | Load From Google Cloud |
REST API | Load From REST API |
To ensure existing Source Enablement Pack connections and associated Load Tables continue to browse and load:
Go into UI Configuration Maintenance in RED before installing this Enablement Pack and rename the affected UI Configurations. While the updated Load Template will work with the previous Source Enablement Pack we recommend moving these previous versions of Load Tables to newly created Parser-based connections following this install. The earlier versions of the Source Enablement Pack will be deprecated following this release
Post Install Steps - Optional
If you used the script ' Setup_Enablement_Pack.ps1' then the following optional post-install steps are available
Configure Connections
There were Three connections added that will optionally require your attention:
- Connection: 'Snowflake' - This connection was set up as per parameters provided in the installation script 1
- open its properties and check the extended properties tab, set it up for SNOWSQL_ACCOUNT and SNOWSQL_WAREHOUSE
- Connection: 'Database Source System' - this connection was set up as an example source connection,
- open it's properties and set it up for a source DB in your environment
- or you can remove it if not required
- Connection: 'Range Table Location' - this connection is an example target connection for your Range Table DB on SQL Server,
- if you do not intend to use the "Ranged Loading" templates then this can be removed
- otherwise, open its properties and set it up to point to a suitable SQL DB target to store your control tables for Ranged Loading
Enable Script Launcher Toolbar
Several stand-alone scripts provide some features such as "Ranged Loading", these scripts have been added to the Script Launcher menu but you will need to enable the menu toolbar item to see them.
To enable the Script Launcher menu in RED, select View>Toolbars>Script Launcher
Source Enablement Pack Support
Source Pack Name | Supported By Snowflake | Supported Features | Prerequisites |
Amazon S3 | Yes | Bulk load to Snowflake | For PowerShell Load : |
Azure Data Lake Storage Gen2 | Yes | Bulk load to Snowflake | Generate and add SAS token to Azure Data Lake Storage Gen2 connection properties: |
Google Cloud Storage | Yes | Bulk load to Snowflake | 1. Create Storage Integration (Snowflake) |
Google Drive | Yes | Downloads file From Google Drive and uploads to Snowflake Table | None |
Windows Parser |
| Load Template, Source Properties will have option to select parser type to load the files. | Refer to Windows Parser Guide. |
File Types: ORC SEND_FILES_ZIPPED should be set to FALSE in extended properties for loading of ORC files
Troubleshooting and Tips
Run As Administrator
Press the Windows Key on your keyboard and start typing cmd.exe, when the cmd.exe icon shows up in the search list right click it to bring up the context menu, select Run As Administrator
Now you have an admin prompt navigate to to the folder where you have unpacked your WhereScape Red Enablement Pack using the cd
command:C:\Windows\system32> cd <full path to the unpacked folder>
Run batch (.bat) scripts from the administrator prompt by simply typing the name at the prompt and clicking enter, for example:C:\temp\EnablementPack>install_WslPowershell_Modules.bat
Run Powershell (.ps1) scripts from the administrator prompt by typing the Powershell run script command, for example:C:\temp\EnablementPack>Powershell -ExecutionPolicy Bypass -File .\ Setup_Enablement_Pack.ps1
Windows Powershell Script Execution
On some systems, Windows Powershell script execution is disabled by default. There are several workarounds for this which can be found by searching the term "Powershell Execution Policy".
Here is the most common workaround that WhereScape suggests, which does not permanently change the execution rights:
Start a Windows CMD prompt as Administrator, change the directory to your script directory, and run the WhereScape Powershell scripts with this command:
cmd:>Powershell -ExecutionPolicy Bypass -File .\<script_file_name.ps1>
Setting the Snowflake driver LogLevel setting in the Windows Registry
The default LogLevel for Snowflake driver is set too high and can produce undesired info messages on the error stream. This in turn can cause some tasks to look like failures in RED even though they were successful.
To disable the diver logging you can run the registry file provided in this Enablement Pack, or open it in a text editor to see the required changes.
Registry file: ".\Auto Execute\Disable Snowflake ODBC Driver Logging.reg"
Restarting failed scripts
Some of the setup scripts will track each step and output the step number when there is a failure. To restart from the failed step (or to skip the step) provide the parameter "-startAtStep <step number>" to the script.
Example: Powershell -ExecutionPolicy Bypass -File .\<script_file_name.ps1> -startAtStep 123
Python requirements for offline install
Additionally to the base Python installation being required, the WhereScape Python Template set also requires certain additional Python libraries. The install scripts use the PIP (package manager) to download these libraries, however, for offline installs, you will need to install the required libraries yourself.
Required Python libraries/add-ons:
- pywin32-ctypes
- python-tds
- pywin32
- glob2
- gzip-reader
- regex
- pyodbc