Connect to Zuora Data in Aqua Data Studio



Access Zuora data from tools in Aqua Data Studio such as the Visual Query Builder and the Table Data Editor.

The CData JDBC Driver for Zuora integrates Zuora data with wizards and analytics in IDEs like Aqua Data Studio. This article shows how to connect to Zuora data through the connection manager and execute queries.

Create a JDBC Data Source

You can use the connection manager to define connection properties and save them in a new JDBC data source. The Zuora data source can then be accessed from Aqua Data Studio tools.

  1. In Aqua Data Studio, select Register Server from the Servers menu.
  2. In the Register Server form, select the 'Generic - JDBC' connection.
  3. Enter the following JDBC connection properties:
    • Name: Enter a name for the data source; for example, Zuora.
    • Driver Location: Click the Browse button and select the cdata.jdbc.zuora.jar file, located in the lib subfolder of the installation directory.
    • Driver: Enter the Driver's class name, cdata.jdbc.zuora.ZuoraDriver.
    • URL: Enter the JDBC URL, which starts with jdbc:zuora: and is followed by a semicolon-separated list of connection properties.

      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.

      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.

      A typical JDBC URL is below:

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

Query Zuora Data

You can now query the tables exposed.

Ready to get started?

Download a free trial of the Zuora Driver to get started:

 Download Now

Learn more:

Zuora Icon Zuora JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with Zuora.