Query Outlook 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 Outlook data. This article shows how to establish a connection to Outlook data in DataGrip.

Create a New Driver Definition for Outlook

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

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 Outlook 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 Outlook

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

   Built-in Connection String Designer

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

   Using OAuth Authentication

   Microsoft Graph API uses OAuth 2.0 for authentication. You must register an application in the Microsoft Azure Portal to obtain OAuth credentials (Client ID and Client Secret).

   Obtaining OAuth Credentials

   1. Log in to the Azure Portal.
   2. Navigate to Azure Active Directory > App registrations.
   3. Click New registration to create a new application.
   4. Enter an application name and select the appropriate account types.
   5. Set the Redirect URI to your application's callback URL (e.g., http://localhost:33333 for desktop apps).
   6. Click Register to create the application.
   7. On the application overview page, copy the Application (client) ID - this is your OAuthClientId.
   8. Navigate to Certificates & secrets and create a new client secret.
   9. Copy the client secret value - this is your OAuthClientSecret.
   10. Navigate to API permissions and add the required Microsoft Graph API permissions:
       • Mail.Read - For accessing email messages
       • Contacts.Read - For accessing contacts
       • Calendars.Read - For accessing calendar events
       • Tasks.Read - For accessing To Do tasks
       • offline_access - For obtaining refresh tokens
   11. Click Grant admin consent to grant these permissions.

   Connecting with OAuth

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

   • AuthScheme: Set this to OAuth.
   • InitiateOAuth: Set this to GETANDREFRESH. The CData API Profile for Outlook will automatically walk through the OAuth process in order to obtain the access token.
   • OAuthClientId: Set this to the Application (client) ID from Azure Portal.
   • OAuthClientSecret: Set this to the client secret value from Azure Portal.
   • TenantId: Set this to your Azure AD tenant identifier (GUID or domain name like 'contoso.onmicrosoft.com').
   • CallbackURL: Set this to the Redirect URI you specified in your app registration (e.g., http://localhost:33333 for desktop apps).

   Example connection string

   Profile=C:\profiles\Outlook.apip;AuthScheme=OAuth;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;TenantId=your_tenant_id;CallbackUrl=http://localhost:33333;
   

   
3. Set URL to the connection string, e.g.,

   jdbc:api:Profile=C:\profiles\Outlook.apip;AuthScheme=OAuth;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;TenantId=your_tenant_id;CallbackUrl=http://localhost:33333;

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 Outlook

To browse through the Outlook 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 ,  FROM CalendarGroupCalendars WHERE CalendarGroupId = 'group_id'

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