Learn more
 

Ready to get started?

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

 Download Now

Learn more:

Zuora Icon Zuora ODBC Driver

The Zuora ODBC Driver is a powerful tool that allows you to connect with live data from Zuora, directly from any applications that support ODBC connectivity.

Access Zuora data like you would a database - read, write, and update Zuora. through a standard ODBC Driver interface.

In this article

Related articles

Using the CData ODBC Driver for Zuora in PyCharm


Connect to Zuora as an ODBC data source in PyCharm using the CData ODBC Driver for Zuora.

The CData ODBC Drivers can be used in any environment that supports loading an ODBC Driver. In this tutorial we will explore using the CData ODBC Driver for Zuora from within PyCharm. Included are steps for adding the CData ODBC Driver as a data source, as well as basic PyCharm code to query the data source and display results.

To begin, this tutorial will assume that you have already installed the CData ODBC Driver for Zuora as well as PyCharm.

Add Pyodbc to the Project

Follow the steps below to add the pyodbc module to your project.

  1. Click File -> Settings to open the project settings window.
  2. Click Project Interpreter from the Project: YourProjectName menu.
  3. To add pyodbc, click the + button and enter pyodbc.
  4. Click Install Package to install pyodbc.

Connect to Zuora

You can now connect with an ODBC connection string or a DSN. See the Getting Started section in the CData driver documentation for a guide to creating a DSN on your OS.

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.

Below is the syntax for a DSN:

[CData Zuora Source] Driver = CData ODBC Driver for Zuora Description = My Description OAuthClientID = MyOAuthClientId OAuthClientSecret = MyOAuthClientSecret Tenant = USProduction ZuoraService = DataQuery

Execute SQL to Zuora

Instantiate a Cursor and use the execute method of the Cursor class to execute any SQL statement.

import pyodbc cnxn = pyodbc.connect('DRIVER={CData ODBC Driver for Zuora};OAuthClientID = MyOAuthClientId;OAuthClientSecret = MyOAuthClientSecret;Tenant = USProduction;ZuoraService = DataQuery;') cursor = cnxn.cursor() cursor.execute("SELECT Id, BillingCity FROM Invoices WHERE BillingState = 'CA'") rows = cursor.fetchall() for row in rows: print(row.Id, row.BillingCity)

After connecting to Zuora in PyCharm using the CData ODBC Driver, you will be able to build Python apps with access to Zuora data as if it were a standard database. If you have any questions, comments, or feedback regarding this tutorial, please contact us at support@cdata.com.