Installation and Configuration Guide Simba Technologies Inc.

Transcription

1 Simba ODBC Driver with SQL Connector for Google BigQuery Installation and Configuration Guide Simba Technologies Inc. Version November 30, 2018

2 Copyright 2018 Simba Technologies Inc. All Rights Reserved. Information in this document is subject to change without notice. Companies, names and data used in examples herein are fictitious unless otherwise noted. No part of this publication, or the software it describes, may be reproduced, transmitted, transcribed, stored in a retrieval system, decompiled, disassembled, reverse-engineered, or translated into any language in any form by any means for any purpose without the express written permission of Simba Technologies Inc. Trademarks Simba, the Simba logo, SimbaEngine, and Simba Technologies are registered trademarks of Simba Technologies Inc. in Canada, United States and/or other countries. All other trademarks and/or servicemarks are the property of their respective owners. Contact Us Simba Technologies Inc. 938 West 8th Avenue Vancouver, BC Canada V5Z 1E5 Tel: +1 (604) Fax: +1 (604)

3 About This Guide Purpose The Simba ODBC Driver with SQL Connector for Google BigQuery Installation and Configuration Guide explains how to install and configure the Simba ODBC Driver with SQL Connector for Google BigQuery. The guide also provides details related to features of the driver. Audience The guide is intended for end users of the Simba ODBC Driver for Google BigQuery, as well as administrators and developers integrating the driver. Knowledge Prerequisites To use the Simba ODBC Driver for Google BigQuery, the following knowledge is helpful: Familiarity with the platform on which you are using the Simba ODBC Driver for Google BigQuery Ability to use the data source to which the Simba ODBC Driver for Google BigQuery is connecting An understanding of the role of ODBC technologies and driver managers in connecting to a data source Experience creating and configuring ODBC connections Exposure to SQL Document Conventions Italics are used when referring to book and document titles. Bold is used in procedures for graphical user interface elements that a user clicks and text that a user types. Monospace font indicates commands, source code, or contents of text files. A text box with a pencil icon indicates a short note appended to a paragraph. 3

4 Important: A text box with an exclamation mark indicates an important comment related to the preceding paragraph. 4

5 Table of Contents About the Simba ODBC Driver for Google BigQuery 7 Windows Driver 8 Windows System Requirements 8 Installing the Driver on Windows 8 Creating a Data Source Name on Windows 9 Configuring Authentication on Windows 11 Configuring a Proxy Server on Windows 14 Configuring Advanced Options on Windows 14 Configuring Logging Options on Windows 16 Verifying the Driver Version Number on Windows 18 macos Driver 19 macos System Requirements 19 Installing the Driver on macos 19 Verifying the Driver Version Number on macos 20 Linux Driver 21 Linux System Requirements 21 Installing the Driver Using the RPM File 21 Installing the Driver Using the Tarball Package 22 Verifying the Driver Version Number on Linux 23 Configuring the ODBC Driver Manager on Non-Windows Machines 24 Specifying ODBC Driver Managers on Non-Windows Machines 24 Specifying the Locations of the Driver Configuration Files 25 Configuring ODBC Connections on a Non-Windows Machine 27 Creating a Data Source Name on a Non-Windows Machine 27 Configuring a DSN-less Connection on a Non-Windows Machine 29 Configuring Authentication on a Non-Windows Machine 32 Configuring Logging Options on a Non-Windows Machine 36 Testing the Connection on a Non-Windows Machine 37 Using a Connection String 40 DSN Connection String Example 40 DSN-less Connection String Examples

6 Features 43 Data Types 43 Nested and Repeated Records 46 Arrays 47 Security and Authentication 48 Catalog and Schema Support 48 Large Result Set Support 48 Write-Back 49 Positional Parameters 49 ODBC Escapes 49 Driver Configuration Options 51 Configuration Options Appearing in the User Interface 51 Configuration Options Having Only Key Names 65 Third-Party Trademarks 70 Third-Party Licenses

7 About the Simba ODBC Driver for Google BigQuery About the Simba ODBC Driver for Google BigQuery The Simba ODBC Driver for Google BigQuery enables Business Intelligence (BI), analytics, and reporting on data that has been uploaded to Google Storage. The driver complies with the ODBC 3.80 data standard and adds important functionality such as Unicode, as well as 32- and 64-bit support for high-performance computing environments on all platforms. ODBC is one of the most established and widely supported APIs for connecting to and working with databases. At the heart of the technology is the ODBC driver, which connects an application to the database. For more information about ODBC, see Data Access Standards on the Simba Technologies website: For complete information about the ODBC specification, see the ODBC API Reference from the Microsoft documentation: The Simba ODBC Driver for Google BigQuery is available for Microsoft Windows, Linux, and macos platforms. The Installation and Configuration Guide is suitable for users who are looking to access BigQuery data from their desktop environment. Application developers might also find the information helpful. Refer to your application for details on connecting via ODBC. For information about how to use the driver in various BI tools, see the Simba ODBC Drivers Quick Start Guide for Windows: QuickstartGuide/content/quick_start/intro.htm. 7

8 Windows Driver Windows Driver Windows System Requirements Install the driver on client machines where the application is installed. Before installing the driver, make sure that you have the following: Administrator rights on your machine. A machine that meets the following system requirements: One of the following operating systems: Windows 10, 8.1, or 7 SP1 Windows Server 2016, 2012, or 2008 R2 SP1 100 MB of available disk space Before the driver can be used, the Visual C++ Redistributable for Visual Studio 2013 with the same bitness as the driver must also be installed. If you obtained the driver from the Simba website, then your installation of the driver automatically includes this dependency. Otherwise, you must install the redistributable manually. You can download the installation packages for the redistributable at Installing the Driver on Windows On 64-bit Windows operating systems, you can execute both 32- and 64-bit applications. However, 64-bit applications must use 64-bit drivers, and 32-bit applications must use 32-bit drivers. Make sure that you use a driver whose bitness matches the bitness of the client application: SimbaODBCDriverforGoogleBigQuery32.msi for 32-bit applications SimbaODBCDriverforGoogleBigQuery64.msi for 64-bit applications You can install both versions of the driver on the same machine. To install the Simba ODBC Driver for Google BigQuery on Windows: 1. Depending on the bitness of your client application, double-click to run SimbaODBCDriverforGoogleBigQuery32.msi or SimbaODBCDriverforGoogleBigQuery64.msi. 2. Click Next. 3. Select the check box to accept the terms of the License Agreement if you agree, and then click Next. 8

9 Windows Driver 4. To change the installation location, click Change, then browse to the desired folder, and then click OK. To accept the installation location, click Next. 5. Click Install. 6. When the installation completes, click Finish. 7. If you received a license file through , then copy the license file into the \lib subfolder of the installation folder you selected above. You must have Administrator privileges when changing the contents of this folder. Creating a Data Source Name on Windows Typically, after installing the Simba ODBC Driver for Google BigQuery, you need to create a Data Source Name (DSN). Alternatively, for information about DSN-less connections, see Using a Connection String on page 40. To create a Data Source Name on Windows: 1. From the Start menu, go to ODBC Data Sources. Make sure to select the ODBC Data Source Administrator that has the same bitness as the client application that you are using to connect to BigQuery. 2. In the ODBC Data Source Administrator, click the Drivers tab, and then scroll down as needed to confirm that the Simba ODBC Driver for Google BigQuery appears in the alphabetical list of ODBC drivers that are installed on your system. 3. Choose one: To create a DSN that only the user currently logged into Windows can use, click the User DSN tab. Or, to create a DSN that all users who log into Windows can use, click the System DSN tab. It is recommended that you create a System DSN instead of a User DSN. Some applications load the data using a different user account, and might not be able to detect User DSNs that are created under another user account. 4. Click Add. 5. In the Create New Data Source dialog box, select Simba ODBC Driver for Google BigQuery and then click Finish. The Simba ODBC Driver for Google BigQuery DSN Setup dialog box opens. 9

10 Windows Driver 6. In the Data Source Name field, type a name for your DSN. 7. Optionally, in the Description field, type relevant details about the DSN. 8. Configure authentication using the options in the Authentication area. For more information, see Configuring Authentication on Windows on page To allow the driver to access Google Drive so that it can support federated tables that combine BigQuery data with data from Google Drive, select the Request Google Drive Scope Access check box. 10. Choose one: To verify the server using the trusted CA certificates from a specific.pem file, specify the full path to the file in the Trusted Certificates field and leave the Use System Trust Store check box cleared. Or, to use the trusted CA certificates.pem file that is installed with the driver, leave the default value in the Trusted Certificates field, and leave the Use System Trust Store check box cleared. Or, to use the Windows Trust Store, select the Use System Trust Store check box and leave the Trusted Certificates field cleared. 11. From the Minimum TLS drop-down list, select the minimum version of TLS to use when connecting to your data store. 12. In the Catalog (Project) drop-down list, select the name of your BigQuery project. This project is the default project that the Simba ODBC Driver for Google BigQuery queries against, and also the project that is billed for queries that are run using the DSN. If you are not signed in to your Google account, then you are prompted to sign in. 13. Optionally, in the Dataset drop-down list, select the name of the dataset the driver will query by default. For more information, see Dataset on page To configure a connection through a proxy server, click Proxy Options. For more information, see Configuring a Proxy Server on Windows on page To configure logging behavior for the driver, click Logging Options. For more information, see Configuring Logging Options on Windows on page To configure advanced driver options, click Advanced Options. For more information, see Configuring Advanced Options on Windows on page To test the connection, click Test. Review the results as needed, and then click OK. 18. To save your settings and close the Simba ODBC Driver for Google BigQuery DSN Setup dialog box, click OK. 19. To close the ODBC Data Source Administrator, click OK. 10

11 Windows Driver Configuring Authentication on Windows The Simba ODBC Driver for Google BigQuery uses the OAuth 2.0 protocol for authentication and authorization. It authenticates your connection through Google OAuth APIs. You can configure the driver to provide your credentials and authenticate the connection to the database using one of the following methods: Using a Google User Account on page 11 Using a Google Service Account on page 13 Using a Google User Account You can configure the driver to authenticate the connection with a Google user account. This authentication method uses the OAuth 2.0 access and refresh tokens associated with the user account as the credentials. The access token is transmitted with every API call that the driver makes, and it is required for accessing BigQuery data stores. However, the access token expires after a certain amount of time and must be renewed using the refresh token. If the refresh token is stored in your connection information, the driver automatically uses it to renew access tokens when they expire. For more information about OAuth 2.0, see "Using OAuth 2.0 to Access Google APIs" in the Google Identity Platform documentation: At minimum, you need to provide the OAuth 2.0 refresh token associated with your account. The driver retrieves and uses an access token based on your specified refresh token. If you do not have your refresh token, see Retrieving a Refresh Token on page 11. If you already have your refresh token, see Providing a Refresh Token on page 12. If you want to provide a.json key file that contains your credentials instead of providing your refresh token directly in your connection information, see Providing a Key File on page 12. Retrieving a Refresh Token When you authenticate your connection this way, the authentication process provides a temporary confirmation code that you can exchange for an access token and a refresh token. 11

12 Windows Driver To configure user account authentication by retrieving a refresh token on Windows: 1. To access authentication options, open the ODBC Data Source Administrator where you created the DSN, then select the DSN, and then click Configure. 2. From the OAuth Mechanism drop-down list, select User Authentication. 3. Click Sign In. 4. In the browser that opens, type your credentials for accessing your BigQuery data and sign in to your account. 5. When you are prompted to allow BigQuery Client Tools to access your data in Google BigQuery, click Accept. The browser displays a confirmation code. 6. Copy and paste the code into the Confirmation Code field in the Simba ODBC Driver for Google BigQuery DSN Setup dialog box. 7. Click inside the Refresh Token field or press TAB to move your caret from the Confirmation Code field into the Refresh Token field. The driver automatically populates the field with your refresh token. The refresh token is used whenever the driver needs to access your BigQuery data. You can save the refresh token in the DSN so that you only need to generate it once. A confirmation code can only be used once. You must get a new confirmation code from Google whenever you need another refresh token. Providing a Refresh Token If you already have your refresh token, then you can provide the token in your connection information without going through the retrieval process described above. To configure user account authentication by providing a refresh token on Windows: 1. To access authentication options, open the ODBC Data Source Administrator where you created the DSN, then select the DSN, and then click Configure. 2. From the OAuth Mechanism drop-down list, select User Authentication. 3. In the Refresh Token field, type the refresh token associated with your user account. Providing a Key File As an alternative to providing your refresh token directly in your connection information, you can save the token in a.json key file and then specify the path to the 12

13 Windows Driver file in your connection information. The file must define a JSON object of type authorized_user containing the refresh token, client ID, and client secret associated with your user account. For example, the.json key file must be written in the following format: { } "type": "authorized_user", "client_id": "[YourClientID]", "client_secret":"[yourclientsecret]", "refresh_token":"[yourrefreshtoken]" To configure user account authentication by providing a key file on Windows: 1. To access authentication options, open the ODBC Data Source Administrator where you created the DSN, then select the DSN, and then click Configure. 2. From the OAuth Mechanism drop-down list, select Service Authentication. Although this is a form of user authentication, the key file must be provided using the service authentication options. 3. In the field, type your user account ID. 4. In the Key File Path field, type the full path to the.json key file. Using a Google Service Account You can configure the driver to authenticate the connection with a Google service account. When you authenticate your connection this way, the driver handles authentication on behalf of the service account, so that an individual user account is not directly involved and no user input is required. To authenticate your connection this way, you must provide a Google service account address and the full path to a private key file for the service account. You can generate and download the private key file when you set up the service account. 13

14 Windows Driver For more information about OAuth 2.0 authentication using a service account, see "Using OAuth 2.0 for Server to Server Applications" in the Google Identity Platform documentation: For information about obtaining service account keys, see "Creating and Managing Service Account Keys" in the Google Cloud Identity & Access Management documentation: To configure service account authentication on Windows: 1. To access authentication options, open the ODBC Data Source Administrator where you created the DSN, then select the DSN, and then click Configure. 2. From the OAuth Mechanism drop-down list, select Service Authentication. 3. In the field, type your service account ID. 4. In the Key File Path field, type the full path to the.p12 or.json key file that is used to authenticate the service account ID. Configuring a Proxy Server on Windows If you are connecting to the data source through a proxy server, you must provide connection information for the proxy server. To configure a proxy server on Windows: 1. To access proxy server options, open the ODBC Data Source Administrator where you created the DSN, then select the DSN, then click Configure, and then click Proxy Options. 2. Select the Use Proxy Server check box. 3. In the Proxy Host field, type the host name or IP address of the proxy server. 4. In the Proxy Port field, type the number of the TCP port that the proxy server uses to listen for client connections. 5. In the Proxy Username field, type your user name for accessing the proxy server. 6. In the Proxy Password field, type the password corresponding to the user name. 7. To save your settings and close the Proxy Options dialog box, click OK. Configuring Advanced Options on Windows You can configure advanced options to modify the behavior of the driver. 14

15 Windows Driver To configure advanced options on Windows: 1. To access advanced options, open the ODBC Data Source Administrator where you created the DSN, then select the DSN, then click Configure, and then click Advanced Options. 2. In the Rows Per Block field, type the maximum number of rows to fetch for each data request. 3. In the Default String Column Length field, type the maximum number of characters that can be contained in STRING columns. 4. In the Dataset Name For Large Result Sets field, type the ID of the BigQuery dataset that you want to use to store temporary tables. The dataset created from the default ID is hidden. This option is available only if the Allow Large Result Sets check box is selected. 5. In the Temporary Table Expiration Time field, type the length of time (in milliseconds) for which a temporary table exists. This option is available only if the Allow Large Result Sets check box is selected. 6. From the Language Dialect drop-down list, select the SQL syntax to use when executing queries: To use standard SQL syntax, select Standard SQL. Or, to use the legacy BigQuery SQL syntax, select Legacy SQL. 7. To use a customer-managed encryption key (CMEK) when executing queries, in the Path To CMEK field, type the resource ID of the CMEK. For more information, see "Protecting Data with Cloud KMS Keys" in the Google BigQuery documentation: Important: Do not specify a CMEK unless you are certain that it is the correct value to use. If you execute an INSERT statement with an incorrect CMEK, the driver returns an error or corrupts the table. The driver uses the specified CMEK for all queries. 8. To allow query results that are larger than 128MB in size, select the Allow Large Result Sets check box. 9. To return data as SQL_WVARCHAR data instead of SQL_VARCHAR data, select the Use SQL_WVARCHAR Instead Of SQL_VARCHAR check box. 15

16 Windows Driver This option applies only to result set columns that the driver would normally return as SQL_VARCHAR columns. It does not convert all columns into SQL_WVARCHAR. 10. To access public projects and use them as catalogs for the connection, in the Additional Projects field, type a comma-separated list of project names. 11. To save your settings and close the Advanced Options dialog box, click OK. Configuring Logging Options on Windows To help troubleshoot issues, you can enable logging. In addition to functionality provided in the Simba ODBC Driver for Google BigQuery, the ODBC Data Source Administrator provides tracing functionality. Important: Only enable logging or tracing long enough to capture an issue. Logging or tracing decreases performance and can consume a large quantity of disk space. The settings for logging apply to every connection that uses the Simba ODBC Driver for Google BigQuery, so make sure to disable the feature after you are done using it. To enable driver logging on Windows: 1. To access logging options, open the ODBC Data Source Administrator where you created the DSN, then select the DSN, then click Configure, and then click Logging Options. 2. From the Log Level drop-down list, select the logging level corresponding to the amount of information that you want to include in log files: Logging Level Description OFF FATAL ERROR Disables all logging. Logs severe error events that lead the driver to abort. Logs error events that might allow the driver to continue running. 16

17 Windows Driver Logging Level WARNING INFO DEBUG TRACE Description Logs events that might result in an error if action is not taken. Logs general information that describes the progress of the driver. Logs detailed information that is useful for debugging the driver. Logs all driver activity. 3. In the Log Path field, specify the full path to the folder where you want to save log files. You can type the path into the field, or click Browse and then browse to select the folder. 4. In the Max Number Files field, type the maximum number of log files to keep. After the maximum number of log files is reached, each time an additional file is created, the driver deletes the oldest log file. 5. In the Max File Size field, type the maximum size of each log file in megabytes (MB). After the maximum file size is reached, the driver creates a new file and continues logging. 6. Click OK. 7. Restart your ODBC application to make sure that the new settings take effect. The Simba ODBC Driver for Google BigQuery produces the following log files at the location you specify in the Log Path field: A simbabigqueryodbcdriver.log file that logs driver activity that is not specific to a connection. A simbabigqueryodbcdriver_connection_[number].log file for each connection made to the database, where [Number] is a number that identifies each log file. This file logs driver activity that is specific to the connection. 17

18 Windows Driver To disable driver logging on Windows: 1. Open the ODBC Data Source Administrator where you created the DSN, then select the DSN, then click Configure, and then click Logging Options. 2. From the Log Level drop-down list, select LOG_OFF. 3. Click OK. 4. Restart your ODBC application to make sure that the new settings take effect. Verifying the Driver Version Number on Windows If you need to verify the version of the Simba ODBC Driver for Google BigQuery that is installed on your Windows machine, you can find the version number in the ODBC Data Source Administrator. To verify the driver version number on Windows: 1. From the Start menu, go to ODBC Data Sources. Make sure to select the ODBC Data Source Administrator that has the same bitness as the client application that you are using to connect to BigQuery. 2. Click the Drivers tab and then find the Simba ODBC Driver for Google BigQuery in the list of ODBC drivers that are installed on your system. The version number is displayed in the Version column. 18

19 macos Driver macos Driver macos System Requirements Install the driver on client machines where the application is installed. Each client machine that you install the driver on must meet the following minimum system requirements: macos version 10.12, 10.13, or MB of available disk space iodbc , , , or Installing the Driver on macos The Simba ODBC Driver for Google BigQuery is available for macos as a.dmg file named SimbaODBCDriverforGoogleBigQuery.dmg. The driver supports both 32- and 64-bit client applications. To install the Simba ODBC Driver for Google BigQuery on macos: 1. Double-click SimbaODBCDriverforGoogleBigQuery.dmg to mount the disk image. 2. Double-click SimbaODBCDriverforGoogleBigQuery.pkg to run the installer. 3. In the installer, click Continue. 4. On the Software License Agreement screen, click Continue, and when the prompt appears, click Agree if you agree to the terms of the License Agreement. 5. Optionally, to change the installation location, click Change Install Location, then select the desired location, and then click Continue. By default, the driver files are installed in the /Library/simba/googlebigqueryodbc directory. 6. To accept the installation location and begin the installation, click Install. 7. When the installation completes, click Close. 8. If you received a license file through , then copy the license file into the /lib subfolder in the driver installation directory. You must have root privileges when changing the contents of this folder. For example, if you installed the driver to the default location, you would copy the license file into the/library/simba/googlebigqueryodbc/lib folder. 19

20 macos Driver Next, configure the environment variables on your machine to make sure that the ODBC driver manager can work with the driver. For more information, see Configuring the ODBC Driver Manager on Non-Windows Machines on page 24. Verifying the Driver Version Number on macos If you need to verify the version of the Simba ODBC Driver for Google BigQuery that is installed on your macos machine, you can query the version number through the Terminal. To verify the driver version number on macos: At the Terminal, run the following command: pkgutil --info com.simba.googlebigqueryodbc The command returns information about the Simba ODBC Driver for Google BigQuery that is installed on your machine, including the version number. 20

21 Linux Driver Linux Driver The Linux driver is available as an RPM file and as a tarball package. Linux System Requirements Install the driver on client machines where the application is installed. Each client machine that you install the driver on must meet the following minimum system requirements: One of the following distributions: o Red Hat Enterprise Linux (RHEL) 6 or 7 o CentOS 6 or 7 o SUSE Linux Enterprise Server (SLES) 11 or 12 o Debian 8 or 9 o Ubuntu 14.04, 16.04, or MB of available disk space One of the following ODBC driver managers installed: o iodbc , , , or o unixodbc 2.3.2, 2.3.3, or To install the driver, you must have root access on the machine. Installing the Driver Using the RPM File On 64-bit editions of Linux, you can execute both 32- and 64-bit applications. However, 64-bit applications must use 64-bit drivers, and 32-bit applications must use 32-bit drivers. Make sure that you use a driver whose bitness matches the bitness of the client application: simbagooglebigquery-[version]-[release].i686.rpm for the 32-bit driver simbagooglebigquery-[version]-[release].x86_64.rpm for the 64-bit driver The placeholders in the file names are defined as follows: [Version] is the version number of the driver. [Release] is the release number for this version of the driver. You can install both the 32-bit and 64-bit versions of the driver on the same machine. 21

22 Linux Driver To install the Simba ODBC Driver for Google BigQuery using the RPM File: 1. Log in as the root user. 2. Navigate to the folder containing the RPM package for the driver. 3. Depending on the Linux distribution that you are using, run one of the following commands from the command line, where [RPMFileName] is the file name of the RPM package: If you are using Red Hat Enterprise Linux or CentOS, run the following command: yum --nogpgcheck localinstall [RPMFileName] Or, if you are using SUSE Linux Enterprise Server, run the following command: zypper install [RPMFileName] The Simba ODBC Driver for Google BigQuery files are installed in the /opt/simba/googlebigqueryodbc directory. 4. If you received a license file through , then copy the license file into the /opt/simba/googlebigqueryodbc/lib/32 or /opt/simba/googlebigqueryodbc/lib/64 folder, depending on the version of the driver that you installed. You must have root privileges when changing the contents of this folder. Next, configure the environment variables on your machine to make sure that the ODBC driver manager can work with the driver. For more information, see Configuring the ODBC Driver Manager on Non-Windows Machines on page 24. Installing the Driver Using the Tarball Package The Simba ODBC Driver for Google BigQuery is available as a tarball package named SimbaODBCDriverforGoogleBigQuery_[Version].[Release]- Linux.tar.gz, where [Version] is the version number of the driver and [Release] is the release number for this version of the driver. The package contains both the 32-bit and 64-bit versions of the driver. On 64-bit editions of Linux, you can execute both 32- and 64-bit applications. However, 64-bit applications must use 64-bit drivers, and 32-bit applications must use 32-bit drivers. Make sure that you use a driver whose bitness matches the bitness of the client application. You can install both versions of the driver on the same machine. 22

23 Linux Driver To install the driver using the tarball package: 1. Log in as the root user, and then navigate to the folder containing the tarball package. 2. Run the following command to extract the package and install the driver: tar --directory=/opt -zxvf [TarballName] Where [TarballName] is the name of the tarball package containing the driver. The Simba ODBC Driver for Google BigQuery files are installed in the opt/simba/googlebigqueryodbc directory. 3. If you received a license file through , then copy the license file into the opt/simba/googlebigqueryodbc/lib/32 or opt/simba/googlebigqueryodbc/lib/64 folder, depending on the version of the driver that you installed. You must have root privileges when changing the contents of this folder. Next, configure the environment variables on your machine to make sure that the ODBC driver manager can work with the driver. For more information, see Configuring the ODBC Driver Manager on Non-Windows Machines on page 24. Verifying the Driver Version Number on Linux If you need to verify the version of the Simba ODBC Driver for Google BigQuery that is installed on your Linux machine, you can query the version number through the command-line interface if the driver was installed using an RPM file. To verify the driver version number on Linux: Depending on your package manager, at the command prompt, run one of the following commands: yum list 'Simba*' grep SimbaODBCDriverforGoogleBigQuery rpm -qa grep SimbaODBCDriverforGoogleBigQuery The command returns information about the Simba ODBC Driver for Google BigQuery that is installed on your machine, including the version number. 23

24 Configuring the ODBC Driver Manager on Non-Windows Machines Configuring the ODBC Driver Manager on Non- Windows Machines To make sure that the ODBC driver manager on your machine is configured to work with the Simba ODBC Driver for Google BigQuery, do the following: Set the library path environment variable to make sure that your machine uses the correct ODBC driver manager. For more information, see Specifying ODBC Driver Managers on Non-Windows Machines on page 24. If the driver configuration files are not stored in the default locations expected by the ODBC driver manager, then set environment variables to make sure that the driver manager locates and uses those files. For more information, see Specifying the Locations of the Driver Configuration Files on page 25. After configuring the ODBC driver manager, you can configure a connection and access your data store through the driver. For more information, see Configuring ODBC Connections on a Non-Windows Machine on page 27. Specifying ODBC Driver Managers on Non- Windows Machines You need to make sure that your machine uses the correct ODBC driver manager to load the driver. To do this, set the library path environment variable. macos If you are using a macos machine, then set the DYLD_LIBRARY_PATH environment variable to include the paths to the ODBC driver manager libraries. For example, if the libraries are installed in /usr/local/lib, then run the following command to set DYLD_LIBRARY_PATH for the current user session: export DYLD_LIBRARY_PATH=$DYLD_LIBRARY_PATH:/usr/local/lib For information about setting an environment variable permanently, refer to the macos shell documentation. Linux If you are using a Linux machine, then set the LD_LIBRARY_PATH environment variable to include the paths to the ODBC driver manager libraries. For example, if the libraries are installed in /usr/local/lib, then run the following command to set LD_LIBRARY_PATH for the current user session: 24

25 Configuring the ODBC Driver Manager on Non-Windows Machines export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/usr/local/lib For information about setting an environment variable permanently, refer to the Linux shell documentation. Specifying the Locations of the Driver Configuration Files By default, ODBC driver managers are configured to use hidden versions of the odbc.ini and odbcinst.ini configuration files (named.odbc.ini and.odbcinst.ini) located in the home directory, as well as the simba.googlebigqueryodbc.ini file in the lib subfolder of the driver installation directory. If you store these configuration files elsewhere, then you must set the environment variables described below so that the driver manager can locate the files. If you are using iodbc, do the following: Set ODBCINI to the full path and file name of the odbc.ini file. Set ODBCINSTINI to the full path and file name of the odbcinst.ini file. Set SIMBAGOOGLEBIGQUERYODBCINI to the full path and file name of the simba.googlebigqueryodbc.ini file. If you are using unixodbc, do the following: Set ODBCINI to the full path and file name of the odbc.ini file. Set ODBCSYSINI to the full path of the directory that contains the odbcinst.ini file. Set SIMBAGOOGLEBIGQUERYODBCINI to the full path and file name of the simba.googlebigqueryodbc.ini file. For example, if your odbc.ini and odbcinst.ini files are located in /usr/local/odbc and your simba.googlebigqueryodbc.ini file is located in /etc, then set the environment variables as follows: For iodbc: export ODBCINI=/usr/local/odbc/odbc.ini export ODBCINSTINI=/usr/local/odbc/odbcinst.ini export SIMBAGOOGLEBIGQUERYODBCINI=/etc/simba.googlebigqueryodbc.ini For unixodbc: 25

26 Configuring the ODBC Driver Manager on Non-Windows Machines export ODBCINI=/usr/local/odbc/odbc.ini export ODBCSYSINI=/usr/local/odbc export SIMBAGOOGLEBIGQUERYODBCINI=/etc/simba.googlebigqueryodbc.ini To locate the simba.googlebigqueryodbc.ini file, the driver uses the following search order: 1. If the SIMBAGOOGLEBIGQUERYODBCINI environment variable is defined, then the driver searches for the file specified by the environment variable. 2. The driver searches the directory that contains the driver library files for a file named simba.googlebigqueryodbc.ini. 3. The driver searches the current working directory of the application for a file named simba.googlebigqueryodbc.ini. 4. The driver searches the home directory for a hidden file named.simba.googlebigqueryodbc.ini (prefixed with a period). 5. The driver searches the /etc directory for a file named simba.googlebigqueryodbc.ini. 26

27 Configuring ODBC Connections on a Non-Windows Machine Configuring ODBC Connections on a Non- Windows Machine The following sections describe how to configure ODBC connections when using the Simba ODBC Driver for Google BigQuery on non-windows platforms: Creating a Data Source Name on a Non-Windows Machine on page 27 Configuring a DSN-less Connection on a Non-Windows Machine on page 29 Configuring Authentication on a Non-Windows Machine on page 32 Configuring Logging Options on a Non-Windows Machine on page 36 Testing the Connection on a Non-Windows Machine on page 37 Creating a Data Source Name on a Non-Windows Machine When connecting to your data store using a DSN, you only need to configure the odbc.ini file. Set the properties in the odbc.ini file to create a DSN that specifies the connection information for your data store. For information about configuring a DSN-less connection instead, see Configuring a DSN-less Connection on a Non- Windows Machine on page 29. If your machine is already configured to use an existing odbc.ini file, then update that file by adding the settings described below. Otherwise, copy the odbc.ini file from the Setup subfolder in the driver installation directory to the home directory, and then update the file as described below. To create a Data Source Name on a non-windows machine: 1. In a text editor, open the odbc.ini configuration file. If you are using a hidden copy of the odbc.ini file, you can remove the period (.) from the start of the file name to make the file visible while you are editing it. 2. In the [ODBC Data Sources] section, add a new entry by typing a name for the DSN, an equal sign (=), and then the name of the driver. For example, on a macos machine: [ODBC Data Sources] 27

28 Configuring ODBC Connections on a Non-Windows Machine Sample DSN=Simba ODBC Driver for Google BigQuery As another example, for a 32-bit driver on a Linux machine: [ODBC Data Sources] Sample DSN=Simba ODBC Driver for Google BigQuery 32-bit 3. Create a section that has the same name as your DSN, and then specify configuration options as key-value pairs in the section: a. Set the Driver property to the full path of the driver library file that matches the bitness of the application. For example, on a macos machine: Driver=/Library/simba/googlebigqueryodbc/lib/libgoog lebigqueryodbc_sbu.dylib As another example, for a 32-bit driver on a Linux machine: Driver=/opt/simba/googlebigqueryodbc/lib/32/libgoogl ebigqueryodbc_sb32.so b. Set the Catalog property to the name of your BigQuery project. This project is the default project that the Simba ODBC Driver for Google BigQuery queries against, and also the project that is billed for queries that are run using this DSN. For example: Catalog=testdata c. Configure authentication using a Google user account or a Google service account. For more information, see Configuring Authentication on a Non- Windows Machine on page 32. d. Optionally, to use trusted CA certificates from a.pem file other than the default file installed with the driver, set the TrustedCerts property to the full path of the file. e. Optionally, to allow the driver to access Google Drive so that it can support federated tables that combine BigQuery data with data from Google Drive, set the RequestGoogleDriveScope property to 1. f. Optionally, set additional key-value pairs as needed to specify other optional connection settings. For detailed information about all the configuration options supported by the Simba ODBC Driver for Google BigQuery, see Driver Configuration Options on page Save the odbc.ini configuration file. 28

29 Configuring ODBC Connections on a Non-Windows Machine If you are storing this file in its default location in the home directory, then prefix the file name with a period (.) so that the file becomes hidden. If you are storing this file in another location, then save it as a non-hidden file (without the prefix), and make sure that the ODBCINI environment variable specifies the location. For more information, see Specifying the Locations of the Driver Configuration Files on page 25. For example, the following is an odbc.ini configuration file for macos containing a DSN that connects to Google BigQuery using a refresh token obtained from a user account: [ODBC Data Sources] Sample DSN=Simba ODBC Driver for Google BigQuery [Sample DSN] Driver=/Library/simba/googlebigqueryodbc/lib/libgooglebigque ryodbc_sbu.dylib Catalog=testdata OAuthMechanism=1 RefreshToken=CH01pcNn/qFcYwUlJpkF_yyufYrqj4O4g7cdXvGgs-zT6 As another example, the following is an odbc.ini configuration file for a 32-bit driver on a Linux machine, containing a DSN that connects to Google BigQuery using a refresh token obtained from a user account: [ODBC Data Sources] Sample DSN=Simba ODBC Driver for Google BigQuery 32-bit [Sample DSN] Driver=/opt/simba/googlebigqueryodbc/lib/32/libgooglebigquer yodbc_sb32.so Catalog=testdata OAuthMechanism=1 RefreshToken=CH01pcNn/qFcYwUlJpkF_yyufYrqj4O4g7cdXvGgs-zT6 You can now use the DSN in an application to connect to the data store. Configuring a DSN-less Connection on a Non- Windows Machine To connect to your data store through a DSN-less connection, you need to define the driver in the odbcinst.ini file and then provide a DSN-less connection string in your application. 29

30 Configuring ODBC Connections on a Non-Windows Machine If your machine is already configured to use an existing odbcinst.ini file, then update that file by adding the settings described below. Otherwise, copy the odbcinst.ini file from the Setup subfolder in the driver installation directory to the home directory, and then update the file as described below. To define a driver on a non-windows machine: 1. In a text editor, open the odbcinst.ini configuration file. If you are using a hidden copy of the odbcinst.ini file, you can remove the period (.) from the start of the file name to make the file visible while you are editing it. 2. In the [ODBC Drivers] section, add a new entry by typing a name for the driver, an equal sign (=), and then Installed. For example: [ODBC Drivers] Simba ODBC Driver for Google BigQuery=Installed 3. Create a section that has the same name as the driver (as specified in the previous step), and then specify the following configuration options as key-value pairs in the section: a. Set the Driver property to the full path of the driver library file that matches the bitness of the application. For example, on a macos machine: Driver=/Library/simba/googlebigqueryodbc/lib/libgoog lebigqueryodbc_sbu.dylib As another example, for a 32-bit driver on a Linux machine: Driver=/opt/simba/googlebigqueryodbc/lib/32/libgoogl ebigqueryodbc_sb32.so b. Optionally, set the Description property to a description of the driver. For example: Description=Simba ODBC Driver for Google BigQuery 4. Save the odbcinst.ini configuration file. 30

31 Configuring ODBC Connections on a Non-Windows Machine If you are storing this file in its default location in the home directory, then prefix the file name with a period (.) so that the file becomes hidden. If you are storing this file in another location, then save it as a non-hidden file (without the prefix), and make sure that the ODBCINSTINI or ODBCSYSINI environment variable specifies the location. For more information, see Specifying the Locations of the Driver Configuration Files on page 25. For example, the following is an odbcinst.ini configuration file for macos: [ODBC Drivers] Simba ODBC Driver for Google BigQuery=Installed [Simba ODBC Driver for Google BigQuery] Description=Simba ODBC Driver for Google BigQuery Driver=/Library/simba/googlebigqueryodbc/lib/libgooglebigque ryodbc_sbu.dylib As another example, the following is an odbcinst.ini configuration file for both the 32- and 64-bit drivers on Linux: [ODBC Drivers] Simba ODBC Driver for Google BigQuery 32-bit=Installed Simba ODBC Driver for Google BigQuery 64-bit=Installed [Simba ODBC Driver for Google BigQuery 32-bit] Description=Simba ODBC Driver for Google BigQuery (32-bit) Driver=/opt/simba/googlebigqueryodbc/lib/32/libgooglebigquer yodbc_sb32.so [Simba ODBC Driver for Google BigQuery 64-bit] Description=Simba ODBC Driver for Google BigQuery (64-bit) Driver=/opt/simba/googlebigqueryodbc/lib/64/libgooglebigquer yodbc_sb64.so You can now connect to your data store by providing your application with a connection string where the Driver property is set to the driver name specified in the odbcinst.ini file, and all the other necessary connection properties are also set. For more information, see "DSN-less Connection String Examples" in Using a Connection String on page 40. For instructions about configuring authentication, see Configuring Authentication on a Non-Windows Machine on page 32. For detailed information about all the connection properties that the driver supports, see Driver Configuration Options on page

32 Configuring ODBC Connections on a Non-Windows Machine Configuring Authentication on a Non-Windows Machine The Simba ODBC Driver for Google BigQuery uses the OAuth 2.0 protocol for authentication and authorization. It authenticates your connection through Google OAuth APIs. You can configure the driver to provide your credentials and authenticate the connection to the database using one of the following methods: Using a Google User Account on page 32 Using a Google Service Account on page 35 Using a Google User Account You can configure the driver to authenticate the connection with a Google user account. This authentication method uses the OAuth 2.0 access and refresh tokens associated with the user account as the credentials. The access token is transmitted with every API call that the driver makes, and it is required for accessing BigQuery data stores. However, the access token expires after a certain amount of time and must be renewed using the refresh token. If the refresh token is stored in the DSN, the driver automatically uses it to renew access tokens when they expire. For more information about OAuth 2.0, see "Using OAuth 2.0 to Access Google APIs" in the Google Identity Platform documentation: At minimum, you need to provide the OAuth 2.0 refresh token associated with your account. The driver retrieves and uses an access token based on your specified refresh token. If you do not have your refresh token, see Retrieving a Refresh Token on page 32. If you have your refresh token, see Providing a Refresh Token on page 34. If you want to provide a.json key file that contains your credentials instead of providing your refresh token directly in your connection information, see Providing a Key File on page 34. Retrieving a Refresh Token When you authenticate your connection this way, the authentication process provides a temporary authorization code that you can exchange for an access token and a refresh token. 32

33 Configuring ODBC Connections on a Non-Windows Machine You can retrieve a refresh token by providing your own credentials, or by using a script that uses Simba-provided credentials. If you use your credentials to generate a refresh token, you cannot use it in conjunction with the Simba-provided credentials. Conversely, if you use a refresh token generated with the Simba-provided credentials, it cannot be used in conjunction with your user credentials. To configure authentication by retrieving a refresh token using Simba-provided credentials on a non-windows machine: 1. In the [INSTALL_DIR]/Tools directory, right-click get_refresh_ token.sh and select Edit. 2. From the internal commented section, copy the entire authentication generator URL. 3. In a web browser, navigate to the URL you copied in the previous step. 4. Click Allow. The browser redirects you to a page with an authentication token. 5. Copy the authentication token. 6. Using a command line interface, run get_refresh_token.sh with your copied authentication token added as the argument to the script. The script generates a refresh token. Now that you have a refresh token, see Providing a Refresh Token on page 34. To configure user account authentication by retrieving a refresh token on a non- Windows machine: 1. Obtain a refresh token based on your user account: a. In a web browser, navigate to the Google OAuth 2.0 Playground: b. In the side panel, expand BigQuery API v2 and select the appropriate scope for the permissions that you need. For information about the permissions associated with each scope, see "OAuth 2.0 Scopes for Google APIs" in the Google Identity Platform documentation: