Connect to CleverPush Data in Aqua Data Studio

The CData JDBC Driver for CleverPush integrates CleverPush data with wizards and analytics in IDEs like Aqua Data Studio. This article shows how to connect to CleverPush data through the connection manager and execute queries.

Create a JDBC Data Source

You can use the connection manager to define connection properties and save them in a new JDBC data source. The CleverPush data source can then be accessed from Aqua Data Studio tools.

1. In Aqua Data Studio, select Register Server from the Servers menu.
2. In the Register Server form, select the 'Generic - JDBC' connection.
3. Enter the following JDBC connection properties:
   • Name: Enter a name for the data source; for example, CleverPush.
   • Driver Location: Click the Browse button and select the cdata.jdbc.api.jar file, located in the lib subfolder of the installation directory.
   • Driver: Enter the Driver's class name, cdata.jdbc.api.APIDriver.

   • URL: Enter the JDBC URL, which starts with jdbc:api: and is followed by a semicolon-separated list of connection properties.

     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.

     A typical JDBC URL is below:

     jdbc:api:Profile=C:\profiles\Cleverpush.apip;ProfileSettings='APIKey=my_api_key';

   

Query CleverPush Data

You can now query the tables exposed.