Manage Databox Data in DBArtisan as a JDBC Source

The CData JDBC Driver for Databox seamlessly integrates Databox data into database management tools like DBArtisan by enabling you to access Databox data as a database. This article shows how to create a JDBC source for Databox in DBArtisan. You can then edit data visually and execute standard SQL.

Integrate Databox Data into DBArtisan Projects

Follow the steps below to register Databox data as a database instance in your project:

1. In DBArtisan, click Data Source -> Register Datasource.
2. Select Generic JDBC.
3. Click Manage.
4. In the resulting dialog, click New. Enter a name for the driver and click Add. In the resulting dialog, navigate to the driver JAR. The driver JAR is located in the lib subfolder of the installation directory.
5. In the Connection URL box, enter credentials and other required connection properties in the JDBC URL.

   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';

6. Finish the wizard to connect to Databox data. Databox entities are displayed in the Datasource Explorer.

You can now work with Databox data as you work with any other database. See the driver help documentation for more information on the queries supported by the Databox API.