Integrate GraphQL Data in the Pentaho Report Designer

Ready to get started?

Download for a free trial:

Download Now

Learn more:

GraphQL JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with GraphQL.



Publish reports based on GraphQL data in the Pentaho BI tool.

The CData JDBC Driver for GraphQL data enables access to live data from dashboards and reports. This article shows how to connect to GraphQL data as a JDBC data source and publish reports based on GraphQL data in Pentaho.

Connect and Create a Report

  1. Copy the JAR file of the driver, located in the lib subfolder of the installation directory, to the \Report-Designer\lib\jdbc\ folder in the Pentaho directory.
  2. Run the report-designer.bat file in the \Report-Designer\ folder to open the Report-Designer UI.
  3. Create a new data source with the driver by clicking Data -> Add Data Source -> Advanced -> JDBC (Custom) and then creating a new GraphQL connection. In the resulting dialog, configure the connection properties as shown below.

    • Custom Connection URL property: Enter the JDBC URL. This starts with jdbc:graphql: and is followed by a semicolon-separated list of connection properties.

      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.

      When you configure the JDBC URL, you may also want to set the Max Rows connection property. This will limit the number of rows returned, which is especially helpful for improving performance when designing reports and visualizations.

      Below is a typical JDBC URL:

      jdbc:graphql:AuthScheme=Basic;User=username;Password=password;URL=https://mysite.com;InitiateOAuth=GETANDREFRESH
    • Custom Driver Class Name: Enter cdata.jdbc.graphql.GraphQLDriver.
    • User Name: The username to authenticate with.
    • Password: The password to authenticate with.

Add GraphQL Data to a Report

You are now ready to create a report with GraphQL data.

  1. Add the GraphQL source to your report: Click Data -> Add Data Source -> JDBC and select the data source.

  2. Configure the query. This article uses the one below:

    SELECT Name, Email FROM Users WHERE UserLogin = 'admin'
  3. Drag a chart onto your report and double-click it to edit the chart. Run the report to display the chart. You can use the results of this query to create a simple chart for the Users table.
  4. Finally, run the report to see the chart.