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

Create a New Driver Definition for GraphQL

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

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

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

   Built-in Connection String Designer

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

   java -jar cdata.jdbc.graphql.jar

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

   You must specify the URL of the GraphQL service. The driver supports two types of authentication:

   • Basic: Set AuthScheme to Basic. You must specify the User and Password of the GraphQL service.
   • OAuth 1.0 & 2.0: Take a look at the OAuth section in the Help documentation for detailed instructions.
3. Set URL to the connection string, e.g., jdbc:graphql:AuthScheme=Basic;User=username;Password=password;URL=https://mysite.com;InitiateOAuth=GETANDREFRESH
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 GraphQL

To browse through the GraphQL 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, Email FROM Users WHERE UserLogin = 'admin'

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