How to Connect DBeaver to Avalara AvaTax via a JDBC Driver

The CData JDBC Driver for Avalara 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 Avalara AvaTax data with wizards in DBeaver and browse data in the DBeaver GUI.

Create a JDBC Data Source for Avalara AvaTax 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 Avalara).
   • Set Class Name to the class name for the JDBC driver: cdata.jdbc.avalaraavatax.AvalaraAvataxDriver.
   • Set URL Template to jdbc:avalaraavatax:.
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.AvalaraAvatax.jar).

Create a Connection to Avalara AvaTax 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 Avalara) and click "Next >."
3. On the Main tab of the configuration wizard, set the JDBC URL, using the required connection properties:

   The primary method for performing basic authentication is to provide your login credentials, as follows:

   • User: Set this to your username.
   • Password: Set this to your password.

   Optionally, if you are making use of a sandbox environment, set the following:

   • UseSandbox: Set this to true if you are authenticating with a sandbox account.

   Authenticating Using Account Number and License Key

   Alternatively, you can authenticate using your account number and license key. Connect to data using the following:

   • AccountId: Set this to your Account Id. The Account Id is listed in the upper right hand corner of the admin console.
   • LicenseKey: Set this to your Avalara Avatax license key. You can generate a license key by logging into Avalara Avatax as an account administrator and navigating to Settings -> Reset License Key.

   Built-in Connection String Designer

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

   java -jar cdata.jdbc.avalaraavatax.jar

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

   Below is a typical connection string:

   jdbc:avalaraavatax:User=MyUser;Password=MyPassword;
4. Click "Test Connection ..." to ensure you have configured the connection properly.
5. Click "Finish."

Query Avalara AvaTax 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.

More Information & Free Trial