Manage Chargebee Data in DBArtisan as a JDBC Source

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

Integrate Chargebee Data into DBArtisan Projects

Follow the steps below to register Chargebee 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. 👁 The JDBC driver definition in the Register Datasource wizard. (Salesforce is shown.)
   
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 Chargebee Profile on disk (e.g. C:\profiles\Chargebee.apip). Next, set the ProfileSettings connection property to the connection string for Chargebee (see below).

   Chargebee API Profile Settings

   Generate an API Key from your Chargebee account via Settings > Configure Chargebee > API Keys and Webhooks. Your site name is the subdomain from your Chargebee account URL.

   Built-in Connection String Designer

   For assistance in constructing the JDBC URL, use the connection string designer built into the Chargebee 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.

   👁 Required JDBC connection properties in the Register Datasource wizard. (Salesforce is shown.)
   

   Below is a typical connection string:

   jdbc:api:Profile=C:\profiles\Chargebee.apip;ProfileSettings='APIKey=your_api_key;Site=your_site_name';

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

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