Query ConstantContact Data in DataGrip

DataGrip is a database IDE that allows SQL developers to query, create, and manage databases. When paired with the CData API Driver for JDBC, DataGrip can work with live ConstantContact data. This article shows how to establish a connection to ConstantContact data in DataGrip.

Create a New Driver Definition for ConstantContact

The steps below describe how to create a new Data Source in DataGrip for ConstantContact.

1. In DataGrip, click File -> New > Project and name the project
2. In the Database Explorer, click the plus icon () and select Driver.
3. In the Driver tab:
   • Set Name to a user-friendly name (e.g. "CData ConstantContact Driver")
   • Set Driver Files to the appropriate JAR file. To add the file, click the plus (), select "Add Files," navigate to the "lib" folder in the driver's installation directory and select the JAR file (e.g. cdata.jdbc.api.jar).
   • Set Class to cdata.jdbc.api.API.jar
   Additionally, in the advanced tab you can change driver properties and some other settings like VM Options, VM environment, VM home path, DBMS, etc
   • For most cases, change the DBMS type to "Unknown" in Expert options to avoid native SQL Server queries (Transact-SQL), which might result in an invalid function error
4. Click "Apply" then "OK" to save the Connection

Configure a Connection to ConstantContact

1. Once the connection is saved, click the plus (), then "Data Source" then "CData ConstantContact Driver" to create a new ConstantContact Data Source.
2. In the new window, configure the connection to ConstantContact with a JDBC URL.

   Built-in Connection String Designer

   For assistance in constructing the JDBC URL, use the connection string designer built into the ConstantContact 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.

   Start by setting the Profile connection property to the location of the ConstantContact Profile on disk (e.g. C:\profiles\ConstantContact.apip). Next, set the ProfileSettings connection property to the connection string for Profile (see below).

   ConstantContact API Profile Settings

   ConstantContact uses OAuth-based authentication.

   First, you will need to register an OAuth application with ConstantContact. You can do so from the ConstantContact API Guide (https://v3.developer.constantcontact.com/api_guide/index.html), under "MyApplications" > "New Application". Your Oauth application will be assigned a client id (API Key) and you can generate a client secret (Secret).

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

   • AuthScheme: Set this to OAuth.
   • InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to manage the process to obtain the OAuthAccessToken.
   • OAuthClientId: Set this to the client_id that is specified in you app settings.
   • OAuthClientSecret: Set this to the client_secret that is specified in you app settings.
   • CallbackURL: Set this to the Redirect URI you specified in your app settings.
3. Set URL to the connection string, e.g., jdbc:api:Profile=C:\profiles\ConstantContact.apip;Authscheme=OAuth;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;
4. Click "Apply" and "OK" to save the connection string

At this point, you will see the data source in the Data Explorer.

Execute SQL Queries Against ConstantContact

To browse through the ConstantContact entities (available as tables) accessible through the JDBC Driver, expand the Data Source.

To execute queries, right click on any table and select "New" -> "Query Console."

In the Console, write the SQL query you wish to execute. For example: SELECT Id, EmailAddress FROM Contacts WHERE CompanyName = 'Acme, Inc.'

Download a free, 30-day trial of the CData API Driver for JDBC and start working with your live ConstantContact data in DataGrip. Reach out to our Support Team if you have any questions.