Query HCL Domino Data in DataGrip

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

Create a New Driver Definition for HCL Domino

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

1. In DataGrip, click File -> New > Project and name the project 👁 Creating a new DataGrip project.
   
2. In the Database Explorer, click the plus icon () and select Driver. 👁 Adding a new Driver.
   
3. In the Driver tab:
   • Set Name to a user-friendly name (e.g. "CData HCL Domino 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.domino.jar).
   • Set Class to cdata.jdbc.domino.Domino.jar
4. Click "Apply" then "OK" to save the Connection 👁 A configured Driver (Salesforce is shown).
   

Configure a Connection to HCL Domino

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

   Built-in Connection String Designer

   For assistance in constructing the JDBC URL, use the connection string designer built into the HCL Domino JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

    java -jar cdata.jdbc.domino.jar
    

   Fill in the connection properties and copy the connection string to the clipboard.

   Connecting to Domino

   To connect to Domino data, set the following properties:

   • URL: The host name or IP of the server hosting the Domino database. Include the port of the server hosting the Domino database. For example: http://sampleserver:1234/
   • DatabaseScope: The name of a scope in the Domino Web UI. The driver exposes forms and views for the schema governed by the specified scope. In the Domino Admin UI, select the Scopes menu in the sidebar. Set this property to the name of an existing scope.

   Authenticating with Domino

   Domino supports authenticating via login credentials or an Entra ID (formerly Azure AD) OAuth application:

   Login Credentials

   To authenticate with login credentials, set the following properties:

   • AuthScheme: Set this to "OAuthPassword"
   • User: The username of the authenticating Domino user
   • Password: The password associated with the authenticating Domino user

   The driver uses the login credentials to automatically perform an OAuth token exchange.

   EntraID (formerly AzureAD)

   This authentication method uses Entra ID (formerly Azure AD) as an IdP to obtain a JWT token. You need to create a custom OAuth application in Entra ID (formerly Azure AD) and configure it as an IdP. To do so, follow the instructions in the Help documentation. Then set the following properties:

   • AuthScheme: Set this to "EntraID (formerly AzureAD)"
   • InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
   • OAuthClientId: The Client ID obtained when setting up the custom OAuth application.
   • OAuthClientSecret: The Client secret obtained when setting up the custom OAuth application.
   • CallbackURL: The redirect URI defined when you registered your app. For example: https://localhost:33333
   • AzureTenant: The Microsoft Online tenant being used to access data. Supply either a value in the form companyname.microsoft.com or the tenant ID.

     The tenant ID is the same as the directory ID shown in the Azure Portal's Entra ID (formerly Azure AD) > Properties page.

   👁 Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)
   
3. Set URL to the connection string, e.g.,

   jdbc:domino:Server=https://domino.corp.com;AuthScheme=OAuthPassword;User=my_domino_user;Password=my_domino_password;

4. Click "Apply" and "OK" to save the connection string 👁 A configured Data Source (Salesforce is shown).
   

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

Execute SQL Queries Against HCL Domino

To browse through the HCL Domino 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 Name, Address FROM ByName WHERE City = 'Miami'

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