Connect to Zuora Data in DBeaver

The CData ODBC Driver for Zuora enables access to live data from Zuora under the ODBC standard, allowing you work with Zuora data in a wide variety of BI, reporting, and ETL tools and directly, using familiar SQL queries. This article shows how to manage Zuora data with visual tools in DBeaver like the query browser.

The CData ODBC drivers offer unmatched performance for interacting with live Zuora data in DBeaver due to optimized data processing built into the driver. When you issue complex SQL queries from DBeaver to Zuora, the driver pushes supported SQL operations, like filters and aggregations, directly to Zuora and utilizes the embedded SQL engine to process unsupported operations (often SQL functions and JOIN operations) client-side. With built-in dynamic metadata querying, you can manage and analyze Zuora data.

Connect to Zuora

If you have not already done so, provide values for the required connection properties in the data source name (DSN). You can configure the DSN using the Microsoft ODBC Data Source Administrator. This is also the last step of the driver installation. See the "Getting Started" chapter in the Help documentation for a guide to using the Microsoft ODBC Data Source Administrator to create and configure a DSN.

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.

Finally, set the "Map To WVarchar connection property to False in the DSN Configuration window for the driver. This configuration will allow string types to be mapped to SQL_VARCHAR and prevent SQL_WVARCHAR types from being displayed as NULL.

👁 Setting the Map To WVarchar property

Connecting to the Zuora ODBC Data Source in DBeaver

1. Open the DBeaver application and in the Database menu, select the New Database Connection option. 👁 Creating a new Database Connection
   
2. In the 'Connect to a database' window, select ODBC and click Next. 👁 Creating a new Database Connection
   
3. In the Database/Schema field, enter the DSN name (CData Zuora Source by default). It will be automatically added to the JDBC URL as well.
4. Click the Test Connection button. You should receive a 'Connected' message after DBeaver has detected the DSN, along with details about the driver if the connection is successful. 👁 Successfully tested connection
   

Query Zuora Data

You can now query information from the tables exposed by the data source connection. You can expand the database structure in order to view all the tables. You can retrieve the table's data by right-clicking on a table name and selecting View data. The data will then be available in the Data tab.

👁 Viewing data (Salesforce is shown)

Free Trial & More Information

At this point, you have connected to live Zuora data from DBeaver. For more information, visit the CData ODBC Driver page. Download a free, 30-day trial and start working live Zuora data DBeaver today.