Connect to CleverPush Data in DBArtisan
The CData ODBC 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 an data source for CleverPush in DBArtisan and execute queries. You can then edit data visually and execute standard SQL.
Integrate CleverPush Data into DBArtisan Projects
If you have not already, first specify connection properties in an ODBC DSN (data source name). This is the last step of the driver installation. You can use the Microsoft ODBC Data Source Administrator to create and configure ODBC DSNs.
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.
You can then follow the steps below to register CleverPush data as a database instance in your project:
- In DBArtisan, click Data Source -> Register Datasource.
- Select Generic ODBC.
- Enter a name for the data source and select the DSN.
- 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.
