progress datadirect for jdbc for google bigquery quick start · and ibm sdk (java) distributions....

22
Progress DataDirect ® for JDBC for Google BigQuery Quick Start Release 6.0.0

Upload: others

Post on 29-May-2020

42 views

Category:

Documents


0 download

TRANSCRIPT

Page 1: Progress DataDirect for JDBC for Google BigQuery Quick Start · and IBM SDK (Java) distributions. Supported Data Sources: • Google BigQuery Downloading the driver To download the

Progress DataDirect® forJDBC for Google BigQuery™

Quick Start

Release 6.0.0

Page 2: Progress DataDirect for JDBC for Google BigQuery Quick Start · and IBM SDK (Java) distributions. Supported Data Sources: • Google BigQuery Downloading the driver To download the
Page 3: Progress DataDirect for JDBC for Google BigQuery Quick Start · and IBM SDK (Java) distributions. Supported Data Sources: • Google BigQuery Downloading the driver To download the

Copyright

© 2020 Progress Software Corporation and/or its subsidiaries or affiliates. All rightsreserved.These materials and all Progress® software products are copyrighted and all rights are reserved by ProgressSoftware Corporation. The information in these materials is subject to change without notice, and ProgressSoftware Corporation assumes no responsibility for any errors that may appear therein. The references inthese materials to specific platforms supported are subject to change.

Corticon, DataDirect (and design), DataDirect Cloud, DataDirect Connect, DataDirect Connect64, DataDirectXML Converters, DataDirect XQuery, DataRPM, Defrag This, Deliver More Than Expected, Icenium, Ipswitch,iMacros, Kendo UI, Kinvey, MessageWay, MOVEit, NativeChat, NativeScript, OpenEdge, Powered by Progress,Progress, Progress Software Developers Network, SequeLink, Sitefinity (and Design), Sitefinity, SpeedScript,Stylus Studio, TeamPulse, Telerik, Telerik (and Design), Test Studio, WebSpeed, WhatsConfigured,WhatsConnected, WhatsUp, and WS_FTP are registered trademarks of Progress Software Corporation or oneof its affiliates or subsidiaries in the U.S. and/or other countries. Analytics360, AppServer, BusinessEdge,DataDirect Autonomous REST Connector, DataDirect Spy, SupportLink, DevCraft, Fiddler, iMail, JustAssembly,JustDecompile, JustMock, NativeScript Sidekick, OpenAccess, ProDataSet, Progress Results, ProgressSoftware, ProVision, PSE Pro, SmartBrowser, SmartComponent, SmartDataBrowser, SmartDataObjects,SmartDataView, SmartDialog, SmartFolder, SmartFrame, SmartObjects, SmartPanel, SmartQuery, SmartViewer,SmartWindow, and WebClient are trademarks or service marks of Progress Software Corporation and/or itssubsidiaries or affiliates in the U.S. and other countries. Java is a registered trademark of Oracle and/or itsaffiliates. Any other marks contained herein may be trademarks of their respective owners.

Updated: 2020/02/07

3Progress DataDirect for JDBC for Google BigQuery Driver: Quick Start: Version 6.0.0

Page 4: Progress DataDirect for JDBC for Google BigQuery Quick Start · and IBM SDK (Java) distributions. Supported Data Sources: • Google BigQuery Downloading the driver To download the

Progress DataDirect for JDBC for Google BigQuery Driver: Quick Start: Version 6.0.04

Copyright

Page 5: Progress DataDirect for JDBC for Google BigQuery Quick Start · and IBM SDK (Java) distributions. Supported Data Sources: • Google BigQuery Downloading the driver To download the

Quick Start: Progress DataDirect for JDBCfor Google BigQuery Driver

This quick start provides basic information that allows you to install, test, and tune your driver. To take fulladvantage of the features and functionality available for your driver, refer to the Progress DataDirectDocumentation Library library.

If you are already familiar with DataDirect drivers, you can begin using the driver immediately with the followinginformation:

• Driver and data source classes

• Connection URL format

Note: OEM CUSTOMERS: Refer to the Progress DataDirect for JDBC Drivers Distribution Guide for informationon installing, branding, unlocking, and distributing your branded drivers.

This quick start covers the following topics:

• Before you start on page 5

• Requirements and support on page 6

• Downloading the driver on page 6

• Installing the JDBC driver on page 7

• Setting the classpath on page 9

• Driver and DataSource classes on page 9

• Using connection properties on page 9

• Connecting to a DataSource on page 10

• Tuning for performance on page 18

• Troubleshooting setup/connection issues on page 19

• Additional resources on page 20

Before you startBefore you get started, you need the following:

• Appropriate user permissions to modify your environment and to read, write, and execute various files inthe DataDirect for JDBC installation directory.

• The connection information required when the default authentication method, OAuth 2.0, is used forauthentication:

• Project: The name of the project that you want the driver to connect to.The projects in Google BigQueryare equivalent to catalogs in JDBC.

5Progress DataDirect for JDBC for Google BigQuery Driver: Quick Start: Version 6.0.0

Page 6: Progress DataDirect for JDBC for Google BigQuery Quick Start · and IBM SDK (Java) distributions. Supported Data Sources: • Google BigQuery Downloading the driver To download the

• Dataset:The name of the dataset that you want the driver to connect to.The datasets in Google BigQueryare equivalent to schemas in JDBC.

• Access Token: The access token used to connect to your Google BigQuery instance.

• Refresh Token: The refresh token used to either request a new access token or renew an expiredaccess token.

• Client ID: The consumer key used to connect to your Google BigQuery instance.

• Client Secret: The consumer secret used to connect to your Google BigQuery instance.

• For licensed installations, you will also need the following information that was provided by ProgressDataDirect:

• Control Number

• Serial Number

Requirements and supportSoftware Requirements:

• The driver requires a Java Virtual Machine (JVM) that is Java SE 8 or higher, including Oracle JDK, OpenJDK,and IBM SDK (Java) distributions.

Supported Data Sources:

• Google BigQuery

Downloading the driverTo download the JDBC Google BigQuery driver:

1. Visit the Progress DataDirect Connectors Download page.

2. Select Google BigQuery from the data source list.

3. Select JDBC for the interface.

4. Select your OS when prompted for your OS and architecture.

5. Fill in the registration form with your contact information.

6. Review the End User License Agreement. If you agree, select the corresponding box; then, click Download.

The installer program has been downloaded. See "Installing the JDBC Driver" for detailed instructions.

See alsoInstalling the JDBC driver on page 7

Progress DataDirect for JDBC for Google BigQuery Driver: Quick Start: Version 6.0.06

Chapter 1: Quick Start: Progress DataDirect for JDBC for Google BigQuery Driver

Page 7: Progress DataDirect for JDBC for Google BigQuery Quick Start · and IBM SDK (Java) distributions. Supported Data Sources: • Google BigQuery Downloading the driver To download the

Installing the JDBC driverThis section provides instructions for installing your downloaded files using the GUI installer.

Note: OEM CUSTOMERS: Refer to the Progress DataDirect for JDBC Drivers Distribution Guide for informationon installing, branding, unlocking, and distributing your branded drivers.

Note: Make sure that the Java Virtual Machine (JVM) is defined on your path. Java SE 8 or higher is requiredto use the driver.

1. Unzip the files to a temporary directory, maintaining the directory structure of the zip file.

2. From the installer directory, run the appropriate installer file to start the installer.

• Windows: PROGRESS_DATADIRECT_JDBC_INSTALL.exe

• Non-Windows: PROGRESS_DATADIRECT_JDBC_INSTALL.jar

Important: The Java installer can be run on most platforms, including Windows; however, if you run theJava installer on Windows, turn off User Account Controls or select a non-system directory as the installationdirectory. The Windows installer allows you to install the driver in the Program Files system directory onWindows without turning off User Account Controls.

3. The Introduction window appears. Click Next.

4. The License Agreement window appears. Make sure that you read and understand the license agreement.To continue with the installation, select the I accept the terms in the License Agreement option; then,click Next.

5. The Install Directory window appears. In the Where Would You Like to Install? field, type the path, includingthe drive letter, of the product installation directory or click the Choose button to browse to and select aninstallation directory. Verify the installation directory. Click Next to continue.

6. Choose the type of installation to perform. Select one of the following options.

• Evaluation installation (will expire in 15 days). Select this option to install evaluation versions of allavailable drivers. Click Next to continue with the installation. Skip to Step 10 on page 8.

• OEM or Licensed installation. Select this option if you have purchased a licensed version of one ormultiple drivers. Click Next. If you are updating a currently installed driver, skip to Step 8 on page 8;otherwise, proceed to the next step.

7. Type the Control Number that was provided by Progress DataDirect in the Control # field, and click theValidate button.You can add multiple control numbers consecutively.

A tree menu of drivers with valid licenses appears in the selection box. For example, the following imagedemonstrates an Apache Cassandra installation.

7Progress DataDirect for JDBC for Google BigQuery Driver: Quick Start: Version 6.0.0

Installing the JDBC driver

Page 8: Progress DataDirect for JDBC for Google BigQuery Quick Start · and IBM SDK (Java) distributions. Supported Data Sources: • Google BigQuery Downloading the driver To download the

8. From the tree menu, select the drivers that you want to install. Click Next to continue.

Drivers that are already installed will be listed under Drivers (Installed) and cannot be deselected.To removeinstalled drivers, you must uninstall the product.

9. Enter name, company, and serial number in the fields provided. Click Next to continue.

a) Type your name and company name into the corresponding fields.

b) Type the serial number that was provided by Progress DataDirect.

10. The Pre-Installation Summary window appears. Review the installation information. Click Previous torevise selections; or click Install to begin the installation.

11. When the installation finishes, the Install Complete window appears. Click Done to exit the installer program.

Progress DataDirect for JDBC for Google BigQuery Driver: Quick Start: Version 6.0.08

Chapter 1: Quick Start: Progress DataDirect for JDBC for Google BigQuery Driver

Page 9: Progress DataDirect for JDBC for Google BigQuery Quick Start · and IBM SDK (Java) distributions. Supported Data Sources: • Google BigQuery Downloading the driver To download the

Setting the classpathThe driver must be defined on your CLASSPATH before you can connect. The class path is the search stringyour Java Virtual Machine (JVM) uses to locate JDBC drivers on your computer. If the driver is not defined onyour CLASSPATH, you will receive a class not found exception when trying to load the driver. Set yoursystem CLASSPATH to include the googlebigquery.jar file as shown, where install_dir is the pathto your product installation directory.

install_dir/lib/googlebigquery.jar

Windows Example

CLASSPATH=.;C:\Program Files\Progress\DataDirect\JDBC_60\lib\googlebigquery.jar

UNIX Example

CLASSPATH=.:/opt/Progress/DataDirect/JDBC_60/lib/googlebigquery.jar

Driver and DataSource classesThe following are the data source and driver classes used by the driver:

DataSource class:

com.ddtek.jdbcx.googlebigquery.GoogleBigQueryDataSource

Driver class:

com.ddtek.jdbc.googlebigquery.GoogleBigQueryDriver

Using connection propertiesYou can use connection properties to customize the driver for your environment.You can use these connectionproperties with either the JDBC Driver Manager or a JDBC DataSource. For a Driver Manager connection, aproperty is expressed as a key value pair and takes the form property=value. For a DataSource connection,a property is expressed as a JDBC method and takes the form setProperty(value). For a complete listof supported properties, refer to "Connection Property Descriptions" in the Progress DataDirect for JDBC forGoogle BigQuery Driver User's Guide

The following table summarizes the minimum connection properties required to connect to a database. For alist of properties that affect performance, see "Tuning for Performance."

Note: All connection property names are case-insensitive. For example, AccessToken is the same asaccesstoken. Required properties are noted as such.

Note: The data type listed for each connection property is the Java data type used for the property value in aJDBC DataSource.

9Progress DataDirect for JDBC for Google BigQuery Driver: Quick Start: Version 6.0.0

Setting the classpath

Page 10: Progress DataDirect for JDBC for Google BigQuery Quick Start · and IBM SDK (Java) distributions. Supported Data Sources: • Google BigQuery Downloading the driver To download the

Table 1: Required Properties

CharacteristicProperty

Specifies the name of the project that you want the driver to connect to.The projectsin Google BigQuery are equivalent to catalogs in JDBC.

Project

Specifies the name of the dataset that you want the driver to connect to. Thedatasets in Google BigQuery are equivalent to schemas in JDBC.

Dataset

Specifies the access token used to authenticate to a Google BigQuery instance.AccessToken

Specifies the refresh token used to either request a new access token or renewan expired access token. If an access token is not provided or expires at the timeof connection, the access token generated using refresh token is used toauthenticate to a Google BigQuery instance.

RefreshToken

Specifies the consumer key for your application. The driver uses this value whenauthenticating to a Google BigQuery instance.

ClientID

Specifies the consumer secret for your application.The driver uses this value whenauthenticating to a Google BigQuery instance.

ClientSecret

See alsoConnecting using the JDBC Driver Manager on page 10Connecting using data sources on page 14Tuning for performance on page 18

Connecting to a DataSourceOnce the driver is installed and configured, you can connect from your application to your database in eitherof the following ways.

• Using the JDBC DriverManager, by specifying the connection URL in theDriverManager.getConnection() method.

• Creating a JDBC data source that can be accessed through the Java Naming Directory Interface (JNDI).

Connecting using the JDBC Driver Manager

One way to connect to a Google BigQuery instance is through the JDBC DriverManager using theDriverManager.getConnection() method. As the following example shows, this method specifies a stringcontaining a connection URL.

Connection conn = DriverManager.getConnection ("jdbc:datadirect:googlebigquery:Project=myproject;Dataset=mydataset;AccessToken=abcdefghi12345678;RefreshToken=wxyz123456789;ClientID=123abc.apps.googleusercontent.com;ClientSecret=ab123xy");

Progress DataDirect for JDBC for Google BigQuery Driver: Quick Start: Version 6.0.010

Chapter 1: Quick Start: Progress DataDirect for JDBC for Google BigQuery Driver

Page 11: Progress DataDirect for JDBC for Google BigQuery Quick Start · and IBM SDK (Java) distributions. Supported Data Sources: • Google BigQuery Downloading the driver To download the

Passing the connection URLAfter setting the CLASSPATH, the required connection information needs to be passed in the form of aconnection URL. The connection URL takes the form:

Connection URL Syntax

jdbc:datadirect:googlebigquery:Project=project;Dataset=dataset;AccessToken=accesstoken;RefreshToken=refreshtoken;ClientID=clientid;ClientSecret=clientsecret[;property=value[;...]]

where:

Project

specifies the name of the project that you want the driver to connect to. The projects in GoogleBigQuery are equivalent to catalogs in JDBC.

Dataset

specifies the name of the dataset that you want the driver to connect to. The datasets in GoogleBigQuery are equivalent to schemas in JDBC.

AccessToken

specifies the access token required to authenticate to a Google BigQuery instance.

RefreshToken

specifies the refresh token used to either request a new access token or renew an expired accesstoken.

ClientID

specifies the consumer key for your application.

ClientSecret

specifies the consumer secret for your application.

Connection URL Example

Connection conn = DriverManager.getConnection ("jdbc:datadirect:googlebigquery:Project=myproject;Dataset=mydataset; AccessToken=abcdefghi12345678;RefreshToken=wxyz123456789; ClientID=123abc.apps.googleusercontent.com;ClientSecret=ab123xy");

Testing a DriverManager connectionYou can use DataDirect Test™ to verify your connection. The screen shots in this section were taken on aWindows system.

To test the connection from the driver to your data source, follow these steps:

1. Navigate to the installation directory. The default location is:

• Windows systems: Program Files\Progress\DataDirect\JDBC_60\testforjdbc

11Progress DataDirect for JDBC for Google BigQuery Driver: Quick Start: Version 6.0.0

Connecting to a DataSource

Page 12: Progress DataDirect for JDBC for Google BigQuery Quick Start · and IBM SDK (Java) distributions. Supported Data Sources: • Google BigQuery Downloading the driver To download the

• UNIX and Linux systems: /opt/Progress/DataDirect/JDBC_60/testforjdbc

Note: For UNIX/Linux, if you do not have access to /opt, your home directory will be used in its place.

2. From the testforjdbc folder, run the platform-specific tool:

• testforjdbc.bat (on Windows systems)

• testforjdbc.sh (on UNIX and Linux systems)

The Test for JDBC Tool window appears:

3. Click Press Here to Continue.

The main dialog appears:

Progress DataDirect for JDBC for Google BigQuery Driver: Quick Start: Version 6.0.012

Chapter 1: Quick Start: Progress DataDirect for JDBC for Google BigQuery Driver

Page 13: Progress DataDirect for JDBC for Google BigQuery Quick Start · and IBM SDK (Java) distributions. Supported Data Sources: • Google BigQuery Downloading the driver To download the

4. From the menu bar, select Connection > Connect to DB.

The Select A Database dialog appears:

5. Select the appropriate database template from the Defined Databases field.

6. In the Database field, specify all required connection properties.

For example:

jdbc:datadirect:googlebigquery:Project=myproject;Dataset=mydataset;AccessToken=abcdefghi12345678;RefreshToken=wxyz123456789;ClientID=123abc.apps.googleusercontent.com;ClientSecret=ab123xy

7. Click Connect.

If the connection information is entered correctly, the JDBC/Database Output window reports that a connectionhas been established. (If a connection is not established, the window reports an error.)

13Progress DataDirect for JDBC for Google BigQuery Driver: Quick Start: Version 6.0.0

Connecting to a DataSource

Page 14: Progress DataDirect for JDBC for Google BigQuery Quick Start · and IBM SDK (Java) distributions. Supported Data Sources: • Google BigQuery Downloading the driver To download the

Connecting using data sources

A JDBC data source is a Java object, specifically a DataSource object, that defines connection informationrequired for a JDBC driver to connect to the database. Each JDBC driver vendor provides their own data sourceimplementation for this purpose. A Progress DataDirect data source is Progress DataDirect’s implementationof a DataSource object that provides the connection information needed for the driver to connect to a database.

Because data sources work with the Java Naming Directory Interface (JNDI) naming service, data sourcescan be created and managed separately from the applications that use them. Because the connection informationis defined outside of the application, the effort to reconfigure your infrastructure when a change is made isminimized. For example, if the database is moved to another database server, the administrator need onlychange the relevant properties of the DataSource object. The applications using the database do not needto change because they only refer to the name of the data source.

How data sources are implementedData sources are implemented through the DataSource class. The DataSource class implements thefollowing interfaces.

• javax.sql.DataSource

• javax.sql.ConnectionPoolDataSource (allows applications to use connection pooling)

The DataSource class for the Google BigQuery driver iscom.ddtek.jdbcx.googlebigquery.GoogleBigQueryDataSource.

Creating data sourcesThe following example files provide details on creating and using Progress DataDirect data sources with theJava Naming Directory Interface (JNDI), where install_dir is the product installation directory.

Progress DataDirect for JDBC for Google BigQuery Driver: Quick Start: Version 6.0.014

Chapter 1: Quick Start: Progress DataDirect for JDBC for Google BigQuery Driver

Page 15: Progress DataDirect for JDBC for Google BigQuery Quick Start · and IBM SDK (Java) distributions. Supported Data Sources: • Google BigQuery Downloading the driver To download the

• install_dir/Examples/JNDI/JNDI_LDAP_Example.java can be used to create a JDBC data sourceand save it in your LDAP directory using the JNDI Provider for LDAP.

• install_dir/Examples/JNDI/JNDI_FILESYSTEM_Example.java can be used to create a JDBCdata source and save it in your local file system using the File System JNDI Provider.

See "Example data source" for an example data source definition for the example files.

To connect using a JNDI data source, the driver needs to access a JNDI data store to persist the data sourceinformation. For a JNDI file system implementation, you must download the File System Service Provider fromthe Oracle Technology Network Java SE Support downloads page, unzip the files to an appropriate location,and add the fscontext.jar and providerutil.jar files to your CLASSPATH. These steps are notrequired for LDAP implementations because the LDAP Service Provider has been included with Java SE sinceJava 2 SDK, v1.3.

Example data source

To configure a data source using the example files, you will need to create a data source definition.The contentrequired to create a data source definition is divided into three sections.

First, you will need to import the DataSource class. For example:

com.ddtek.jdbcx.googlebigquery.GoogleBigQueryDataSource

Next, you will need to set the values and define the data source. For example, the following definition containsthe minimum properties required for a connection:

GoogleBigQueryDataSource mds = new GoogleBigQueryDataSource();mds.setDescription("My Google BigQuery Datasource");mds.setProject("myproject");mds.setDataset("mydataset");mds.setAccessToken("abcdefghi12345678");mds.setRefreshToken("wxyz123456789");mds.setClientID("123abc.apps.googleusercontent.com");mds.setClientSecret("ab123xy");

Optionally, configure the example application to print out the data source attributes. Note that this code isspecific to the driver and should only be used in the example application. For example, you would add thefollowing section for a binary connection using only the minimum properties:

if (ds instanceof GoogleBigQueryDataSource){GoogleBigQueryDataSource jmds = (GoogleBigQueryDataSource) ds;System.out.println("description=" + jmds.getDescription());System.out.println("project=" + jmds.getProject());System.out.println("dataset=" + jmds.getDataset());System.out.println("accessToken=" + jmds.getAccessToken());System.out.println("refreshToken=" + jmds.getRefreshToken());System.out.println("clientID=" + jmds.getClientID());System.out.println("clientSecret=" + jmds.getClientSecret());System.out.println();}

Calling a data source in an applicationApplications can call a Progress DataDirect data source using a logical name to retrieve thejavax.sql.DataSource object. This object loads the specified driver and can be used to establish aconnection to the database.

15Progress DataDirect for JDBC for Google BigQuery Driver: Quick Start: Version 6.0.0

Connecting to a DataSource

Page 16: Progress DataDirect for JDBC for Google BigQuery Quick Start · and IBM SDK (Java) distributions. Supported Data Sources: • Google BigQuery Downloading the driver To download the

Once the data source has been registered with JNDI, it can be used by your JDBC application as shown in thefollowing code example.

Context ctx = new InitialContext();DataSource ds = (DataSource)ctx.lookup("EmployeeDB");Connection con = ds.getConnection();

In this example, the JNDI environment is first initialized. Next, the initial naming context is used to find thelogical name of the data source (EmployeeDB). The Context.lookup() method returns a reference to aJava object, which is narrowed to a javax.sql.DataSource object. Then, theDataSource.getConnection() method is called to establish a connection.

Testing a data source connectionYou can use DataDirect Test™ to establish and test a data source connection. The screen shots in this sectionwere taken on a Windows system.

Take the following steps to establish a connection.

1. Navigate to the installation directory. The default location is:

• Windows systems: Program Files\Progress\DataDirect\JDBC_60\testforjdbc

• UNIX and Linux systems: /opt/Progress/DataDirect/JDBC_60/testforjdbc

Note: For UNIX/Linux, if you do not have access to /opt, your home directory will be used in its place.

2. From the testforjdbc folder, run the platform-specific tool:

• testforjdbc.bat (on Windows systems)

• testforjdbc.sh (on UNIX and Linux systems)

The Test for JDBC Tool window appears:

Progress DataDirect for JDBC for Google BigQuery Driver: Quick Start: Version 6.0.016

Chapter 1: Quick Start: Progress DataDirect for JDBC for Google BigQuery Driver

Page 17: Progress DataDirect for JDBC for Google BigQuery Quick Start · and IBM SDK (Java) distributions. Supported Data Sources: • Google BigQuery Downloading the driver To download the

3. Click Press Here to Continue.

The main dialog appears:

4. From the menu bar, select Connection > Connect to DB via Data Source.

The Select A Database dialog appears:

5. Select a datasource template from the Defined Datasources field.

6. Provide the following information:

a) In the Initial Context Factory, specify the location of the initial context provider for your application.

b) In the Context Provider URL, specify the location of the context provider for your application.

c) In the Datasource field, specify the name of your datasource.

7. Click Connect.

17Progress DataDirect for JDBC for Google BigQuery Driver: Quick Start: Version 6.0.0

Connecting to a DataSource

Page 18: Progress DataDirect for JDBC for Google BigQuery Quick Start · and IBM SDK (Java) distributions. Supported Data Sources: • Google BigQuery Downloading the driver To download the

If the connection information is entered correctly, the JDBC/Database Output window reports that a connectionhas been established. If a connection is not established, the window reports an error.

Tuning for performanceThe connection properties described in this section directly affect the performance of your driver. To tune forperformance, configure your driver according to the recommended settings and your environment.

FetchSizePurpose:

Specifies the number of rows that the driver processes before returning data to the application when executinga Select. This value provides a suggestion to the driver as to the number of rows it should internally processbefore returning control to the application.The driver may fetch fewer rows to conserve memory when processingexceptionally wide rows.

Performance Impact:

FetchSize and WSFetchSize can be used to adjust the trade-off between throughput and response time. Ingeneral, setting larger values for FetchSize and WSFetchSize will improve throughput, but can reduce responsetime.

Recommended Settings:

Set FetchSize to suit your environment. Smaller fetch sizes can improve the initial response time of the query.Larger fetch sizes improve overall fetch times at the cost of additional memory.

WSFetchSizePurpose:

Progress DataDirect for JDBC for Google BigQuery Driver: Quick Start: Version 6.0.018

Chapter 1: Quick Start: Progress DataDirect for JDBC for Google BigQuery Driver

Page 19: Progress DataDirect for JDBC for Google BigQuery Quick Start · and IBM SDK (Java) distributions. Supported Data Sources: • Google BigQuery Downloading the driver To download the

Specifies the number of rows of data the driver attempts to fetch from the native data source on each requestsubmitted to the server.

Performance Impact:

FetchSize and WSFetchSize can be used to adjust the trade-off between throughput and response time. Ingeneral, setting larger values for FetchSize and WSFetchSize will improve throughput, but can reduce responsetime.

Recommended Settings:

Set WSFetchSize to 0 to fetch a maximum of 2147483647 rows for optimum throughput. Setting the valuelower than the default, 1000000, can reduce the response time for returning the initial data.

WSPoolSizePurpose:

Specifies the maximum number of Google BigQuery sessions the driver uses. This allows the driver to havemultiple web service requests active when multiple JDBC connections are open, thereby improving throughputand performance.

Performance Impact:

WSPoolSize determines the maximum number of sessions the driver uses when there are multiple activeconnections to Google BigQuery. By increasing this number, you increase the number of sessions the driveruses to distribute calls to Google BigQuery, thereby improving throughput and performance. For example, ifWSPoolSize is set to 1, and you have two open connections, the session must complete a call from oneconnection before it can begin processing a call from the other connection. However, if WSPoolSize is set to2, a second session is opened that allows calls from both connections to be processed simultaneously.

Recommended Settings:

For optimal performance, specify a value that is equal to the number of sessions permitted by your GoogleBigQuery account.

Troubleshooting setup/connection issuesThis section describes common setup/connection issues you may encounter while trying to establish a databaseconnection with the driver as well as some potential reasons for these issues. If you are experiencing a problemnot described in this section, comprehensive troubleshooting resources are available in the "Troubleshooting"section of the Progress DataDirect for JDBC for Google BigQuery Driver User's Guide.

Common setup/connection issues

You are experiencing a setup/connection issue if you are encountering an error or hang while you are tryingto make a database connection with the JDBC driver or are trying to configure the JDBC driver. Some commonerrors that are returned by the driver if you are experiencing a setup/connection issue include:

• class not found

• Specified driver could not be loaded.

• Data source name not found and no default driver specified.

• Unable to connect to destination.

19Progress DataDirect for JDBC for Google BigQuery Driver: Quick Start: Version 6.0.0

Troubleshooting setup/connection issues

Page 20: Progress DataDirect for JDBC for Google BigQuery Quick Start · and IBM SDK (Java) distributions. Supported Data Sources: • Google BigQuery Downloading the driver To download the

Troubleshooting the issue

Some common reasons that setup/connection issues occur are:

• The database and/or listener are not started.

• The driver jar file, googlebigquery.jar, is not defined on your CLASSPATH. If the driver is not definedon your CLASSPATH, you will receive a class not found exception when trying to load the driver. See"Setting the classpath" for details.

• The JDBC driver’s connection properties are not set correctly in the connection URL or data source. See"Connecting to a DataSource" for more information.

See alsoSetting the classpath on page 9Connecting to a DataSource on page 10

Additional resourcesIn addition to this quick start, the following resources enable you to take full advantage of the features andsupport offered for your driver.

• Product Documentation Library contains a comprehensive set of product documentation, including thefollowing guides:

• Progress DataDirect for JDBC Drivers Installation Guide details requirements and procedures for installingthe product.

• Progress DataDirect for JDBC for Google BigQuery Driver User's Guide guides you through using andconfiguring the driver.

• Progress Support Knowledgebase provides answers to questions, access to technical documentation,release notes, product alerts and other support information.

• Progress Community allows you to contribute, share, and network with other Progress users and employees.

• Technical Support provides technical support services, including maintenance services and opening asupport case.

Contacting Technical Support

Progress DataDirect offers a variety of options to meet your support needs. Please visit our Web site for moredetails and for contact information:

https://www.progress.com/support

The Progress DataDirect Web site provides the latest support information through our global service network.The SupportLink program provides access to support contact details, tools, patches, and valuable information,including a list of FAQs for each product. In addition, you can search our Knowledgebase for technical bulletinsand other information.

When you contact us for assistance, please provide the following information:

Progress DataDirect for JDBC for Google BigQuery Driver: Quick Start: Version 6.0.020

Chapter 1: Quick Start: Progress DataDirect for JDBC for Google BigQuery Driver

Page 21: Progress DataDirect for JDBC for Google BigQuery Quick Start · and IBM SDK (Java) distributions. Supported Data Sources: • Google BigQuery Downloading the driver To download the

• Your number or the serial number that corresponds to the product for which you are seeking support, or acase number if you have been provided one for your issue. If you do not have a SupportLink contract, theSupportLink representative assisting you will connect you with our Sales team.

• Your name, phone number, email address, and organization. For a first-time call, you may be asked for fullinformation, including location.

• The Progress DataDirect product and the version that you are using.

• The type and version of the operating system where you have installed your product.

• Any database, database version, third-party software, or other environment information required to understandthe problem.

• A brief description of the problem, including, but not limited to, any error messages you have received, whatsteps you followed prior to the initial occurrence of the problem, any trace logs capturing the issue, and soon. Depending on the complexity of the problem, you may be asked to submit an example or reproducibleapplication so that the issue can be re-created.

• A description of what you have attempted to resolve the issue. If you have researched your issue on Websearch engines, our Knowledgebase, or have tested additional configurations, applications, or other vendorproducts, you will want to carefully note everything you have already attempted.

• A simple assessment of how the severity of the issue is impacting your organization.

21Progress DataDirect for JDBC for Google BigQuery Driver: Quick Start: Version 6.0.0

Additional resources

Page 22: Progress DataDirect for JDBC for Google BigQuery Quick Start · and IBM SDK (Java) distributions. Supported Data Sources: • Google BigQuery Downloading the driver To download the

Progress DataDirect for JDBC for Google BigQuery Driver: Quick Start: Version 6.0.022

Chapter 1: Quick Start: Progress DataDirect for JDBC for Google BigQuery Driver