VOOZH about

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

⇱ Query Zoho Books Data in DataGrip


Query Zoho Books Data in DataGrip

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

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

Create a New Driver Definition for Zoho Books

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

  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 Zoho Books 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.zohobooks.jar).
    • Set Class to cdata.jdbc.zohobooks.ZohoBooks.jar
  4. Click "Apply" then "OK" to save the Connection πŸ‘ A configured Driver (Salesforce is shown).

Configure a Connection to Zoho Books

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

    Built-in Connection String Designer

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

     java -jar cdata.jdbc.zohobooks.jar
     

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

    Zoho Books uses the OAuth authentication standard. To authenticate using OAuth, create an app to obtain the OAuthClientId, OAuthClientSecret, and CallbackURL connection properties. See the OAuth section of the Getting Started guide in the Help documentation for an authentication guide.

    πŸ‘ 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:zohobooks:OAuthClientId=MyOAuthClientId;OAuthClientSecret=myOAuthClientSecret;CallbackURL=https://localhost:33333;OrganizationId=MyOrganizationId;InitiateOAuth=GETANDREFRESH;
  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 Zoho Books

To browse through the Zoho Books 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 InvoiceId, InvoiceNumber FROM INVOICES WHERE CustomerName = 'NewTech Industries'
πŸ‘ Querying with SQL (Salesforce is shown.)

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

Ready to get started?

Download a free trial of the Zoho Books Driver to get started:

 Download Now

Learn more:

πŸ‘ Zoho Books Icon
Zoho Books JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with Zoho Books.