Query Suadeo 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 Suadeo, DataGrip can work with live Suadeo data. This article shows how to establish a connection to Suadeo data in DataGrip.

Create a New Driver Definition for Suadeo

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

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 Suadeo 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.suadeo.jar).
   • Set Class to cdata.jdbc.suadeo.Suadeo.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 Suadeo

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

   Built-in Connection String Designer

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

         java -jar cdata.jdbc.suadeo.jar
       

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

   The driver uses the OAuth 2.0 Resource Owner Password Credentials (ROPC) grant to authenticate to Suadeo. Authentication occurs directly using your credentials; there is no browser-based authorization flow or refresh token.

   Set the following connection properties:

   • URL: The base URL of your Suadeo instance.
   • User: Your Suadeo username.
   • Password: Your Suadeo password.
   • AuthenticationName: The name identifier for the authentication configuration in your Suadeo instance. Different authentication names can be configured for different environments or use cases.

   When you connect, the driver sends your credentials to the Suadeo OAuth token endpoint, receives an access token, and uses it for all subsequent requests. A new access token is obtained automatically when needed during the session.

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

   jdbc:suadeo:URL=https://mysuadeoinstance;User=username;Password=password;AuthenticationName=your_auth_name;

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 Suadeo

To browse through the Suadeo 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, Name FROM Customers WHERE Status = 'Active'

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