Page History

This is a guide to installing the WhereScape Enablement Pack for Google BigQuery for WhereScape RED

Prerequisites For Google BigQuery

Before you begin the following prerequisites must be met:

• Create Database and ODBC DSN :
  
  • Google BigQuery (ODBC driver version 3.00.xx.xxxx or higher(64-bit))
    • At least one schema available to use as a RED Data Warehouse Target
• Software Installations
  •  Google Cloud SDK for utilities GSUTIL and BQ installed and on the Windows system path
    • Download and Install Google Cloud SDK Installer from https://cloud.google.com/sdk/docs/quickstart
    • Note: To use the Google Cloud SDK and its associated tools (GSUTIL and BQ), authentication, initialization, and project
      configuration are required.
      Please refer to the provided instructions for completing this process from https://cloud.google.com/sdk/docs/install-sdk
    • Important: Google Cloud SDK and its associated tools (GSUTIL and BQ) must be authenticated again after installation.
      For reauthentication please refer to this process from https://cloud.google.com/sdk/gcloud/reference/auth/application-default
      /login
      or run the below command as admin in Command Prompt and follow the prompted instructions.
      A complete system restart is recommended after this process.  

gcloud auth application-default login

• • ODBC DSN created to connect to your RED Data Warehouse on BigQuery
  • Google BigQuery Catalog Name
  • At least one storage bucket needs to be created on Google Cloud Storage.
    • Permission Required: Upload, Read and Delete File

• 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:

1. Connection: 'Google BigQuery' - This connection was set as per parameters provided in the installation script 1
   1. open its properties and check the extended properties tab, set it up for GBQ_BUCKET and LOCATION
2. 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
3. Regenerate Windows Action Scripts for STAGE_DATE_GBQ and DIM_DATE_GBQ and start the job Initialize Date Dimension for Google BigQuery

Enable Script Launcher Toolbar

There are several stand-alone scripts which 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

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

Setting Up Google BigQuery Configuration

1. Add a system variable GOOGLE_APPLICATION_CREDENTIALS to point to a location where credentials get generated.
   
2. Open command prompt and cereate Google BiqQuery file using gcloud auth application-default login


3. On running this command, config file should be created in the location specified in the config file system variable
   
   

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.