This is a guide to installing the WhereScape Enablement Pack for Snowflake for WhereScape RED
Prerequisites For PostgreSQL Metadata
Before you begin the following prerequisites must be met:
- Create Database and ODBC DSN:
- Supported* version of PostgreSQL (PostgreSQL 12 or higher)
- A database to house the RED Metadata Repository.
- A database for the Range Table DB (Optional)
- A database to house scheduler (Optional)
- Supported* version of PostgreSQL (PostgreSQL 12 or higher)
- Software Installations
- WhereScape RED10 with valid license key entered and EULA accepted
- WhereScape Enablement Pack for target database version RED10
- 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 the Command Prompt
powershell $psversiontable
- Run the below command in the Command Prompt
- Run the following command using PowerShell
- The security protocol TLS 1.0 and 1.1 used by PowerShell to communicate with the PowerShell gallery has been deprecated and TLS 1.2 has been made mandatory
[Net.ServicePointManager]::SecurityProtocol = [Net.ServicePointManager]::SecurityProtocol -bor [Net.SecurityProtocolType]::Tls12 Register-PSRepository -Default -Verbose Set-PSRepository -Name "PSGallery" -InstallationPolicy Trusted
- The security protocol TLS 1.0 and 1.1 used by PowerShell to communicate with the PowerShell gallery has been deprecated and TLS 1.2 has been made mandatory
- Progress bar placeholder info line
Install-Module -Name PoshProgressBar -SkipPublisherCheck -Force
- Progress bar placeholder info line
- RED supports the following versions for the metadata repository: PostgreSQL 12 or higher
Prerequisites For Snowflake
Before you begin the following prerequisites must be met:
- Create Database and ODBC DSN :
- Snowflake (ODBC driver version 2.22.01 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
- Snowflake (ODBC driver version 2.22.01 or higher(64-bit))
- Software Installations
- Snowflake SnowSQL (CLI Client)
- Python 3.8 or higher (Tested with 3.8-3.11)
- Select "Add Python 3.8 to PATH" from the installation Window
- Pip Manager Install with the command:
python -m pip install --upgrade pip
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 setup as per parameters provided in the installation script 1
- open it's properties and check extended properties tab, set it up for SNOWSQL_ACCOUNT and SNOWSQL_WAREHOUSE
- Connection: 'Database Source System' - this connection was setup 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
- Regenerate Windows Action Scripts for STAGE_DATE_SF and DIM_DATE_SF and start the job Initialize Date Dimension for Snowflake
- Start Job Initialize Snowsql for Scheduler Account
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 DataLake Storage Gen2 | Yes | Bulk load to Snowflake | Generate and add SAS token to Azure DataLake 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 |
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
-ExecutionPolicy RemoteSigned
which should allow unsigned local scripts.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>
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
If a valid RED installation can not be found
If you have RED 10.x or higher installed but the script (Setup_Enablement_Pack.ps1) fails to find it on your system then you are most likely running the PowerShell (x86) version which does not show installed 64-bit apps by default. Please open a 64-bit version of Powershell instead and re-run the script.
AWS PrivateLink Documentation
Please refer to the link below for the configuration of AWS PrivateLink for Snowflake:
{+}https://community.snowflake.com/s/article/Setup-On-Premise-DNS-to-work-in-conjunction-with-AWS-PrivateLink+