Manage Carbone Data in DBArtisan as a JDBC Source

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

Integrate Carbone Data into DBArtisan Projects

Follow the steps below to register Carbone 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 Carbone Profile on disk (e.g. C:\profiles\Carbone.apip). Next, set the ProfileSettings connection property to the connection string for Carbone (see below).

   Carbone API Profile Settings

   Carbone uses API key authentication via a Bearer token in the Authorization header. To obtain an API key:

   1. Log in to your Carbone account at https://account.carbone.io
   2. Copy the API key shown on the account home page

   After obtaining your API key, set the following connection properties:

   • AuthScheme: Set this to APIKey.
   • APIKey: Set this to your Carbone API key (Bearer token).
   • CarboneVersion: (Optional) The major version of the Carbone API to target via the carbone-version request header. Defaults to 5. Accepted values: 5, 4, 3, staging.

   Built-in Connection String Designer

   For assistance in constructing the JDBC URL, use the connection string designer built into the Carbone 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\Carbone.apip;AuthScheme=APIKey;APIKey=your_api_key;

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

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