Connect to TaxJar Data in DBVisualizer

The CData JDBC Driver for TaxJar implements JDBC standards to provide connectivity to TaxJar data in applications ranging from business intelligence tools to IDEs. This article shows how to establish a connection to TaxJar data in DBVisualizer and use the table editor to edit and save TaxJar data.

Create a New Driver Definition for TaxJar Data

Follow the steps below to use the Driver Manager to provide connectivity to TaxJar data from DBVisualizer tools.

1. In DBVisualizer, click Tools -> Driver Manager.
2. Click the plus sign "" to create a new driver.
3. Select "Custom" as the template.
4. On the Driver Settings tab:
   • Set Name to a user-friendly name (e.g. "CData TaxJar Driver")
   • Set URL Format to jdbc:taxjar:
   • In Driver artifacts and jar files (jars are loaded in order from top):
     1. Click the plus sign "" -> "Add Files"
     2. Navigate to the "lib" folder in the installation directory (C:\Program Files\CData[product_name] XXXX\)
     3. Select the JAR file (cdata.jdbc.TaxJar.jar) and click "Open"
5. The Driver Class should populate automatically. If not, select class (cdata.jdbc.taxjar.TaxJarDriver).

Define the Connection to the JDBC Data Source

Close the "Driver Manager" and follow the steps below to save connection properties in the JDBC URL.

1. In the "Databases" tab, click the plus sign "" and select the driver you just created.

2. In the "Connection" section, set the following options:

   • Database Type: If you selected the wizard option, the database type is automatically detected. If you selected the "No Wizard" option, select the Generic or Auto Detect option in the Database Type menu.
   • Driver Type: Select the driver you just created.

   • Database URL: Enter the full JDBC URL. The syntax of the JDBC URL is jdbc:taxjar: followed by the connection properties in a semicolon-separated list of name-value pairs.

     To authenticate to the TaxJar API, you will need to 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.

     When you configure the JDBC URL, you may also want to set the Max Rows connection property. This will limit the number of rows returned, which is especially helpful for improving performance when designing reports and visualizations.

     A typical connection string is below:

     jdbc:taxjar:APIKey=3bb04218ef8t80efdf1739abf7257144;
   • NOTE: Since TaxJar does not require a User or Password to authenticate, you may use whatever values you wish for Database Userid and Database Password.
3. On the Connection tab, click Connect.

To browse through tables exposed by the TaxJar JDBC Driver, right-click a table and click "Open in New Tab."

To execute SQL queries, use the SQL Commander tool: Click SQL Commander -> New SQL Commander. Select the Database Connection, Database, and Schema from the available menus.

See the "Supported SQL" chapter in the help documentation for more information on the supported SQL. See the "Data Model" chapter for table-specific information.

More Information & Free Trial