Replicate Zuora Data from PowerShell



The CData ODBC Driver for Zuora enables out-of-the-box integration with Microsoft's built-in support for ODBC. The ODBC driver instantly integrates connectivity to the real Zuora data with PowerShell.

You can use the .NET Framework Provider for ODBC built into PowerShell to quickly automate integration tasks like replicating Zuora data to other databases. This article shows how to replicate Zuora data to SQL Server in 5 lines of code.

You can also write PowerShell code to download Zuora data. See the examples below.

Create an ODBC Data Source for Zuora

If you have not already, first specify connection properties in an ODBC DSN (data source name). This is the last step of the driver installation. You can use the Microsoft ODBC Data Source Administrator to create and configure ODBC DSNs.

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.

Connect to Zuora

The code below shows how to use the DSN to initialize the connection to Zuora data in PowerShell:

$conn = New-Object System.Data.Odbc.OdbcConnection
$conn.ConnectionString = "DSN=CData Zuora Source x64"

Back Up Zuora Data to SQL Server

After you enable caching, you can use the code below to replicate data to SQL Server.

Set the following connection properties to configure the caching database:

• CacheProvider: The name of the ADO.NET provider. This can be found in the Machine.config for your version of .NET. For example, to configure SQL Server, enter System.Data.SqlClient.

• CacheConnection: The connection string of properties required to connect to the database. Below is an example for SQL Server:

  Server=localhost;Database=RSB;User Id=sqltest;Password=sqltest;

The SQL query in the example can be used to refresh the entire cached table, including its schema. Any already existing cache is deleted.

$conn.Open()
# Create and execute the SQL Query
$SQL = "CACHE DROP EXISTING SELECT * FROM " + $Invoices
$cmd = New-Object System.Data.Odbc.OdbcCommand($sql,$conn)
$count = $cmd.ExecuteNonQuery()
$conn.Close()

The driver gives you complete control over the caching functionality. See the help documentation for more caching commands and usage examples. See the help documentation for steps to replicate to other databases.

Other Operations

To retrieve Zuora data in PowerShell, call the Fill method of the OdbcDataAdapter method. To execute data manipulation commands, initialize the OdbcCommand object and then call ExecuteNonQuery. Below are some more examples commands to Zuora through the .NET Framework Provider for ODBC:

Retrieve Zuora Data

$sql="SELECT Id, BillingCity from Invoices"
 
$da= New-Object System.Data.Odbc.OdbcDataAdapter($sql, $conn)
$dt= New-Object System.Data.DataTable
$da.Fill($dt) 
 
$dt.Rows | foreach {
 $dt.Columns | foreach ($col in dt{
 Write-Host $1[$_]
 }
}