How to Connect DBeaver to TaxJar via a JDBC Driver

The CData JDBC Driver for TaxJar implements JDBC standards that enable third-party tools to interoperate, from wizards in IDEs to business intelligence tools. This article shows how to connect to TaxJar data with wizards in DBeaver and browse data in the DBeaver GUI.

Create a JDBC Data Source for TaxJar Data

Follow the steps below to load the driver JAR in DBeaver.

1. Open the DBeaver application and, in the "Database" menu, select the "Driver Manager" option. Click "New" to open the "Create new driver" form.
2. In the Settings tab:
   • Set Driver Name to a user-friendly name for the driver (e.g. CData JDBC Driver for TaxJar).
   • Set Class Name to the class name for the JDBC driver: cdata.jdbc.taxjar.TaxJarDriver.
   • Set URL Template to jdbc:taxjar:.
   👁 Configure the new driver settings (Salesforce is shown).
   
3. In the Libraries tab, click "Add File," navigate to the "lib" folder in the installation directory (C:\Program Files\CData[product_name] XXXX\) and select the JAR file (cdata.jdbc.TaxJar.jar). 👁 Loading the JDBC JAR file (Salesforce is shown).
   

Create a Connection to TaxJar Data

Follow the steps below to add credentials and other required connection properties.

1. In the "Database" menu, click "New Database Connection."
2. In the "Connect to a database" wizard that results, select the driver you just created (e.g. CData JDBC Driver for TaxJar) and click "Next >." 👁 Selecting the driver (Salesforce is shown).
   
3. On the Main tab of the configuration wizard, set the JDBC URL, using the required connection properties:

   To authenticate to the TaxJar API, first obtain the API Key from the TaxJar UI.

   NOTE: the API is available only for Professional and Premium TaxJar plans.

   If you already have a Professional or Premium plan you can find the API Key by logging in the TaxJar UI and navigating to Account -> TaxJar API. After obtaining the API Key, you can set it in the APIKey connection property.

   Additional Notes

   • By default, the CData connector will retrieve data of the last 3 months in cases where the entity support date range filtering. You can set StartDate to specify the minimum creation date of the data retrieved.
   • If the API Key has been created for a sandbox API account please set UseSandbox to true, but not all endpoints will work as expected. For more information, refer to the TaxJar developer documentation.

   Built-in Connection String Designer

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

   java -jar cdata.jdbc.taxjar.jar
   

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

   👁 Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)
   

   Below is a typical connection string:

   jdbc:taxjar:APIKey=3bb04218ef8t80efdf1739abf7257144;
   

   👁 Configuring the JDBC URL (Salesforce is shown).
   
4. Click "Test Connection ..." to ensure you have configured the connection properly. 👁 A successfully configured connection (Salesforce is shown).
   
5. Click "Finish."

Query TaxJar Data

You can now query information from the tables exposed by the connection: Right-click a Table and then click View Table. The data is available on the Data tab.

👁 The results of a query in DBeaver. (Salesforce is shown.)

More Information & Free Trial

Download a free, 30-day trial of the CData JDBC Driver for TaxJar and start working with your live TaxJar data in DBeaver. Join the CData Community or reach out to our Support Team if you have any questions.