Connect to Zuora Data as a SQL Server Linked Server



Use CData Connect Cloud to create a linked server for live Zuora data.

SQL Server Linked Servers enable the SQL Server Database Engine to read data from remote data sources and execute commands against the remote database servers outside of the instance of SQL Server. Typically, linked servers are configured to enable the execution of a T-SQL statement that includes tables in another instance of SQL Server, or another database product such as Oracle. When paired with CData Connect Cloud, linked servers provides instant access to Zuora data from your SQL Server database. This article demonstrates how to connect to Zuora using Connect Cloud and query Zuora data in SQL Server Management Studio (SSMS).

CData Connect Cloud provides a pure SQL Server interface for Zuora, allowing you to query data from Zuora without replicating the data to a natively supported database. Using optimized data processing out of the box, CData Connect Cloud pushes all supported SQL operations (filters, JOINs, etc.) directly to Zuora, leveraging server-side processing to return the requested Zuora data quickly.

Configure Zuora Connectivity for SQL Server

Connectivity to Zuora from SQL Linked Servers is made possible through CData Connect Cloud. To work with Zuora data from SQL Linked Servers, we start by creating and configuring a Zuora connection.

  1. Log into Connect Cloud, click Connections and click Add Connection
  2. Select "Zuora" from the Add Connection panel
  3. Enter the necessary authentication properties to connect to Zuora.

    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.
  4. Click Create & Test
  5. Navigate to the Permissions tab in the Add Zuora Connection page and update the User-based permissions.

Add a Personal Access Token

If you are connecting from a service, application, platform, or framework that does not support OAuth authentication, you can create a Personal Access Token (PAT) to use for authentication. Best practices would dictate that you create a separate PAT for each service, to maintain granularity of access.

  1. Click on your username at the top right of the Connect Cloud app and click User Profile.
  2. On the User Profile page, scroll down to the Personal Access Tokens section and click Create PAT.
  3. Give your PAT a name and click Create.
  4. The personal access token is only visible at creation, so be sure to copy it and store it securely for future use.

Connect to Zuora from SQL Server using Connect Cloud

To establish a connection from SQL Server Linked Server to the CData Connect Cloud Virtual SQL Server API, follow these steps.

  1. Open Microsoft SQL Server Management Studio.
  2. In the Object Explorer pane, open Server Objects, right-click Linked Servers, and select New Linked Server.
  3. The New Linked Server dialogue opens. On the General page, enter the following information:
    • Enter a name for the server in the Linked server field.
    • Select the radio button Other data source and select SQL Server Native Client 11.0 as the provider.
    • In the Data source field, enter tds.cdata.com,14333
    • In the Catalog field, enter enter the Connection Name of the CData Connect Cloud data source you want to connect to (for example, Zuora1).
  4. Select the Security page. At the bottom, select the radio button labeled Be made using this security context and enter the following information:
    • Remote login - enter your CData Connect Cloud username. This is displayed in the top-right corner of the CData Connect Cloud interface. For example, [email protected].
    • With password - enter the PAT you generated on the Settings page.
  5. Click OK to create the server.
  6. Your linked server can now be used to access the data in the data source you specified. If you need to access data from more sources, create another linked server for each one.

Execute Queries

You can now execute queries to the Zuora linked server from any tool that can connect to SQL Server. An example SQL query would be: SELECT * FROM [CDATA CONNECT CLOUD].[Zuora1].[Zuora].[Invoices] We have successfully created a linked server that allows us to query Zuora data.

Get CData Connect Cloud

To get live data access to 100+ SaaS, Big Data, and NoSQL sources directly from your SQL Server database, try CData Connect Cloud today!

Ready to get started?

Learn more about CData Connect Cloud or sign up for free trial access:

Free Trial