Manage Canny Data in DBArtisan as a JDBC Source

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

Integrate Canny Data into DBArtisan Projects

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

   Canny API Profile Settings

   Canny uses a secret API key to control access to the API. The API key is sent as a JSON body parameter named 'apiKey' in every HTTP POST request to the Canny API endpoints.

   To authenticate with the Canny API, you need your company-level secret API key. You can find this key in your Canny account under Settings > API.

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

   • AuthScheme: Set this to APIKey.
   • APIKey: Set this to your Canny company-level secret API key from the Settings > API page in your Canny dashboard.

   Built-in Connection String Designer

   For assistance in constructing the JDBC URL, use the connection string designer built into the Canny 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\Canny.apip;ProfileSettings='APIKey=your-canny-api-key';

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

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