How to Connect DBeaver to Databox via a JDBC Driver

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

Create a JDBC Data Source for Databox 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 API Driver for JDBC).
   • Set Class Name to the class name for the JDBC driver: cdata.jdbc.api.APIDriver.
   • Set URL Template to jdbc:api:.
   
3. In the Libraries tab, click "Add File," navigate to the "lib" folder in the installation directory (C:\Program Files\CData\CData API Driver for JDBC XXXX\) and select the JAR file (cdata.jdbc.API.jar).

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

   Start by setting the Profile connection property to the location of the Databox Profile on disk (e.g. C:\profiles\Databox.apip). Next, set the ProfileSettings connection property to the connection string for Databox (see below).

   Databox API Profile Settings

   To use the Databox API, you need to generate a personal access key from your Databox account. Navigate to the Databox account settings under Data Manager and generate an API key (prefixed with pak_).

   After setting the following connection properties, you are ready to connect:

   • AuthScheme: Set this to APIKey.
   • APIKey: Set this to your Databox personal access key.

   Built-in Connection String Designer

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

   
   java -jar cdata.jdbc.api.jar
   

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

   

   Below is a typical connection string:

   
   jdbc:api:Profile=C:\profiles\Databox.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_api_key';
   

   
4. Click "Test Connection ..." to ensure you have configured the connection properly.
5. Click "Finish."

Query Databox 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

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