Query QuickBooks Data in DataGrip

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

Create a New Driver Definition for QuickBooks

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

1. In DataGrip, click File -> New > Project and name the project
2. In the Database Explorer, click the plus icon () and select Driver.
3. In the Driver tab:
   • Set Name to a user-friendly name (e.g. "CData QuickBooks 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.quickbooks.jar).
   • Set Class to cdata.jdbc.quickbooks.QuickBooks.jar
   Additionally, in the advanced tab you can change driver properties and some other settings like VM Options, VM environment, VM home path, DBMS, etc
   • For most cases, change the DBMS type to "Unknown" in Expert options to avoid native SQL Server queries (Transact-SQL), which might result in an invalid function error
4. Click "Apply" then "OK" to save the Connection

Configure a Connection to QuickBooks

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

   Built-in Connection String Designer

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

   java -jar cdata.jdbc.quickbooks.jar

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

   When you are connecting to a local QuickBooks instance, you do not need to set any connection properties.

   Requests are made to QuickBooks through the Remote Connector. The Remote Connector runs on the same machine as QuickBooks and accepts connections through a lightweight, embedded Web server. The server supports SSL/TLS, enabling users to connect securely from remote machines.

   The first time you connect, you will need to authorize the Remote Connector with QuickBooks. See the "Getting Started" chapter of the help documentation for a guide.

3. Set URL to the connection string, e.g., jdbc:quickbooks:URL=http://remotehost:8166;User=admin;Password=admin123;
4. Click "Apply" and "OK" to save the connection string

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

Execute SQL Queries Against QuickBooks

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

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

In the Console, write the SQL query you wish to execute. For example: SELECT Name, CustomerBalance FROM Customers

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