Ready to get started?

Learn more about the CData JDBC Driver for Cosmos DB or download a free trial:

Download Now

Integrate Cosmos DB Data in the Pentaho Report Designer

Publish reports based on Cosmos DB data in the Pentaho BI tool.

The CData JDBC Driver for Cosmos DB data enables access to live data from dashboards and reports. This article shows how to connect to Cosmos DB data as a JDBC data source and publish reports based on Cosmos DB 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 Cosmos DB connection. In the resulting dialog, configure the connection properties as shown below.

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

      To obtain the connection string needed to connect to a Cosmos DB account using the SQL API, log in to the Azure Portal, select Azure Cosmos DB, and select your account. In the Settings section, click Connection String and set the following values:

      • AccountEndpoint: The Cosmos DB account URL from the Keys blade of the Cosmos DB account
      • AccountKey: In the Azure portal, navigate to the Cosmos DB service and select your Azure Cosmos DB account. From the resource menu, go to the Keys page. Find the PRIMARY KEY value and set AccountKey to this value.

      Built-in Connection String Designer

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

      java -jar cdata.jdbc.cosmosdb.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:cosmosdb:AccountEndpoint=myAccountEndpoint;AccountKey=myAccountKey;
    • Custom Driver Class Name: Enter cdata.jdbc.cosmosdb.CosmosDBDriver.
    • User Name: The username to authenticate with.
    • Password: The password to authenticate with.

Add Cosmos DB Data to a Report

You are now ready to create a report with Cosmos DB data.

  1. Add the Cosmos DB 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 City, CompanyName FROM Customers
  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 Customers table.
  4. Finally, run the report to see the chart.