Connect to GraphQL Data in RapidMiner

This article shows how you can easily integrate the CData JDBC driver for GraphQL into your processes in RapidMiner. This article uses the CData JDBC Driver for GraphQL to transfer GraphQL data to a process in RapidMiner.

Connect to GraphQL in RapidMiner as a JDBC Data Source

You can follow the procedure below to establish a JDBC connection to GraphQL:

1. Add a new database driver for GraphQL: Click Connections -> Manage Database Drivers.
2. In the resulting wizard, click the Add button and enter a name for the connection.
3. Enter the prefix for the JDBC URL: jdbc:graphql:
4. Enter the path to the cdata.jdbc.graphql.jar file, located in the lib subfolder of the installation directory.
5. Enter the driver class: cdata.jdbc.graphql.GraphQLDriver
6. Create a new GraphQL connection: Click Connections -> Manage Database Connections.
7. Enter a name for your connection.
8. For Database System, select the GraphQL driver you configured previously.
9. Enter your connection string in the Host box.

   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.

   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.

   A typical connection string is below:

   AuthScheme=Basic;User=username;Password=password;URL=https://mysite.com;InitiateOAuth=GETANDREFRESH
10. Enter your username and password if necessary.

You can now use your GraphQL connection with the various RapidMiner operators in your process. To retrieve GraphQL data, drag the Retrieve operator from the Operators view. With the Retrieve operator selected, you can then define which table to retrieve in the Parameters view by clicking the folder icon next to the "repository entry." In the resulting Repository Browser, you can expand your connection node to select the desired example set.

Finally, wire the output to the Retrieve process to a result, and run the process to see the GraphQL data.