Connect to CleverPush Data in RazorSQL

The CData JDBC Driver for CleverPush enables standards-based access from third-party tools, from wizards in IDEs to data management and analysis tools. This article shows how to connect to CleverPush using wizards in RazorSQL.

Create a JDBC Data Source for CleverPush Data

1. Open the RazorSQL application and, in the Connections menu, select Add Connection Profile -> Other -> JDBC.
2. In the Connection Wizard that appears, set the following properties:
   • Driver Location: Set this property to the path to the lib subfolder in the installation directory.
   • Driver Class: Set the driver class to cdata.jdbc.api.APIDriver.
   • Username: Enter the username. (This property can also be set in the JDBC URL.)
   • Password: Enter the password. (This property can also be set in the JDBC URL.)

   • JDBC URL: Enter connection parameters. The JDBC URL begins 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 the following:

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

Query CleverPush Data and Select Tables

After establishing a connection, the wizard will close and the connection will be available in the connections panel. You can then query the tables.