Ready to get started?

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

Learn more:

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.

Natively Connect to Zuora Data in PHP

Create PHP applications on Linux/UNIX machines with connectivity to Zuora data. Leverage the native support for ODBC in PHP.

Drop the CData ODBC Driver for Zuora into your LAMP or WAMP stack to build Zuora-connected Web applications. This article shows how to use PHP's ODBC built-in functions to connect to Zuora data, execute queries, and output the results.

Using the CData ODBC Drivers on a UNIX/Linux Machine

The CData ODBC Drivers are supported in various Red Hat-based and Debian-based systems, including Ubuntu, Debian, RHEL, CentOS, and Fedora. There are also several libraries and packages that are required, many of which may be installed by default, depending on your system. For more information on the supported versions of Linux operating systems and the required libraries, please refer to the "Getting Started" section in the help documentation (installed and found online).

Installing the Driver Manager

Before installing the driver, check that your system has a driver manager. For this article, you will use unixODBC, a free and open source ODBC driver manager that is widely supported.

For Debian-based systems like Ubuntu, you can install unixODBC with the APT package manager:


$ sudo apt-get install unixodbc unixodbc-dev

For systems based on Red Hat Linux, you can install unixODBC with yum or dnf:


$ sudo yum install unixODBC unixODBC-devel

The unixODBC driver manager reads information about drivers from an odbcinst.ini file and about data sources from an odbc.ini file. You can determine the location of the configuration files on your system by entering the following command into a terminal:


$ odbcinst -j

The output of the command will display the locations of the configuration files for ODBC data sources and registered ODBC drivers. User data sources can only be accessed by the user account whose home folder the odbc.ini is located in. System data sources can be accessed by all users. Below is an example of the output of this command:


DRIVERS............: /etc/odbcinst.ini
SYSTEM DATA SOURCES: /etc/odbc.ini
FILE DATA SOURCES..: /etc/ODBCDataSources
USER DATA SOURCES..: /home/myuser/.odbc.ini
SQLULEN Size.......: 8
SQLLEN Size........: 8
SQLSETPOSIROW Size.: 8

Installing the Driver

You can download the driver in standard package formats: the Debian .deb package format or the .rpm file format. Once you have downloaded the file, you can install the driver from the terminal.

The driver installer registers the driver with unixODBC and creates a system DSN, which can be used later in any tools or applications that support ODBC connectivity.

For Debian-based systems like Ubuntu, run the following command with sudo or as root: $ dpkg -i /path/to/package.deb

For Red Hat systems or other systems that support .rpms, run the following command with sudo or as root: $ rpm -i /path/to/package.rpm

Once the driver is installed, you can list the registered drivers and defined data sources using the unixODBC driver manager:

List the Registered Driver(s)


$ odbcinst -q -d
CData ODBC Driver for Zuora
...

List the Defined Data Source(s)


$ odbcinst -q -s
CData Zuora Source
...

To use the CData ODBC Driver for Zuora with unixODBC, ensure that the driver is configured to use UTF-16. To do so, edit the INI file for the driver (cdata.odbc.zuora.ini), which can be found in the lib folder in the installation location (typically /opt/cdata/cdata-odbc-driver-for-zuora), as follows:

cdata.odbc.zuora.ini


...

[Driver]
DriverManagerEncoding = UTF-16

Modifying the DSN

The driver installation predefines a system DSN. You can modify the DSN by editing the system data sources file (/etc/odbc.ini) and defining the required connection properties. Additionally, you can create user-specific DSNs that will not require root access to modify in $HOME/.odbc.ini.

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.

/etc/odbc.ini or $HOME/.odbc.ini


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

For specific information on using these configuration files, please refer to the help documentation (installed and found online).

Establish a Connection

Open the connection to Zuora by calling the odbc_connect or odbc_pconnect methods. To close connections, use odbc_close or odbc_close_all.


$conn = odbc_connect("CData ODBC Zuora Source","user","password");

Connections opened with odbc_connect are closed when the script ends. Connections opened with the odbc_pconnect method are still open after the script ends. This enables other scripts to share that connection when they connect with the same credentials. By sharing connections among your scripts, you can save system resources and queries execute faster.


$conn = odbc_pconnect("CData ODBC Zuora Source","user","password");
...
odbc_close($conn); //persistent connection must be closed explicitly

Create Prepared Statements

Create prepared statements and parameterized queries with the odbc_prepare function.


$query = odbc_prepare($conn, "SELECT * FROM Invoices WHERE BillingState = ?");

Execute Queries

Execute prepared statements with odbc_execute.


$conn = odbc_connect("CData ODBC Zuora Source","user","password");
$query = odbc_prepare($conn, "SELECT * FROM Invoices WHERE BillingState = ?");
$success = odbc_execute($query, array('CA'));

Execute nonparameterized queries with odbc_exec.


$conn = odbc_connect("CData ODBC Zuora Source","user","password");
$query = odbc_exec($conn, "SELECT Id, BillingCity FROM Invoices WHERE BillingState = 'CA'");

Process Results

Access a row in the result set as an array with the odbc_fetch_array function.


$conn = odbc_connect("CData ODBC Zuora data Source","user","password");
$query = odbc_exec($conn, "SELECT Id, BillingCity FROM Invoices WHERE BillingState = 'CA'");
while($row = odbc_fetch_array($query)){
 echo $row["Id"] . "\n";
}

Display the result set in an HTML table with the odbc_result_all function.


$conn = odbc_connect("CData ODBC Zuora data Source","user","password");
$query = odbc_prepare($conn, "SELECT * FROM Invoices WHERE BillingState = ?");
$success = odbc_execute($query, array('CA'));
if($success)
  odbc_result_all($query);

More Example Queries

You will find complete information on the SQL queries supported by the driver in the help documentation. The code examples above are Zuora-specific adaptations of the PHP community documentation for all ODBC functions.

CData Software is a leading provider of data access and connectivity solutions. Our standards-based connectors streamline data access and insulate customers from the complexities of integrating with on-premise or cloud databases, SaaS, APIs, NoSQL, and Big Data.

Connect With Us

Get Started

Data Connectors

ETL/ ELT Solutions

Cloud & API Connectivity

OEM & Custom Drivers