Manage Instantly Data in DBArtisan as a JDBC Source

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

Integrate Instantly Data into DBArtisan Projects

Follow the steps below to register Instantly 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.

   Using API Key Authentication

   Instantly uses API keys to authenticate requests. You can find or create your API key in the Instantly workspace settings under API & Webhooks.

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

   • AuthScheme: Set this to APIKey.
   • APIKey: Set this to your Instantly API key (Bearer token for API v2).

   Example connection string

   Profile=C:\profiles\Instantly.apip;AuthScheme=APIKey;ProfileSettings="APIKey=your_api_key";
   

   Built-in Connection String Designer

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

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

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