Query Zuora Data in DataGrip

DataGrip is a database IDE that allows SQL developers to query, create, and manage databases. When paired with the CData JDBC Driver for Zuora, DataGrip can work with live Zuora data. This article shows how to establish a connection to Zuora data in DataGrip.

Create a New Driver Definition for Zuora

The steps below describe how to create a new Data Source in DataGrip for Zuora.

1. In DataGrip, click File -> New > Project and name the project 👁 Creating a new DataGrip project.
   
2. In the Database Explorer, click the plus icon () and select Driver. 👁 Adding a new Driver.
   
3. In the Driver tab:
   • Set Name to a user-friendly name (e.g. "CData Zuora Driver")
   • Set Driver Files to the appropriate JAR file. To add the file, click the plus (), select "Add Files," navigate to the "lib" folder in the driver's installation directory and select the JAR file (e.g. cdata.jdbc.zuora.jar).
   • Set Class to cdata.jdbc.zuora.Zuora.jar
4. Click "Apply" then "OK" to save the Connection 👁 A configured Driver (Salesforce is shown).
   

Configure a Connection to Zuora

1. Once the connection is saved, click the plus (), then "Data Source" then "CData Zuora Driver" to create a new Zuora Data Source.
2. In the new window, configure the connection to Zuora with a JDBC URL.

   Built-in Connection String Designer

   For assistance in constructing the JDBC URL, use the connection string designer built into the Zuora JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

    java -jar cdata.jdbc.zuora.jar
    

   Fill in the connection properties and copy the connection string to the clipboard.

   Zuora uses the OAuth standard to authenticate users. See the online Help documentation for a full OAuth authentication guide.

   Configuring Tenant property

   In order to create a valid connection with the provider you need to choose one of the Tenant values (USProduction by default) which matches your account configuration. The following is a list with the available options:

   • USProduction: Requests sent to https://rest.zuora.com.
   • USAPISandbox: Requests sent to https://rest.apisandbox.zuora.com"
   • USPerformanceTest: Requests sent to https://rest.pt1.zuora.com"
   • EUProduction: Requests sent to https://rest.eu.zuora.com"
   • EUSandbox: Requests sent to https://rest.sandbox.eu.zuora.com"

   Selecting a Zuora Service

   Two Zuora services are available: Data Query and AQuA API. By default ZuoraService is set to AQuADataExport.

   DataQuery

   The Data Query feature enables you to export data from your Zuora tenant by performing asynchronous, read-only SQL queries. We recommend to use this service for quick lightweight SQL queries.

   Limitations
   • The maximum number of input records per table after filters have been applied: 1,000,000
   • The maximum number of output records: 100,000
   • The maximum number of simultaneous queries submitted for execution per tenant: 5
   • The maximum number of queued queries submitted for execution after reaching the limitation of simultaneous queries per tenant: 10
   • The maximum processing time for each query in hours: 1
   • The maximum size of memory allocated to each query in GB: 2
   • The maximum number of indices when using Index Join, in other words, the maximum number of records being returned by the left table based on the unique value used in the WHERE clause when using Index Join: 20,000

   AQuADataExport

   AQuA API export is designed to export all the records for all the objects ( tables ). AQuA query jobs have the following limitations:

   Limitations
   • If a query in an AQuA job is executed longer than 8 hours, this job will be killed automatically.
   • The killed AQuA job can be retried three times before returned as failed.
   👁 Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)
   
3. Set URL to the connection string, e.g.,

   jdbc:zuora:OAuthClientID=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;Tenant=USProduction;ZuoraService=DataQuery;InitiateOAuth=GETANDREFRESH;

4. Click "Apply" and "OK" to save the connection string 👁 A configured Data Source (Salesforce is shown).
   

At this point, you will see the data source in the Data Explorer.

Execute SQL Queries Against Zuora

To browse through the Zuora entities (available as tables) accessible through the JDBC Driver, expand the Data Source.

To execute queries, right click on any table and select "New" -> "Query Console."

In the Console, write the SQL query you wish to execute. For example:

SELECT Id, BillingCity FROM Invoices WHERE BillingState = 'CA'

Download a free, 30-day trial of the CData JDBC Driver for Zuora and start working with your live Zuora data in DataGrip. Reach out to our Support Team if you have any questions.