Discover how a bimodal integration strategy can address the major data management challenges facing your organization today.
Get the Report →How to Connect DBeaver to Zuora via a JDBC Driver
Manage Zuora data with visual tools in DBeaver like the query browser.
The CData JDBC Driver for Zuora implements JDBC standards that enable third-party tools to interoperate, from wizards in IDEs to business intelligence tools. This article shows how to connect to Zuora data with wizards in DBeaver and browse data in the DBeaver GUI.
Create a JDBC Data Source for Zuora Data
Follow the steps below to load the driver JAR in DBeaver.
- Open the DBeaver application and, in the "Database" menu, select the "Driver Manager" option. Click "New" to open the "Create new driver" form.
- In the Settings tab:
- Set Driver Name to a user-friendly name for the driver (e.g. CData JDBC Driver for Zuora).
- Set Class Name to the class name for the JDBC driver: cdata.jdbc.zuora.ZuoraDriver.
- Set URL Template to jdbc:zuora:.
- In the Libraries tab, click "Add File," navigate to the "lib" folder in the installation directory (C:\Program Files\CData[product_name] XXXX\) and select the JAR file (cdata.jdbc.Zuora.jar).
Create a Connection to Zuora Data
Follow the steps below to add credentials and other required connection properties.
- In the "Database" menu, click "New Database Connection."
- In the "Connect to a database" wizard that results, select the driver you just created (e.g. CData JDBC Driver for Zuora) and click "Next >."
- On the Main tab of the configuration wizard, set the JDBC URL, using the required 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.
Below is a typical connection string:
jdbc:zuora:OAuthClientID=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;Tenant=USProduction;ZuoraService=DataQuery;InitiateOAuth=GETANDREFRESH
- Click "Test Connection ..." to ensure you have configured the connection properly.
- Click "Finish."
Query Zuora Data
You can now query information from the tables exposed by the connection: Right-click a Table and then click View Table. The data is available on the Data tab.