Connect to TaxJar Data in DBeaver

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 Databases menu, select the Driver Manager option. Click New to open the Create New Driver form.
2. In the Driver Name box, enter a user-friendly name for the driver.
3. To add the .jar, click Add File.
4. In the create new driver dialog that appears, select the cdata.jdbc.taxjar.jar file, located in the lib subfolder of the installation directory.
5. Click the Find Class button and select the TaxJarDriver class from the results. This will automatically fill the Class Name field at the top of the form. The class name for the driver is cdata.jdbc.taxjar.TaxJarDriver.
6. Add jdbc:taxjar: in the URL Template field.

Create a Connection to TaxJar Data

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

1. In the Databases menu, click New Connection.
2. In the Create new connection wizard that results, select the driver.
3. On the next page of the wizard, click the driver properties tab.

4. Enter values for authentication credentials and other properties required to connect to TaxJar.

   TaxJar API への認証には、まず初めにTaxJar UI からAPI キーを取得する必要があります。

   NOTE：API の利用は、Professional およびPremium TaxJar プランでのみ可能です。

   すでにProfessional またはPremium プランをお持ちの方は、TaxJar UI にログインして、「アカウント」->「TaxJar API」に移動するとAPI キーを確認することができます。 API キーを取得したら、APIKey 接続プロパティに設定できます。

   その他の注意事項

   • デフォルトでは、エンティティが日付範囲フィルタをサポートしている場合、CData コネクタは過去3か月のデータを取得します。StartDate を設定して、取得するデータの最小作成日を指定することができます。
   • API キーがサンドボックスAPI アカウント用に作成されている場合は、UseSandbox をtrue に設定してください。ただし、すべてのエンドポイントが期待どおりに機能するとは限りません。詳しくは、TaxJar 開発者用ドキュメントを参照してください。

   Below is a typical connection string:

   jdbc:taxjar:APIKey=3bb04218ef8t80efdf1739abf7257144;

Query TaxJar Data

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