VOOZH about

URL: https://www.cdata.com/kb/tech/zohosubscriptions-jdbc-datagrip.rst

⇱ Query ZohoSubscriptions Data in DataGrip


Query ZohoSubscriptions Data in DataGrip

πŸ‘ Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Create a Data Source for ZohoSubscriptions in DataGrip and use SQL to query live ZohoSubscriptions data.

DataGrip is a database IDE that allows SQL developers to query, create, and manage databases. When paired with the CData API Driver for JDBC, DataGrip can work with live ZohoSubscriptions data. This article shows how to establish a connection to ZohoSubscriptions data in DataGrip.

Create a New Driver Definition for ZohoSubscriptions

The steps below describe how to create a new Data Source in DataGrip for ZohoSubscriptions.

  1. In DataGrip, click File -> New > Project and name the project πŸ‘ Creating a new DataGrip project.
  2. In the Database Explorer, click the plus icon () and select Driver. πŸ‘ Adding a new Driver.
  3. In the Driver tab:
    • Set Name to a user-friendly name (e.g. "CData ZohoSubscriptions Driver")
    • Set Driver Files to the appropriate JAR file. To add the file, click the plus (), select "Add Files," navigate to the "lib" folder in the driver's installation directory and select the JAR file (e.g. cdata.jdbc.api.jar).
    • Set Class to cdata.jdbc.api.API.jar
  4. Click "Apply" then "OK" to save the Connection πŸ‘ A configured Driver (Salesforce is shown).

Configure a Connection to ZohoSubscriptions

  1. Once the connection is saved, click the plus (), then "Data Source" then "CData ZohoSubscriptions Driver" to create a new ZohoSubscriptions Data Source.
  2. In the new window, configure the connection to ZohoSubscriptions with a JDBC URL.

    Built-in Connection String Designer

    For assistance in constructing the JDBC URL, use the connection string designer built into the ZohoSubscriptions JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

     java -jar cdata.jdbc.api.jar
     

    Fill in the connection properties and copy the connection string to the clipboard.

    Start by setting the Profile connection property to the location of the ZohoSubscriptions Profile on disk (e.g. C:\profiles\ZohoSubscriptions.apip). Next, set the ProfileSettings connection property to the connection string for ZohoSubscriptions (see below).

    ZohoSubscriptions API Profile Settings

    Register an OAuth application in the Zoho Developer Console as a server-based application to obtain your Client ID and Client Secret.

    πŸ‘ Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)
  3. Set URL to the connection string, e.g.,
    jdbc:api:Profile=C:\profiles\ZohoSubscriptions.apip;Authscheme=OAuth;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;
  4. Click "Apply" and "OK" to save the connection string πŸ‘ A configured Data Source (Salesforce is shown).

At this point, you will see the data source in the Data Explorer.

Execute SQL Queries Against ZohoSubscriptions

To browse through the ZohoSubscriptions entities (available as tables) accessible through the JDBC Driver, expand the Data Source.

πŸ‘ Exploring the data (Salesforce is shown.)

To execute queries, right click on any table and select "New" -> "Query Console."

πŸ‘ Opening a new Query Console.

In the Console, write the SQL query you wish to execute. For example:

SELECT OrganizationId, AddonCode FROM Addons WHERE Status = 'Active'
πŸ‘ Querying with SQL (Salesforce is shown.)

Download a free, 30-day trial of the CData API Driver for JDBC and start working with your live ZohoSubscriptions data in DataGrip. Reach out to our Support Team if you have any questions.