Manage CleverPush Data in DBArtisan as a JDBC Source

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

Integrate CleverPush Data into DBArtisan Projects

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

   Cleverpush API Profile Settings

   CleverPush uses private API keys to authenticate requests. Your API key is passed as the Authorization request header value on every API call.

   You can find your private API key in the CleverPush dashboard under Settings > API. Use the private key (not the public key) for server-side access.

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

   • AuthScheme: Set this to APIKey.
   • APIKey: Set this to your CleverPush private API key.

   Optional Connection Properties

   • ChannelId: Set this to your default CleverPush channel identifier. Most tables require a channel filter. Setting this property allows queries without specifying ChannelId in every WHERE clause.

   Built-in Connection String Designer

   For assistance in constructing the JDBC URL, use the connection string designer built into the CleverPush 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\Cleverpush.apip;ProfileSettings='APIKey=my_api_key';

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

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